diff --git a/.mock/definition/accounting/__package__.yml b/.mock/definition/accounting/__package__.yml index 3a198d77..c4e8cb24 100644 --- a/.mock/definition/accounting/__package__.yml +++ b/.mock/definition/accounting/__package__.yml @@ -51609,6 +51609,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/accounting/accountDetails.yml b/.mock/definition/accounting/accountDetails.yml index a9e9606f..300d24e0 100644 --- a/.mock/definition/accounting/accountDetails.yml +++ b/.mock/definition/accounting/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/accounting/accountToken.yml b/.mock/definition/accounting/accountToken.yml index e5fa0475..0f3134f8 100644 --- a/.mock/definition/accounting/accountToken.yml +++ b/.mock/definition/accounting/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/accounting/accountingPeriods.yml b/.mock/definition/accounting/accountingPeriods.yml index d6fc7c6b..4adc5e1b 100644 --- a/.mock/definition/accounting/accountingPeriods.yml +++ b/.mock/definition/accounting/accountingPeriods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedAccountingPeriodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3015f7b1-4d01-460d-bfab-02a52d16cbd0 diff --git a/.mock/definition/accounting/accounts.yml b/.mock/definition/accounting/accounts.yml index c6746098..7f5c1aac 100644 --- a/.mock/definition/accounting/accounts.yml +++ b/.mock/definition/accounting/accounts.yml @@ -127,7 +127,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: type: root.AccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -280,7 +284,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -320,7 +325,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/addresses.yml b/.mock/definition/accounting/addresses.yml index 989f0df1..c8ae7626 100644 --- a/.mock/definition/accounting/addresses.yml +++ b/.mock/definition/accounting/addresses.yml @@ -43,7 +43,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/asyncPassthrough.yml b/.mock/definition/accounting/asyncPassthrough.yml index da15bafd..2a665ed2 100644 --- a/.mock/definition/accounting/asyncPassthrough.yml +++ b/.mock/definition/accounting/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/accounting/asyncTasks.yml b/.mock/definition/accounting/asyncTasks.yml index 6365c3ab..ae58d998 100644 --- a/.mock/definition/accounting/asyncTasks.yml +++ b/.mock/definition/accounting/asyncTasks.yml @@ -20,7 +20,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: status: QUEUED diff --git a/.mock/definition/accounting/attachments.yml b/.mock/definition/accounting/attachments.yml index cae3762b..2487a3cf 100644 --- a/.mock/definition/accounting/attachments.yml +++ b/.mock/definition/accounting/attachments.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedAccountingAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -120,7 +123,8 @@ service: type: root.AccountingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -193,7 +197,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -226,7 +231,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/auditTrail.yml b/.mock/definition/accounting/auditTrail.yml index 6e1b8672..0dcfb086 100644 --- a/.mock/definition/accounting/auditTrail.yml +++ b/.mock/definition/accounting/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/availableActions.yml b/.mock/definition/accounting/availableActions.yml index 35fca3fa..e7a930de 100644 --- a/.mock/definition/accounting/availableActions.yml +++ b/.mock/definition/accounting/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/accounting/balanceSheets.yml b/.mock/definition/accounting/balanceSheets.yml index dde810e4..28152b37 100644 --- a/.mock/definition/accounting/balanceSheets.yml +++ b/.mock/definition/accounting/balanceSheets.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedBalanceSheetList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/accounting/bankFeedAccounts.yml b/.mock/definition/accounting/bankFeedAccounts.yml index 2e64d197..a5d6ed06 100644 --- a/.mock/definition/accounting/bankFeedAccounts.yml +++ b/.mock/definition/accounting/bankFeedAccounts.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedBankFeedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -96,7 +99,8 @@ service: type: root.BankFeedAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -173,7 +177,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -210,7 +215,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/bankFeedTransactions.yml b/.mock/definition/accounting/bankFeedTransactions.yml index 682615d0..7a1d41c9 100644 --- a/.mock/definition/accounting/bankFeedTransactions.yml +++ b/.mock/definition/accounting/bankFeedTransactions.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBankFeedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -122,7 +125,8 @@ service: type: root.BankFeedTransactionResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -197,7 +201,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -227,7 +232,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/cashFlowStatements.yml b/.mock/definition/accounting/cashFlowStatements.yml index 179afb9c..2db3914f 100644 --- a/.mock/definition/accounting/cashFlowStatements.yml +++ b/.mock/definition/accounting/cashFlowStatements.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedCashFlowStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -170,7 +173,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b diff --git a/.mock/definition/accounting/companyInfo.yml b/.mock/definition/accounting/companyInfo.yml index 488a4308..33953306 100644 --- a/.mock/definition/accounting/companyInfo.yml +++ b/.mock/definition/accounting/companyInfo.yml @@ -86,7 +86,10 @@ service: type: root.PaginatedCompanyInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -159,7 +162,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 diff --git a/.mock/definition/accounting/contacts.yml b/.mock/definition/accounting/contacts.yml index ba75cfb4..c809b0ff 100644 --- a/.mock/definition/accounting/contacts.yml +++ b/.mock/definition/accounting/contacts.yml @@ -137,7 +137,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.ContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -311,7 +315,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -361,7 +366,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -582,7 +588,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -593,6 +602,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/creditNotes.yml b/.mock/definition/accounting/creditNotes.yml index edd13752..880ab247 100644 --- a/.mock/definition/accounting/creditNotes.yml +++ b/.mock/definition/accounting/creditNotes.yml @@ -659,7 +659,10 @@ service: type: root.PaginatedCreditNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -755,7 +758,8 @@ service: type: root.CreditNoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -888,7 +892,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 @@ -917,7 +922,6 @@ service: unit_price: '5.0' tax_rate: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 total_line_amount: '5.0' - tracking_category: tracking_category tracking_categories: - 8d9fd929-436c-4fd4-a48b-0c61f68d6178 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -969,7 +973,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/deleteAccount.yml b/.mock/definition/accounting/deleteAccount.yml index 402b4e72..dd6432e8 100644 --- a/.mock/definition/accounting/deleteAccount.yml +++ b/.mock/definition/accounting/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/employees.yml b/.mock/definition/accounting/employees.yml index bc9f9fdb..d77b43e3 100644 --- a/.mock/definition/accounting/employees.yml +++ b/.mock/definition/accounting/employees.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -133,7 +136,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 diff --git a/.mock/definition/accounting/expenseReports.yml b/.mock/definition/accounting/expenseReports.yml index d8794980..66977e4f 100644 --- a/.mock/definition/accounting/expenseReports.yml +++ b/.mock/definition/accounting/expenseReports.yml @@ -262,7 +262,10 @@ service: type: root.PaginatedExpenseReportList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -349,7 +352,8 @@ service: type: root.ExpenseReportResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: tracking_categories: @@ -487,7 +491,10 @@ service: examples: - path-parameters: expense_report_id: expense_report_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -559,7 +566,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 123e4567-e89b-12d3-a456-426614174000 @@ -669,7 +677,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -680,6 +691,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -697,7 +709,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -918,7 +931,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -929,6 +945,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/expenses.yml b/.mock/definition/accounting/expenses.yml index 98c48edf..4a409f71 100644 --- a/.mock/definition/accounting/expenses.yml +++ b/.mock/definition/accounting/expenses.yml @@ -334,7 +334,10 @@ service: type: root.PaginatedExpenseList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -433,7 +436,8 @@ service: type: root.ExpenseResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -564,7 +568,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -591,7 +596,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -612,7 +616,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -695,7 +698,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -706,6 +712,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -723,7 +730,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -944,7 +952,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -955,6 +966,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/fieldMapping.yml b/.mock/definition/accounting/fieldMapping.yml index 66389088..70f7267f 100644 --- a/.mock/definition/accounting/fieldMapping.yml +++ b/.mock/definition/accounting/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -517,7 +518,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -584,7 +586,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -666,7 +669,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -737,7 +741,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -1107,7 +1112,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/accounting/forceResync.yml b/.mock/definition/accounting/forceResync.yml index 8e7e969a..23d80d64 100644 --- a/.mock/definition/accounting/forceResync.yml +++ b/.mock/definition/accounting/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Invoice diff --git a/.mock/definition/accounting/generalLedgerTransactions.yml b/.mock/definition/accounting/generalLedgerTransactions.yml index 38fe7292..5e43d543 100644 --- a/.mock/definition/accounting/generalLedgerTransactions.yml +++ b/.mock/definition/accounting/generalLedgerTransactions.yml @@ -143,7 +143,10 @@ service: type: root.PaginatedGeneralLedgerTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -228,7 +231,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 diff --git a/.mock/definition/accounting/generateKey.yml b/.mock/definition/accounting/generateKey.yml index 4d79b8ce..7ec4bf68 100644 --- a/.mock/definition/accounting/generateKey.yml +++ b/.mock/definition/accounting/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/incomeStatements.yml b/.mock/definition/accounting/incomeStatements.yml index 92f62e77..f1da1a7b 100644 --- a/.mock/definition/accounting/incomeStatements.yml +++ b/.mock/definition/accounting/incomeStatements.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedIncomeStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -183,7 +186,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae diff --git a/.mock/definition/accounting/invoices.yml b/.mock/definition/accounting/invoices.yml index a3d88012..963f67bb 100644 --- a/.mock/definition/accounting/invoices.yml +++ b/.mock/definition/accounting/invoices.yml @@ -27076,7 +27076,10 @@ service: type: root.PaginatedInvoiceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27195,7 +27198,8 @@ service: type: root.InvoiceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27353,7 +27357,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 @@ -27409,7 +27414,6 @@ service: item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b account: cd0f32d4-a493-11ec-b909-0242ac120002 tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -27485,7 +27489,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27643,7 +27648,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27654,6 +27662,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -27675,7 +27684,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -27859,7 +27869,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -28080,7 +28091,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -28091,6 +28105,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/issues.yml b/.mock/definition/accounting/issues.yml index 58c4f3b1..f7568739 100644 --- a/.mock/definition/accounting/issues.yml +++ b/.mock/definition/accounting/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/accounting/items.yml b/.mock/definition/accounting/items.yml index 29a34438..67a784e9 100644 --- a/.mock/definition/accounting/items.yml +++ b/.mock/definition/accounting/items.yml @@ -207,7 +207,10 @@ service: type: root.PaginatedItemList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -265,7 +268,8 @@ service: type: root.ItemResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -360,7 +364,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: d2f972d0-2526-434b-9409-4c3b468e08f0 @@ -419,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -486,7 +492,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -670,7 +677,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/journalEntries.yml b/.mock/definition/accounting/journalEntries.yml index feb7bad3..e471027d 100644 --- a/.mock/definition/accounting/journalEntries.yml +++ b/.mock/definition/accounting/journalEntries.yml @@ -338,7 +338,10 @@ service: type: root.PaginatedJournalEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -431,7 +434,8 @@ service: type: root.JournalEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -556,7 +560,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -580,7 +585,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912 net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -602,7 +606,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: f963f34d-3d2f-4f77-b557-cf36bc7e6498 net_amount: 10 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -690,7 +693,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -701,6 +707,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -718,7 +725,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -939,7 +947,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -950,6 +961,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/linkToken.yml b/.mock/definition/accounting/linkToken.yml index 5a2f0a6f..1d7aa0a0 100644 --- a/.mock/definition/accounting/linkToken.yml +++ b/.mock/definition/accounting/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/accounting/linkedAccounts.yml b/.mock/definition/accounting/linkedAccounts.yml index aa8806e8..a831126a 100644 --- a/.mock/definition/accounting/linkedAccounts.yml +++ b/.mock/definition/accounting/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/passthrough.yml b/.mock/definition/accounting/passthrough.yml index 25ab767c..db79aa9e 100644 --- a/.mock/definition/accounting/passthrough.yml +++ b/.mock/definition/accounting/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/accounting/paymentMethods.yml b/.mock/definition/accounting/paymentMethods.yml index c53c952c..844d0b85 100644 --- a/.mock/definition/accounting/paymentMethods.yml +++ b/.mock/definition/accounting/paymentMethods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedPaymentMethodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/paymentTerms.yml b/.mock/definition/accounting/paymentTerms.yml index 688ed9c3..edf23455 100644 --- a/.mock/definition/accounting/paymentTerms.yml +++ b/.mock/definition/accounting/paymentTerms.yml @@ -48,7 +48,10 @@ service: type: root.PaginatedPaymentTermList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -107,7 +110,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/payments.yml b/.mock/definition/accounting/payments.yml index be829a43..8a628d65 100644 --- a/.mock/definition/accounting/payments.yml +++ b/.mock/definition/accounting/payments.yml @@ -624,7 +624,10 @@ service: type: root.PaginatedPaymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -705,7 +708,8 @@ service: type: root.PaymentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -818,7 +822,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -902,7 +907,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1025,7 +1031,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1036,6 +1045,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1057,7 +1067,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1241,7 +1252,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1462,7 +1474,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1473,6 +1488,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/phoneNumbers.yml b/.mock/definition/accounting/phoneNumbers.yml index b6732385..75ad3e16 100644 --- a/.mock/definition/accounting/phoneNumbers.yml +++ b/.mock/definition/accounting/phoneNumbers.yml @@ -33,7 +33,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/projects.yml b/.mock/definition/accounting/projects.yml index c83c6626..add59523 100644 --- a/.mock/definition/accounting/projects.yml +++ b/.mock/definition/accounting/projects.yml @@ -89,7 +89,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/purchaseOrders.yml b/.mock/definition/accounting/purchaseOrders.yml index e0157639..bc57e698 100644 --- a/.mock/definition/accounting/purchaseOrders.yml +++ b/.mock/definition/accounting/purchaseOrders.yml @@ -634,7 +634,10 @@ service: type: root.PaginatedPurchaseOrderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -737,7 +740,8 @@ service: type: root.PurchaseOrderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -882,7 +886,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -912,7 +917,6 @@ service: quantity: 10 item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -935,7 +939,6 @@ service: quantity: 10 item: 249c9faa-3045-4a31-953b-8f22d3613301 account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -1020,7 +1023,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1031,6 +1037,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1048,7 +1055,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1269,7 +1277,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1280,6 +1291,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/regenerateKey.yml b/.mock/definition/accounting/regenerateKey.yml index 39fe26f9..fa714152 100644 --- a/.mock/definition/accounting/regenerateKey.yml +++ b/.mock/definition/accounting/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/scopes.yml b/.mock/definition/accounting/scopes.yml index ab81c591..4c990463 100644 --- a/.mock/definition/accounting/scopes.yml +++ b/.mock/definition/accounting/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/accounting/syncStatus.yml b/.mock/definition/accounting/syncStatus.yml index 38dcf2ce..2a5e4eb4 100644 --- a/.mock/definition/accounting/syncStatus.yml +++ b/.mock/definition/accounting/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/accounting/taxRates.yml b/.mock/definition/accounting/taxRates.yml index 3ff15195..c2695fb6 100644 --- a/.mock/definition/accounting/taxRates.yml +++ b/.mock/definition/accounting/taxRates.yml @@ -75,7 +75,10 @@ service: type: root.PaginatedTaxRateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/accounting/trackingCategories.yml b/.mock/definition/accounting/trackingCategories.yml index 2e3f062f..b63996f9 100644 --- a/.mock/definition/accounting/trackingCategories.yml +++ b/.mock/definition/accounting/trackingCategories.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedTrackingCategoryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -160,7 +163,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/transactions.yml b/.mock/definition/accounting/transactions.yml index 94a999db..342ce17f 100644 --- a/.mock/definition/accounting/transactions.yml +++ b/.mock/definition/accounting/transactions.yml @@ -205,7 +205,10 @@ service: type: root.PaginatedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -308,7 +311,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -339,7 +343,6 @@ service: quantity: '10.0' item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: 2b38c085-2620-4269-b5ec-75dd9095ed2c - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -359,7 +362,6 @@ service: quantity: '10.0' item: 249c9faa-3045-4a31-953b-8f22d3613301 account: 3e442c5d-8f51-4103-b5c9-dcee39c30a08 - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 diff --git a/.mock/definition/accounting/vendorCredits.yml b/.mock/definition/accounting/vendorCredits.yml index 39b41415..b8507e7c 100644 --- a/.mock/definition/accounting/vendorCredits.yml +++ b/.mock/definition/accounting/vendorCredits.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedVendorCreditList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -298,7 +301,8 @@ service: type: root.VendorCreditResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -420,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -441,7 +446,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -459,7 +463,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -507,7 +510,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/webhookReceivers.yml b/.mock/definition/accounting/webhookReceivers.yml index 0c90c826..c7bb86ce 100644 --- a/.mock/definition/accounting/webhookReceivers.yml +++ b/.mock/definition/accounting/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ats/accountDetails.yml b/.mock/definition/ats/accountDetails.yml index fe37fa60..a09c4849 100644 --- a/.mock/definition/ats/accountDetails.yml +++ b/.mock/definition/ats/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ats/accountToken.yml b/.mock/definition/ats/accountToken.yml index 0c372796..3c055421 100644 --- a/.mock/definition/ats/accountToken.yml +++ b/.mock/definition/ats/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ats/activities.yml b/.mock/definition/ats/activities.yml index 362836ad..2ed08a54 100644 --- a/.mock/definition/ats/activities.yml +++ b/.mock/definition/ats/activities.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedActivityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -170,7 +173,8 @@ service: type: root.ActivityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -262,7 +266,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -298,7 +303,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/applications.yml b/.mock/definition/ats/applications.yml index 4a5822f9..a6c86947 100644 --- a/.mock/definition/ats/applications.yml +++ b/.mock/definition/ats/applications.yml @@ -1426,7 +1426,10 @@ service: type: root.PaginatedApplicationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1498,7 +1501,8 @@ service: type: root.ApplicationResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -1586,7 +1590,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 92e8a369-fffe-430d-b93a-f7e8a16563f1 @@ -1655,7 +1660,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -1727,7 +1733,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/asyncPassthrough.yml b/.mock/definition/ats/asyncPassthrough.yml index 94686f10..1ab045cf 100644 --- a/.mock/definition/ats/asyncPassthrough.yml +++ b/.mock/definition/ats/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ats/attachments.yml b/.mock/definition/ats/attachments.yml index 14b45b1b..901d2eac 100644 --- a/.mock/definition/ats/attachments.yml +++ b/.mock/definition/ats/attachments.yml @@ -82,7 +82,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: type: root.AttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -223,7 +227,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -256,7 +261,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/auditTrail.yml b/.mock/definition/ats/auditTrail.yml index 36833ffe..d5a8c615 100644 --- a/.mock/definition/ats/auditTrail.yml +++ b/.mock/definition/ats/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/availableActions.yml b/.mock/definition/ats/availableActions.yml index 8e529df3..2f7515df 100644 --- a/.mock/definition/ats/availableActions.yml +++ b/.mock/definition/ats/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ats/candidates.yml b/.mock/definition/ats/candidates.yml index e5f23a79..e38f44e9 100644 --- a/.mock/definition/ats/candidates.yml +++ b/.mock/definition/ats/candidates.yml @@ -110,7 +110,10 @@ service: type: root.PaginatedCandidateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -194,7 +197,8 @@ service: type: root.CandidateResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -305,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 521b18c2-4d01-4297-b451-19858d07c133 @@ -393,7 +398,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -497,7 +503,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -516,7 +523,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -700,7 +708,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/deleteAccount.yml b/.mock/definition/ats/deleteAccount.yml index 6255a393..9ffe1a71 100644 --- a/.mock/definition/ats/deleteAccount.yml +++ b/.mock/definition/ats/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ats/departments.yml b/.mock/definition/ats/departments.yml index 8f001f43..ec1c4fa0 100644 --- a/.mock/definition/ats/departments.yml +++ b/.mock/definition/ats/departments.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedDepartmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b diff --git a/.mock/definition/ats/eeocs.yml b/.mock/definition/ats/eeocs.yml index 91dbf6b9..b14f676d 100644 --- a/.mock/definition/ats/eeocs.yml +++ b/.mock/definition/ats/eeocs.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedEeocList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -273,7 +276,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f7dd7b4f-237e-4772-8bd4-3246384c6c58 diff --git a/.mock/definition/ats/fieldMapping.yml b/.mock/definition/ats/fieldMapping.yml index 9d92fea8..949a75b5 100644 --- a/.mock/definition/ats/fieldMapping.yml +++ b/.mock/definition/ats/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: diff --git a/.mock/definition/ats/forceResync.yml b/.mock/definition/ats/forceResync.yml index 8a603992..b939eabe 100644 --- a/.mock/definition/ats/forceResync.yml +++ b/.mock/definition/ats/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Candidate diff --git a/.mock/definition/ats/generateKey.yml b/.mock/definition/ats/generateKey.yml index 40a39dcb..c7da4da8 100644 --- a/.mock/definition/ats/generateKey.yml +++ b/.mock/definition/ats/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/interviews.yml b/.mock/definition/ats/interviews.yml index aa95289c..0d25c536 100644 --- a/.mock/definition/ats/interviews.yml +++ b/.mock/definition/ats/interviews.yml @@ -152,7 +152,10 @@ service: type: root.PaginatedScheduledInterviewList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -212,7 +215,8 @@ service: type: root.ScheduledInterviewResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -309,7 +313,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b8faf072-98b9-4445-8a9a-6b4950efca19 @@ -350,7 +355,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/issues.yml b/.mock/definition/ats/issues.yml index 4984ce4e..51de2a7d 100644 --- a/.mock/definition/ats/issues.yml +++ b/.mock/definition/ats/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ats/jobInterviewStages.yml b/.mock/definition/ats/jobInterviewStages.yml index 5753b281..d1a7f9fd 100644 --- a/.mock/definition/ats/jobInterviewStages.yml +++ b/.mock/definition/ats/jobInterviewStages.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedJobInterviewStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -129,7 +132,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9813dd5-e70b-484c-91d8-00acd6065b07 diff --git a/.mock/definition/ats/jobPostings.yml b/.mock/definition/ats/jobPostings.yml index 859b5bb4..c888c890 100644 --- a/.mock/definition/ats/jobPostings.yml +++ b/.mock/definition/ats/jobPostings.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedJobPostingList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -161,7 +164,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 156a2bef-57e5-4def-8ed2-7c41bd9a554t diff --git a/.mock/definition/ats/jobs.yml b/.mock/definition/ats/jobs.yml index 7ec7441a..b5f780af 100644 --- a/.mock/definition/ats/jobs.yml +++ b/.mock/definition/ats/jobs.yml @@ -243,7 +243,10 @@ service: type: root.PaginatedJobList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -334,7 +337,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8 @@ -427,7 +431,10 @@ service: examples: - path-parameters: job_id: job_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/linkToken.yml b/.mock/definition/ats/linkToken.yml index 1548f705..a6b77072 100644 --- a/.mock/definition/ats/linkToken.yml +++ b/.mock/definition/ats/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ats/linkedAccounts.yml b/.mock/definition/ats/linkedAccounts.yml index 7acf3099..1f942677 100644 --- a/.mock/definition/ats/linkedAccounts.yml +++ b/.mock/definition/ats/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/offers.yml b/.mock/definition/ats/offers.yml index cb2591c8..bfbc9bb7 100644 --- a/.mock/definition/ats/offers.yml +++ b/.mock/definition/ats/offers.yml @@ -102,7 +102,10 @@ service: type: root.PaginatedOfferList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -173,7 +176,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: dd85625c-6a59-446f-a317-6de64d83bae7 diff --git a/.mock/definition/ats/offices.yml b/.mock/definition/ats/offices.yml index 080386b8..d8009929 100644 --- a/.mock/definition/ats/offices.yml +++ b/.mock/definition/ats/offices.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedOfficeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/ats/passthrough.yml b/.mock/definition/ats/passthrough.yml index 7141a6bd..a3dff513 100644 --- a/.mock/definition/ats/passthrough.yml +++ b/.mock/definition/ats/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ats/regenerateKey.yml b/.mock/definition/ats/regenerateKey.yml index 1ea4149a..5db09f20 100644 --- a/.mock/definition/ats/regenerateKey.yml +++ b/.mock/definition/ats/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/rejectReasons.yml b/.mock/definition/ats/rejectReasons.yml index 1552c46c..fc100819 100644 --- a/.mock/definition/ats/rejectReasons.yml +++ b/.mock/definition/ats/rejectReasons.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRejectReasonList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8be99a4a-f8d4-4339-bf1e-30eac970e217 diff --git a/.mock/definition/ats/scopes.yml b/.mock/definition/ats/scopes.yml index 422d3fa4..bdaf6ed0 100644 --- a/.mock/definition/ats/scopes.yml +++ b/.mock/definition/ats/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ats/scorecards.yml b/.mock/definition/ats/scorecards.yml index 6f83e854..a5f93514 100644 --- a/.mock/definition/ats/scorecards.yml +++ b/.mock/definition/ats/scorecards.yml @@ -119,7 +119,10 @@ service: type: root.PaginatedScorecardList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -189,7 +192,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f diff --git a/.mock/definition/ats/syncStatus.yml b/.mock/definition/ats/syncStatus.yml index 99b9bd54..81b1fa9c 100644 --- a/.mock/definition/ats/syncStatus.yml +++ b/.mock/definition/ats/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/tags.yml b/.mock/definition/ats/tags.yml index f6007d90..106e5cf9 100644 --- a/.mock/definition/ats/tags.yml +++ b/.mock/definition/ats/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/users.yml b/.mock/definition/ats/users.yml index 3bd2db1f..90a2bb54 100644 --- a/.mock/definition/ats/users.yml +++ b/.mock/definition/ats/users.yml @@ -81,7 +81,10 @@ service: type: root.PaginatedRemoteUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/ats/webhookReceivers.yml b/.mock/definition/ats/webhookReceivers.yml index 91d2ae65..76339c9f 100644 --- a/.mock/definition/ats/webhookReceivers.yml +++ b/.mock/definition/ats/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/crm/__package__.yml b/.mock/definition/crm/__package__.yml index 4ad8f75d..adb6df8b 100644 --- a/.mock/definition/crm/__package__.yml +++ b/.mock/definition/crm/__package__.yml @@ -5158,6 +5158,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/crm/accountDetails.yml b/.mock/definition/crm/accountDetails.yml index 4fe53ba5..2d2405a1 100644 --- a/.mock/definition/crm/accountDetails.yml +++ b/.mock/definition/crm/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/crm/accountToken.yml b/.mock/definition/crm/accountToken.yml index f06c40c5..a47b83c3 100644 --- a/.mock/definition/crm/accountToken.yml +++ b/.mock/definition/crm/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/crm/accounts.yml b/.mock/definition/crm/accounts.yml index e2959115..2e936825 100644 --- a/.mock/definition/crm/accounts.yml +++ b/.mock/definition/crm/accounts.yml @@ -80,7 +80,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -153,7 +156,8 @@ service: type: root.CrmAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -258,7 +262,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -334,7 +339,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -416,7 +422,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -600,7 +607,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -826,7 +834,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -837,6 +848,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/associationTypes.yml b/.mock/definition/crm/associationTypes.yml index 01f582d6..44da88c3 100644 --- a/.mock/definition/crm/associationTypes.yml +++ b/.mock/definition/crm/associationTypes.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -124,7 +127,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: source_object_class: @@ -208,7 +212,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5bb73c32-3c6c-4757-ab7d-7d3540a1be31 @@ -244,7 +249,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/crm/associations.yml b/.mock/definition/crm/associations.yml index bf27f3eb..983b55fe 100644 --- a/.mock/definition/crm/associations.yml +++ b/.mock/definition/crm/associations.yml @@ -81,7 +81,10 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id object_id: object_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -130,7 +133,8 @@ service: source_object_id: source_object_id target_class_id: target_class_id target_object_id: target_object_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/crm/asyncPassthrough.yml b/.mock/definition/crm/asyncPassthrough.yml index 6a7e257e..2fc106c9 100644 --- a/.mock/definition/crm/asyncPassthrough.yml +++ b/.mock/definition/crm/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/crm/auditTrail.yml b/.mock/definition/crm/auditTrail.yml index 68ad5c2f..be883e26 100644 --- a/.mock/definition/crm/auditTrail.yml +++ b/.mock/definition/crm/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/availableActions.yml b/.mock/definition/crm/availableActions.yml index 40338033..71b5d890 100644 --- a/.mock/definition/crm/availableActions.yml +++ b/.mock/definition/crm/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/crm/contacts.yml b/.mock/definition/crm/contacts.yml index b9f0b0f0..3fbcf9cd 100644 --- a/.mock/definition/crm/contacts.yml +++ b/.mock/definition/crm/contacts.yml @@ -104,7 +104,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -179,7 +182,8 @@ service: type: root.CrmContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -286,7 +290,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -364,7 +369,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -451,7 +457,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -470,7 +477,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -654,7 +662,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -880,7 +889,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -891,6 +903,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/customObjectClasses.yml b/.mock/definition/crm/customObjectClasses.yml index 7f6a5fba..87b54cad 100644 --- a/.mock/definition/crm/customObjectClasses.yml +++ b/.mock/definition/crm/customObjectClasses.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedCustomObjectClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ff1ff4cb-a66b-47dc-8e2a-50388049e602 diff --git a/.mock/definition/crm/customObjects.yml b/.mock/definition/crm/customObjects.yml index d4904e56..275d59c9 100644 --- a/.mock/definition/crm/customObjects.yml +++ b/.mock/definition/crm/customObjects.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: fields: @@ -197,7 +201,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: da0b1963-be70-469c-9f8c-06a81d0fe759 @@ -230,7 +235,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -456,7 +462,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -467,6 +476,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/deleteAccount.yml b/.mock/definition/crm/deleteAccount.yml index b0bfe1cd..9a343bd8 100644 --- a/.mock/definition/crm/deleteAccount.yml +++ b/.mock/definition/crm/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/crm/engagementTypes.yml b/.mock/definition/crm/engagementTypes.yml index 2070b2ef..025fe8e8 100644 --- a/.mock/definition/crm/engagementTypes.yml +++ b/.mock/definition/crm/engagementTypes.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedEngagementTypeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -184,7 +188,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -195,6 +202,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/engagements.yml b/.mock/definition/crm/engagements.yml index aaf88ac0..0812685b 100644 --- a/.mock/definition/crm/engagements.yml +++ b/.mock/definition/crm/engagements.yml @@ -145,7 +145,10 @@ service: type: root.PaginatedEngagementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.EngagementResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -295,7 +299,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -357,7 +362,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -425,7 +431,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -609,7 +616,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -835,7 +843,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -846,6 +857,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/fieldMapping.yml b/.mock/definition/crm/fieldMapping.yml index 5318dcf3..81c29c9c 100644 --- a/.mock/definition/crm/fieldMapping.yml +++ b/.mock/definition/crm/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -245,7 +246,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -312,7 +314,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -394,7 +397,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -465,7 +469,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -611,7 +616,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/crm/forceResync.yml b/.mock/definition/crm/forceResync.yml index eb74ba18..32a995cb 100644 --- a/.mock/definition/crm/forceResync.yml +++ b/.mock/definition/crm/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Account diff --git a/.mock/definition/crm/generateKey.yml b/.mock/definition/crm/generateKey.yml index 233479da..c913f239 100644 --- a/.mock/definition/crm/generateKey.yml +++ b/.mock/definition/crm/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/issues.yml b/.mock/definition/crm/issues.yml index ed21c69c..85deddd4 100644 --- a/.mock/definition/crm/issues.yml +++ b/.mock/definition/crm/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/crm/leads.yml b/.mock/definition/crm/leads.yml index 1f1e46d1..f6cc37af 100644 --- a/.mock/definition/crm/leads.yml +++ b/.mock/definition/crm/leads.yml @@ -124,7 +124,10 @@ service: type: root.PaginatedLeadList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.LeadResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -316,7 +320,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -380,7 +385,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -606,7 +612,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -617,6 +626,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/linkToken.yml b/.mock/definition/crm/linkToken.yml index f67b6892..d01d1d24 100644 --- a/.mock/definition/crm/linkToken.yml +++ b/.mock/definition/crm/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/crm/linkedAccounts.yml b/.mock/definition/crm/linkedAccounts.yml index c6f4399e..d2bf12d2 100644 --- a/.mock/definition/crm/linkedAccounts.yml +++ b/.mock/definition/crm/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/notes.yml b/.mock/definition/crm/notes.yml index df9293aa..ac7d94d1 100644 --- a/.mock/definition/crm/notes.yml +++ b/.mock/definition/crm/notes.yml @@ -147,7 +147,10 @@ service: type: root.PaginatedNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.NoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -291,7 +295,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -331,7 +336,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -557,7 +563,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -568,6 +577,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/opportunities.yml b/.mock/definition/crm/opportunities.yml index 4a0253aa..3aaaa4d0 100644 --- a/.mock/definition/crm/opportunities.yml +++ b/.mock/definition/crm/opportunities.yml @@ -148,7 +148,10 @@ service: type: root.PaginatedOpportunityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -207,7 +210,8 @@ service: type: root.OpportunityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -308,7 +312,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -370,7 +375,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -438,7 +444,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -622,7 +629,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -848,7 +856,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -859,6 +870,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/passthrough.yml b/.mock/definition/crm/passthrough.yml index 902b459d..a0a04015 100644 --- a/.mock/definition/crm/passthrough.yml +++ b/.mock/definition/crm/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/crm/regenerateKey.yml b/.mock/definition/crm/regenerateKey.yml index 06a1b856..d807b273 100644 --- a/.mock/definition/crm/regenerateKey.yml +++ b/.mock/definition/crm/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/scopes.yml b/.mock/definition/crm/scopes.yml index 67286e70..7069f300 100644 --- a/.mock/definition/crm/scopes.yml +++ b/.mock/definition/crm/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/crm/stages.yml b/.mock/definition/crm/stages.yml index a8676fa5..126f73c6 100644 --- a/.mock/definition/crm/stages.yml +++ b/.mock/definition/crm/stages.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -126,7 +129,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -202,7 +206,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -213,6 +220,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/syncStatus.yml b/.mock/definition/crm/syncStatus.yml index 52d8c36e..8e3a610c 100644 --- a/.mock/definition/crm/syncStatus.yml +++ b/.mock/definition/crm/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/crm/tasks.yml b/.mock/definition/crm/tasks.yml index befb0c54..e5b9f3b8 100644 --- a/.mock/definition/crm/tasks.yml +++ b/.mock/definition/crm/tasks.yml @@ -105,7 +105,10 @@ service: type: root.PaginatedTaskList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,8 @@ service: type: root.TaskResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -251,7 +255,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -311,7 +316,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -377,7 +383,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -561,7 +568,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -787,7 +795,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -798,6 +809,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/users.yml b/.mock/definition/crm/users.yml index 6762984a..ba9863c8 100644 --- a/.mock/definition/crm/users.yml +++ b/.mock/definition/crm/users.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -131,7 +134,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -174,7 +178,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST remoteFieldClassesList: @@ -231,7 +236,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -242,6 +250,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/webhookReceivers.yml b/.mock/definition/crm/webhookReceivers.yml index c68cd98b..e01c1645 100644 --- a/.mock/definition/crm/webhookReceivers.yml +++ b/.mock/definition/crm/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/filestorage/accountDetails.yml b/.mock/definition/filestorage/accountDetails.yml index 2411f37c..944a422b 100644 --- a/.mock/definition/filestorage/accountDetails.yml +++ b/.mock/definition/filestorage/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/filestorage/accountToken.yml b/.mock/definition/filestorage/accountToken.yml index 2c17a04f..e5400279 100644 --- a/.mock/definition/filestorage/accountToken.yml +++ b/.mock/definition/filestorage/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/filestorage/asyncPassthrough.yml b/.mock/definition/filestorage/asyncPassthrough.yml index 58df8351..1408e056 100644 --- a/.mock/definition/filestorage/asyncPassthrough.yml +++ b/.mock/definition/filestorage/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/filestorage/auditTrail.yml b/.mock/definition/filestorage/auditTrail.yml index f21c35fe..c9fb17ce 100644 --- a/.mock/definition/filestorage/auditTrail.yml +++ b/.mock/definition/filestorage/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/availableActions.yml b/.mock/definition/filestorage/availableActions.yml index b7a5e2b1..b60bd0c8 100644 --- a/.mock/definition/filestorage/availableActions.yml +++ b/.mock/definition/filestorage/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/filestorage/deleteAccount.yml b/.mock/definition/filestorage/deleteAccount.yml index 9b691154..cb9280c2 100644 --- a/.mock/definition/filestorage/deleteAccount.yml +++ b/.mock/definition/filestorage/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/filestorage/drives.yml b/.mock/definition/filestorage/drives.yml index 969b2321..8053831f 100644 --- a/.mock/definition/filestorage/drives.yml +++ b/.mock/definition/filestorage/drives.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDriveList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9e3d315-d6c2-458e-85c4-fa773d6ff4a6 diff --git a/.mock/definition/filestorage/fieldMapping.yml b/.mock/definition/filestorage/fieldMapping.yml index 0ef97a18..73378990 100644 --- a/.mock/definition/filestorage/fieldMapping.yml +++ b/.mock/definition/filestorage/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -181,7 +182,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -248,7 +250,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -330,7 +333,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -401,7 +405,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -491,7 +496,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: diff --git a/.mock/definition/filestorage/files.yml b/.mock/definition/filestorage/files.yml index 7230424d..97b56cde 100644 --- a/.mock/definition/filestorage/files.yml +++ b/.mock/definition/filestorage/files.yml @@ -150,7 +150,10 @@ service: type: root.PaginatedFileList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -215,7 +218,8 @@ service: type: root.FileStorageFileResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -307,7 +311,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 45ce474c-dhcj-43a6-754r-629f799f7d68 @@ -401,7 +406,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 @@ -473,7 +479,10 @@ service: type: root.PaginatedDownloadRequestMetaList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -496,7 +505,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/folders.yml b/.mock/definition/filestorage/folders.yml index 50ad205b..5ad69d06 100644 --- a/.mock/definition/filestorage/folders.yml +++ b/.mock/definition/filestorage/folders.yml @@ -113,7 +113,10 @@ service: type: root.PaginatedFolderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: type: root.FileStorageFolderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -252,7 +256,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: e021f7a7-74fc-4487-8e12-14180c92d3b7 @@ -290,7 +295,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/forceResync.yml b/.mock/definition/filestorage/forceResync.yml index 644c49b8..6dc20ca9 100644 --- a/.mock/definition/filestorage/forceResync.yml +++ b/.mock/definition/filestorage/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: File diff --git a/.mock/definition/filestorage/generateKey.yml b/.mock/definition/filestorage/generateKey.yml index 04ac41b8..06b1c8d7 100644 --- a/.mock/definition/filestorage/generateKey.yml +++ b/.mock/definition/filestorage/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/groups.yml b/.mock/definition/filestorage/groups.yml index 247ce30a..75e3efbd 100644 --- a/.mock/definition/filestorage/groups.yml +++ b/.mock/definition/filestorage/groups.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5624aceb-0ea2-4864-ba08-354ac56b9884 diff --git a/.mock/definition/filestorage/issues.yml b/.mock/definition/filestorage/issues.yml index b6a1d19e..19a40bd9 100644 --- a/.mock/definition/filestorage/issues.yml +++ b/.mock/definition/filestorage/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/filestorage/linkToken.yml b/.mock/definition/filestorage/linkToken.yml index fda54a0c..96af04e8 100644 --- a/.mock/definition/filestorage/linkToken.yml +++ b/.mock/definition/filestorage/linkToken.yml @@ -119,7 +119,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/filestorage/linkedAccounts.yml b/.mock/definition/filestorage/linkedAccounts.yml index d8fb0eb6..3c656510 100644 --- a/.mock/definition/filestorage/linkedAccounts.yml +++ b/.mock/definition/filestorage/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/passthrough.yml b/.mock/definition/filestorage/passthrough.yml index 432034bc..71b42437 100644 --- a/.mock/definition/filestorage/passthrough.yml +++ b/.mock/definition/filestorage/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/filestorage/regenerateKey.yml b/.mock/definition/filestorage/regenerateKey.yml index cd80f783..b251851a 100644 --- a/.mock/definition/filestorage/regenerateKey.yml +++ b/.mock/definition/filestorage/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/scopes.yml b/.mock/definition/filestorage/scopes.yml index a48a1642..b6b40f3e 100644 --- a/.mock/definition/filestorage/scopes.yml +++ b/.mock/definition/filestorage/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/filestorage/syncStatus.yml b/.mock/definition/filestorage/syncStatus.yml index 53140e4d..a35bc7c6 100644 --- a/.mock/definition/filestorage/syncStatus.yml +++ b/.mock/definition/filestorage/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/filestorage/users.yml b/.mock/definition/filestorage/users.yml index 6921bd65..38b7714c 100644 --- a/.mock/definition/filestorage/users.yml +++ b/.mock/definition/filestorage/users.yml @@ -67,7 +67,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 83902e75-4362-4803-b76c-a7d6be292cbd diff --git a/.mock/definition/filestorage/webhookReceivers.yml b/.mock/definition/filestorage/webhookReceivers.yml index 3b0bcace..6b965003 100644 --- a/.mock/definition/filestorage/webhookReceivers.yml +++ b/.mock/definition/filestorage/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/hris/accountDetails.yml b/.mock/definition/hris/accountDetails.yml index 2d4833d3..140409e5 100644 --- a/.mock/definition/hris/accountDetails.yml +++ b/.mock/definition/hris/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/hris/accountToken.yml b/.mock/definition/hris/accountToken.yml index 84185ffb..022851f2 100644 --- a/.mock/definition/hris/accountToken.yml +++ b/.mock/definition/hris/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/hris/asyncPassthrough.yml b/.mock/definition/hris/asyncPassthrough.yml index 841c4d91..9cb0b941 100644 --- a/.mock/definition/hris/asyncPassthrough.yml +++ b/.mock/definition/hris/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/hris/auditTrail.yml b/.mock/definition/hris/auditTrail.yml index 19e653ea..684b7e5d 100644 --- a/.mock/definition/hris/auditTrail.yml +++ b/.mock/definition/hris/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/availableActions.yml b/.mock/definition/hris/availableActions.yml index 74b6e655..e03e84f2 100644 --- a/.mock/definition/hris/availableActions.yml +++ b/.mock/definition/hris/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/hris/bankInfo.yml b/.mock/definition/hris/bankInfo.yml index d8d8fc21..872097f9 100644 --- a/.mock/definition/hris/bankInfo.yml +++ b/.mock/definition/hris/bankInfo.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedBankInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/benefits.yml b/.mock/definition/hris/benefits.yml index 2a98a378..a4ad2db2 100644 --- a/.mock/definition/hris/benefits.yml +++ b/.mock/definition/hris/benefits.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -86,7 +89,6 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' @@ -136,7 +138,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232 @@ -145,7 +148,6 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' diff --git a/.mock/definition/hris/companies.yml b/.mock/definition/hris/companies.yml index 3b107952..cb3881df 100644 --- a/.mock/definition/hris/companies.yml +++ b/.mock/definition/hris/companies.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedCompanyList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 1b998423-db0a-4037-a4cf-f79c60cb67b3 diff --git a/.mock/definition/hris/deleteAccount.yml b/.mock/definition/hris/deleteAccount.yml index d8b1e45c..fb59bf5f 100644 --- a/.mock/definition/hris/deleteAccount.yml +++ b/.mock/definition/hris/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/hris/dependents.yml b/.mock/definition/hris/dependents.yml index a4254ddd..bab4360c 100644 --- a/.mock/definition/hris/dependents.yml +++ b/.mock/definition/hris/dependents.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDependentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fe diff --git a/.mock/definition/hris/employeePayrollRuns.yml b/.mock/definition/hris/employeePayrollRuns.yml index c4ffb0b9..f6f53b28 100644 --- a/.mock/definition/hris/employeePayrollRuns.yml +++ b/.mock/definition/hris/employeePayrollRuns.yml @@ -116,7 +116,10 @@ service: type: root.PaginatedEmployeePayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -206,7 +209,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/hris/employees.yml b/.mock/definition/hris/employees.yml index bd50cfa6..df2cd00f 100644 --- a/.mock/definition/hris/employees.yml +++ b/.mock/definition/hris/employees.yml @@ -1320,7 +1320,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1347,14 +1350,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1399,7 +1400,8 @@ service: type: root.EmployeeResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1426,14 +1428,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1520,7 +1520,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1544,14 +1545,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1596,7 +1595,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPostRetrieve: @@ -1611,7 +1611,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/employerBenefits.yml b/.mock/definition/hris/employerBenefits.yml index f110617f..c8b0023c 100644 --- a/.mock/definition/hris/employerBenefits.yml +++ b/.mock/definition/hris/employerBenefits.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedEmployerBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fele diff --git a/.mock/definition/hris/employments.yml b/.mock/definition/hris/employments.yml index f676c7df..d653306f 100644 --- a/.mock/definition/hris/employments.yml +++ b/.mock/definition/hris/employments.yml @@ -232,7 +232,10 @@ service: type: root.PaginatedEmploymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -306,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 diff --git a/.mock/definition/hris/fieldMapping.yml b/.mock/definition/hris/fieldMapping.yml index 2c83b146..1a222f9f 100644 --- a/.mock/definition/hris/fieldMapping.yml +++ b/.mock/definition/hris/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: diff --git a/.mock/definition/hris/forceResync.yml b/.mock/definition/hris/forceResync.yml index ccae8e7b..3871daeb 100644 --- a/.mock/definition/hris/forceResync.yml +++ b/.mock/definition/hris/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Employee diff --git a/.mock/definition/hris/generateKey.yml b/.mock/definition/hris/generateKey.yml index 94a399fc..18c4f7c3 100644 --- a/.mock/definition/hris/generateKey.yml +++ b/.mock/definition/hris/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/groups.yml b/.mock/definition/hris/groups.yml index 942ebedf..a9bc5589 100644 --- a/.mock/definition/hris/groups.yml +++ b/.mock/definition/hris/groups.yml @@ -91,7 +91,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -154,7 +157,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 134e0111-0f67-44f6-98f0-597000290bb3 diff --git a/.mock/definition/hris/issues.yml b/.mock/definition/hris/issues.yml index 9fd39ae2..d9de5306 100644 --- a/.mock/definition/hris/issues.yml +++ b/.mock/definition/hris/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/hris/linkToken.yml b/.mock/definition/hris/linkToken.yml index c83a57e8..766171de 100644 --- a/.mock/definition/hris/linkToken.yml +++ b/.mock/definition/hris/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/hris/linkedAccounts.yml b/.mock/definition/hris/linkedAccounts.yml index 3ed63936..5d4c897d 100644 --- a/.mock/definition/hris/linkedAccounts.yml +++ b/.mock/definition/hris/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/locations.yml b/.mock/definition/hris/locations.yml index a4c2f9b6..d5217222 100644 --- a/.mock/definition/hris/locations.yml +++ b/.mock/definition/hris/locations.yml @@ -120,7 +120,10 @@ service: type: root.PaginatedLocationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -188,7 +191,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f5e6a151-f44e-449a-afb1-8fd781905958 diff --git a/.mock/definition/hris/passthrough.yml b/.mock/definition/hris/passthrough.yml index 602b2cd6..fbe19301 100644 --- a/.mock/definition/hris/passthrough.yml +++ b/.mock/definition/hris/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/hris/payGroups.yml b/.mock/definition/hris/payGroups.yml index 981803d8..dd031706 100644 --- a/.mock/definition/hris/payGroups.yml +++ b/.mock/definition/hris/payGroups.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedPayGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/payrollRuns.yml b/.mock/definition/hris/payrollRuns.yml index b4414e43..8687f6d5 100644 --- a/.mock/definition/hris/payrollRuns.yml +++ b/.mock/definition/hris/payrollRuns.yml @@ -153,7 +153,10 @@ service: type: root.PaginatedPayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -217,7 +220,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 37336947-b3d4-4a4c-a310-ab6ab510e079 diff --git a/.mock/definition/hris/regenerateKey.yml b/.mock/definition/hris/regenerateKey.yml index e29e77d3..b9daa8b2 100644 --- a/.mock/definition/hris/regenerateKey.yml +++ b/.mock/definition/hris/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/scopes.yml b/.mock/definition/hris/scopes.yml index 59ec6a77..31252ad4 100644 --- a/.mock/definition/hris/scopes.yml +++ b/.mock/definition/hris/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/hris/syncStatus.yml b/.mock/definition/hris/syncStatus.yml index c7e03e66..cca7aca2 100644 --- a/.mock/definition/hris/syncStatus.yml +++ b/.mock/definition/hris/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/hris/teams.yml b/.mock/definition/hris/teams.yml index 4cb87414..902b49a3 100644 --- a/.mock/definition/hris/teams.yml +++ b/.mock/definition/hris/teams.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba diff --git a/.mock/definition/hris/timeOff.yml b/.mock/definition/hris/timeOff.yml index 94818112..6ed9b785 100644 --- a/.mock/definition/hris/timeOff.yml +++ b/.mock/definition/hris/timeOff.yml @@ -236,7 +236,10 @@ service: type: root.PaginatedTimeOffList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -292,7 +295,8 @@ service: type: root.TimeOffResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -385,7 +389,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -423,7 +428,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/timeOffBalances.yml b/.mock/definition/hris/timeOffBalances.yml index 509df361..22ad8176 100644 --- a/.mock/definition/hris/timeOffBalances.yml +++ b/.mock/definition/hris/timeOffBalances.yml @@ -112,7 +112,10 @@ service: type: root.PaginatedTimeOffBalanceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -180,7 +183,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa diff --git a/.mock/definition/hris/timesheetEntries.yml b/.mock/definition/hris/timesheetEntries.yml index 69380ef4..62f53265 100644 --- a/.mock/definition/hris/timesheetEntries.yml +++ b/.mock/definition/hris/timesheetEntries.yml @@ -106,7 +106,10 @@ service: type: root.PaginatedTimesheetEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -157,7 +160,8 @@ service: type: root.TimesheetEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -235,7 +239,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -268,7 +273,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/webhookReceivers.yml b/.mock/definition/hris/webhookReceivers.yml index 05eae39d..62fbcab5 100644 --- a/.mock/definition/hris/webhookReceivers.yml +++ b/.mock/definition/hris/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index fef97a5f..845b0699 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -2319,6 +2319,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/ticketing/accountDetails.yml b/.mock/definition/ticketing/accountDetails.yml index 1cd26dd4..4204619f 100644 --- a/.mock/definition/ticketing/accountDetails.yml +++ b/.mock/definition/ticketing/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ticketing/accountToken.yml b/.mock/definition/ticketing/accountToken.yml index e3b505e5..057dc6d6 100644 --- a/.mock/definition/ticketing/accountToken.yml +++ b/.mock/definition/ticketing/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ticketing/accounts.yml b/.mock/definition/ticketing/accounts.yml index 9dc3f7a8..4f695f73 100644 --- a/.mock/definition/ticketing/accounts.yml +++ b/.mock/definition/ticketing/accounts.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/asyncPassthrough.yml b/.mock/definition/ticketing/asyncPassthrough.yml index 0a2001fe..02724e93 100644 --- a/.mock/definition/ticketing/asyncPassthrough.yml +++ b/.mock/definition/ticketing/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ticketing/attachments.yml b/.mock/definition/ticketing/attachments.yml index 9a8a8a9c..671474bf 100644 --- a/.mock/definition/ticketing/attachments.yml +++ b/.mock/definition/ticketing/attachments.yml @@ -77,7 +77,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: type: root.TicketingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -206,7 +210,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -270,7 +275,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/auditTrail.yml b/.mock/definition/ticketing/auditTrail.yml index 82660fae..5b42e8b8 100644 --- a/.mock/definition/ticketing/auditTrail.yml +++ b/.mock/definition/ticketing/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/availableActions.yml b/.mock/definition/ticketing/availableActions.yml index 745b76c7..750b5faa 100644 --- a/.mock/definition/ticketing/availableActions.yml +++ b/.mock/definition/ticketing/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ticketing/collections.yml b/.mock/definition/ticketing/collections.yml index dbf6f131..0861c825 100644 --- a/.mock/definition/ticketing/collections.yml +++ b/.mock/definition/ticketing/collections.yml @@ -87,7 +87,10 @@ service: type: root.PaginatedCollectionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,10 @@ service: examples: - path-parameters: collection_id: collection_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -218,7 +224,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/ticketing/comments.yml b/.mock/definition/ticketing/comments.yml index 71a70dc5..7c789021 100644 --- a/.mock/definition/ticketing/comments.yml +++ b/.mock/definition/ticketing/comments.yml @@ -108,7 +108,10 @@ service: type: root.PaginatedCommentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -164,7 +167,8 @@ service: type: root.CommentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -247,7 +251,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -285,7 +290,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/contacts.yml b/.mock/definition/ticketing/contacts.yml index e4a13d7c..6bc83943 100644 --- a/.mock/definition/ticketing/contacts.yml +++ b/.mock/definition/ticketing/contacts.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: type: root.TicketingContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -196,7 +200,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -230,7 +235,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/deleteAccount.yml b/.mock/definition/ticketing/deleteAccount.yml index b2d1911d..021acbde 100644 --- a/.mock/definition/ticketing/deleteAccount.yml +++ b/.mock/definition/ticketing/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/fieldMapping.yml b/.mock/definition/ticketing/fieldMapping.yml index 3051c3fc..8721c1c2 100644 --- a/.mock/definition/ticketing/fieldMapping.yml +++ b/.mock/definition/ticketing/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -277,7 +278,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -344,7 +346,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -426,7 +429,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -497,7 +501,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -671,7 +676,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: diff --git a/.mock/definition/ticketing/forceResync.yml b/.mock/definition/ticketing/forceResync.yml index a9669fa2..39b44277 100644 --- a/.mock/definition/ticketing/forceResync.yml +++ b/.mock/definition/ticketing/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Ticket diff --git a/.mock/definition/ticketing/generateKey.yml b/.mock/definition/ticketing/generateKey.yml index 54e7585c..03e42e8e 100644 --- a/.mock/definition/ticketing/generateKey.yml +++ b/.mock/definition/ticketing/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/issues.yml b/.mock/definition/ticketing/issues.yml index badd03c1..22c452d4 100644 --- a/.mock/definition/ticketing/issues.yml +++ b/.mock/definition/ticketing/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ticketing/linkToken.yml b/.mock/definition/ticketing/linkToken.yml index 908ed584..b3c79737 100644 --- a/.mock/definition/ticketing/linkToken.yml +++ b/.mock/definition/ticketing/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ticketing/linkedAccounts.yml b/.mock/definition/ticketing/linkedAccounts.yml index 072cf0e3..a9563978 100644 --- a/.mock/definition/ticketing/linkedAccounts.yml +++ b/.mock/definition/ticketing/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/passthrough.yml b/.mock/definition/ticketing/passthrough.yml index 44434d15..f20522bf 100644 --- a/.mock/definition/ticketing/passthrough.yml +++ b/.mock/definition/ticketing/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ticketing/projects.yml b/.mock/definition/ticketing/projects.yml index dd749346..7623e288 100644 --- a/.mock/definition/ticketing/projects.yml +++ b/.mock/definition/ticketing/projects.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d @@ -180,7 +184,10 @@ service: examples: - path-parameters: parent_id: parent_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/regenerateKey.yml b/.mock/definition/ticketing/regenerateKey.yml index 5dab779d..1697dc88 100644 --- a/.mock/definition/ticketing/regenerateKey.yml +++ b/.mock/definition/ticketing/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/roles.yml b/.mock/definition/ticketing/roles.yml index 09eb4680..38784053 100644 --- a/.mock/definition/ticketing/roles.yml +++ b/.mock/definition/ticketing/roles.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRoleList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 23454124-387f-494d-265e-345b330c9123 diff --git a/.mock/definition/ticketing/scopes.yml b/.mock/definition/ticketing/scopes.yml index 11866654..61201cbf 100644 --- a/.mock/definition/ticketing/scopes.yml +++ b/.mock/definition/ticketing/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ticketing/syncStatus.yml b/.mock/definition/ticketing/syncStatus.yml index 5b49f2a3..5cc91fe7 100644 --- a/.mock/definition/ticketing/syncStatus.yml +++ b/.mock/definition/ticketing/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/tags.yml b/.mock/definition/ticketing/tags.yml index 7ebaf157..d8046d5f 100644 --- a/.mock/definition/ticketing/tags.yml +++ b/.mock/definition/ticketing/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -112,7 +115,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: remote_id: '19202938' diff --git a/.mock/definition/ticketing/teams.yml b/.mock/definition/ticketing/teams.yml index 47bcb682..0f6096db 100644 --- a/.mock/definition/ticketing/teams.yml +++ b/.mock/definition/ticketing/teams.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 8177b0bf..07c87379 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -1276,7 +1276,10 @@ service: type: root.PaginatedTicketList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1355,7 +1358,8 @@ service: type: root.TicketResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1476,7 +1480,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1560,7 +1565,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1684,7 +1690,10 @@ service: examples: - path-parameters: ticket_id: ticket_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1712,7 +1721,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1905,7 +1915,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -2131,7 +2142,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -2142,6 +2156,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: field_type field_format: field_format diff --git a/.mock/definition/ticketing/users.yml b/.mock/definition/ticketing/users.yml index 76cfbe5f..05094917 100644 --- a/.mock/definition/ticketing/users.yml +++ b/.mock/definition/ticketing/users.yml @@ -94,7 +94,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -155,7 +158,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/webhookReceivers.yml b/.mock/definition/ticketing/webhookReceivers.yml index 54b5126a..454c1a98 100644 --- a/.mock/definition/ticketing/webhookReceivers.yml +++ b/.mock/definition/ticketing/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/fern.config.json b/.mock/fern.config.json index c4faf103..43adf15e 100644 --- a/.mock/fern.config.json +++ b/.mock/fern.config.json @@ -1,4 +1,4 @@ { "organization" : "merge", - "version" : "0.63.28" + "version" : "0.66.29" } \ No newline at end of file diff --git a/README.md b/README.md index f61bfd79..4f729cb0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmerge-api%2Fmerge-python-client) [![pypi](https://img.shields.io/pypi/v/MergePythonClient)](https://pypi.python.org/pypi/MergePythonClient) -The Merge Python library provides convenient access to the Merge API from Python. +The Merge Python library provides convenient access to the Merge APIs from Python. ## Documentation @@ -25,15 +25,17 @@ Instantiate and use the client with the following: ```python from merge import Merge -from merge.resources.ats import ActivityRequest +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -68,7 +70,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t import asyncio from merge import AsyncMerge -from merge.resources.ats import ActivityRequest +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = AsyncMerge( account_token="YOUR_ACCOUNT_TOKEN", @@ -77,9 +79,11 @@ client = AsyncMerge( async def main() -> None: - await client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", + await client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) @@ -95,7 +99,7 @@ will be thrown. from merge.core.api_error import ApiError try: - client.ats.activities.create(...) + client.filestorage.async_passthrough.create(...) except ApiError as e: print(e.status_code) print(e.body) @@ -114,7 +118,7 @@ from merge import Merge client = Merge( ..., ) -response = client.ats.activities.with_raw_response.create(...) +response = client.filestorage.async_passthrough.with_raw_response.create(...) print(response.headers) # access the response headers print(response.data) # access the underlying object ``` @@ -134,7 +138,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret Use the `max_retries` request option to configure this behavior. ```python -client.ats.activities.create(..., request_options={ +client.filestorage.async_passthrough.create(..., request_options={ "max_retries": 1 }) ``` @@ -154,7 +158,7 @@ client = Merge( # Override timeout for a specific method -client.ats.activities.create(..., request_options={ +client.filestorage.async_passthrough.create(..., request_options={ "timeout_in_seconds": 1 }) ``` @@ -230,3 +234,4 @@ while response.next is not None: ``` + diff --git a/poetry.lock b/poetry.lock index c1c2313e..c2ddd863 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2025.7.14" +version = "2025.8.3" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.7" files = [ - {file = "certifi-2025.7.14-py3-none-any.whl", hash = "sha256:6b31f564a415d79ee77df69d757bb49a5bb53bd9f756cbbe24394ffd6fc1f4b2"}, - {file = "certifi-2025.7.14.tar.gz", hash = "sha256:8ea99dbdfaaf2ba2f9bac77b9249ef62ec5218e7c2b2e903378ed5fccf765995"}, + {file = "certifi-2025.8.3-py3-none-any.whl", hash = "sha256:f6c12493cfb1b06ba2ff328595af9350c65d6644968e5d3a2ffd78699af217a5"}, + {file = "certifi-2025.8.3.tar.gz", hash = "sha256:e564105f78ded564e3ae7c923924435e1daa7463faeab5bb932bc53ffae63407"}, ] [[package]] diff --git a/pyproject.toml b/pyproject.toml index 88939876..ee7c8ba6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.1.1" +version = "2.2.1" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index a497d5bf..ddfb3b02 100644 --- a/reference.md +++ b/reference.md @@ -1,6 +1,6 @@ # Reference -## Ats AccountDetails -
client.ats.account_details.retrieve() +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -33,7 +33,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.account_details.retrieve() +client.filestorage.account_details.retrieve() ```
@@ -61,8 +61,8 @@ client.ats.account_details.retrieve()
-## Ats AccountToken -
client.ats.account_token.retrieve(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -95,7 +95,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.account_token.retrieve( +client.filestorage.account_token.retrieve( public_token="public_token", ) @@ -133,8 +133,8 @@ client.ats.account_token.retrieve(
-## Ats Activities -
client.ats.activities.list(...) +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -146,7 +146,7 @@ client.ats.account_token.retrieve(
-Returns a list of `Activity` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -162,12 +162,18 @@ Returns a list of `Activity` objects. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.list() +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -183,7 +189,7 @@ client.ats.activities.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -191,31 +197,70 @@ client.ats.activities.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.
+ +
+ + + +
+ +
client.filestorage.async_passthrough.retrieve(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +#### 📝 Description + +
+
+ +
+
+ +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**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/). +
+
+ +**async_passthrough_receipt_id:** `str`
@@ -223,31 +268,71 @@ client.ats.activities.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+## Filestorage AuditTrail +
client.filestorage.audit_trail.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). - +#### 📝 Description + +
+
+ +
+
+ +Gets a list of audit trail events. +
+
+#### 🔌 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 + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ 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.
@@ -255,7 +340,7 @@ client.ats.activities.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -263,7 +348,7 @@ client.ats.activities.list()
-**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**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`
@@ -271,7 +356,7 @@ client.ats.activities.list()
-**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.
@@ -279,7 +364,7 @@ client.ats.activities.list()
-**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` — 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) +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -287,7 +372,7 @@ client.ats.activities.list()
-**user_id:** `typing.Optional[str]` — If provided, will only return activities done by this user. +**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.
@@ -307,7 +392,8 @@ client.ats.activities.list()
-
client.ats.activities.create(...) +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -319,7 +405,7 @@ client.ats.activities.list()
-Creates an `Activity` object with the given values. +Returns a list of models and actions available for an account.
@@ -335,16 +421,12 @@ Creates an `Activity` object with the given values. ```python from merge import Merge -from merge.resources.ats import ActivityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", -) +client.filestorage.available_actions.retrieve() ``` @@ -360,35 +442,65 @@ client.ats.activities.create(
-**model:** `ActivityRequest` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_user_id:** `str` -
+
+## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - +#### 📝 Description + +
+
+ +
+
+ +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).
+
+
+ +#### 🔌 Usage
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.scopes.default_scopes_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -404,7 +516,7 @@ client.ats.activities.create(
-
client.ats.activities.retrieve(...) +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -416,7 +528,7 @@ client.ats.activities.create(
-Returns an `Activity` object with the given `id`. +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).
@@ -437,9 +549,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.retrieve( - id="id", -) +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -455,47 +565,99 @@ client.ats.activities.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.filestorage.scopes.linked_account_scopes_create(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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 +
-**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. - +
+
+ +```python +from merge import Merge +from merge.resources.filestorage import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.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 +
-**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` — 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) +
+
+ +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -515,7 +677,8 @@ client.ats.activities.retrieve(
-
client.ats.activities.meta_post_retrieve() +## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
@@ -527,7 +690,7 @@ client.ats.activities.retrieve(
-Returns metadata for `Activity` POSTs. +Delete a linked account.
@@ -548,7 +711,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.meta_post_retrieve() +client.filestorage.delete_account.delete() ``` @@ -576,8 +739,8 @@ client.ats.activities.meta_post_retrieve()
-## Ats Applications -
client.ats.applications.list(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -589,7 +752,7 @@ client.ats.activities.meta_post_retrieve()
-Returns a list of `Application` objects. +Returns a list of `Drive` objects.
@@ -610,7 +773,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.list() +client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -626,14 +791,6 @@ client.ats.applications.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return applications for this candidate. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -650,22 +807,6 @@ client.ats.applications.list()
-**credited_to_id:** `typing.Optional[str]` — If provided, will only return applications credited to this user. - -
-
- -
-
- -**current_stage_id:** `typing.Optional[str]` — If provided, will only return applications at this interview stage. - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -674,14 +815,6 @@ client.ats.applications.list()
-**expand:** `typing.Optional[ApplicationsListRequestExpand]` — 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/).
@@ -706,14 +839,6 @@ client.ats.applications.list()
-**job_id:** `typing.Optional[str]` — If provided, will only return applications for this job. - -
-
- -
-
- **modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -730,7 +855,7 @@ client.ats.applications.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -738,7 +863,7 @@ client.ats.applications.list()
-**reject_reason_id:** `typing.Optional[str]` — If provided, will only return applications with this reject reason. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -754,14 +879,6 @@ client.ats.applications.list()
-**source:** `typing.Optional[str]` — If provided, will only return applications with this source. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -774,7 +891,7 @@ client.ats.applications.list()
-
client.ats.applications.create(...) +
client.filestorage.drives.retrieve(...)
@@ -786,10 +903,7 @@ client.ats.applications.list()
-Creates an `Application` object with the given values. -For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. - -See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration. +Returns a `Drive` object with the given `id`.
@@ -805,15 +919,13 @@ See our [Help Center article](https://help.merge.dev/en/articles/10012366-update ```python from merge import Merge -from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.create( - model=ApplicationRequest(), - remote_user_id="remote_user_id", +client.filestorage.drives.retrieve( + id="id", ) ``` @@ -830,15 +942,7 @@ client.ats.applications.create(
-**model:** `ApplicationRequest` - -
-
- -
-
- -**remote_user_id:** `str` +**id:** `str`
@@ -846,7 +950,7 @@ client.ats.applications.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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.
@@ -854,7 +958,7 @@ client.ats.applications.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -874,7 +978,8 @@ client.ats.applications.create(
-
client.ats.applications.retrieve(...) +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -886,7 +991,7 @@ client.ats.applications.create(
-Returns an `Application` object with the given `id`. +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/).
@@ -907,9 +1012,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.retrieve( - id="id", -) +client.filestorage.field_mapping.field_mappings_retrieve() ``` @@ -925,31 +1028,7 @@ client.ats.applications.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — 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). +**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.
@@ -969,7 +1048,7 @@ client.ats.applications.retrieve(
-
client.ats.applications.change_stage_create(...) +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -981,7 +1060,7 @@ client.ats.applications.retrieve(
-Updates the `current_stage` field of an `Application` object +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.
@@ -1002,8 +1081,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.change_stage_create( - id="id", +client.filestorage.field_mapping.field_mappings_create( + 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", ) ``` @@ -1020,7 +1104,7 @@ client.ats.applications.change_stage_create(
-**id:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -1028,7 +1112,7 @@ client.ats.applications.change_stage_create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -1036,7 +1120,7 @@ client.ats.applications.change_stage_create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -1044,7 +1128,7 @@ client.ats.applications.change_stage_create(
-**job_interview_stage:** `typing.Optional[str]` — The interview stage to move the application to. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -1052,7 +1136,23 @@ client.ats.applications.change_stage_create(
-**remote_user_id:** `typing.Optional[str]` +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**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.
@@ -1072,7 +1172,7 @@ client.ats.applications.change_stage_create(
-
client.ats.applications.meta_post_retrieve(...) +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -1084,7 +1184,7 @@ client.ats.applications.change_stage_create(
-Returns metadata for `Application` POSTs. +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.
@@ -1105,7 +1205,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.meta_post_retrieve() +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -1121,7 +1223,7 @@ client.ats.applications.meta_post_retrieve()
-**application_remote_template_id:** `typing.Optional[str]` — The template ID associated with the nested application in the request. +**field_mapping_id:** `str`
@@ -1141,8 +1243,7 @@ client.ats.applications.meta_post_retrieve()
-## Ats AsyncPassthrough -
client.ats.async_passthrough.create(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -1154,7 +1255,7 @@ client.ats.applications.meta_post_retrieve()
-Asynchronously pull data from an endpoint not currently supported by Merge. +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.
@@ -1170,17 +1271,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -1197,7 +1294,31 @@ client.ats.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -1217,7 +1338,7 @@ client.ats.async_passthrough.create(
-
client.ats.async_passthrough.retrieve(...) +
client.filestorage.field_mapping.remote_fields_retrieve(...)
@@ -1229,7 +1350,7 @@ client.ats.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +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/).
@@ -1250,9 +1371,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.filestorage.field_mapping.remote_fields_retrieve() ``` @@ -1268,7 +1387,15 @@ client.ats.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**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.
@@ -1288,8 +1415,7 @@ client.ats.async_passthrough.retrieve(
-## Ats Attachments -
client.ats.attachments.list(...) +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -1301,7 +1427,7 @@ client.ats.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +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/).
@@ -1322,7 +1448,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.list() +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -1338,10 +1464,66 @@ client.ats.attachments.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return attachments for this candidate. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Filestorage Files +
client.filestorage.files.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `File` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
@@ -1370,7 +1552,23 @@ client.ats.attachments.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
@@ -1402,6 +1600,14 @@ client.ats.attachments.list()
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. + +
+
+ +
+
+ **modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -1418,7 +1624,7 @@ client.ats.attachments.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -1426,7 +1632,7 @@ client.ats.attachments.list()
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. +**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -1434,7 +1640,7 @@ client.ats.attachments.list()
-**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.
@@ -1442,7 +1648,7 @@ client.ats.attachments.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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) +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -1462,7 +1668,7 @@ client.ats.attachments.list()
-
client.ats.attachments.create(...) +
client.filestorage.files.create(...)
@@ -1474,7 +1680,7 @@ client.ats.attachments.list()
-Creates an `Attachment` object with the given values. +Creates a `File` object with the given values.
@@ -1490,15 +1696,14 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ats import AttachmentRequest +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.create( - model=AttachmentRequest(), - remote_user_id="remote_user_id", +client.filestorage.files.create( + model=FileRequest(), ) ``` @@ -1515,15 +1720,7 @@ client.ats.attachments.create(
-**model:** `AttachmentRequest` - -
-
- -
-
- -**remote_user_id:** `str` +**model:** `FileRequest`
@@ -1559,7 +1756,7 @@ client.ats.attachments.create(
-
client.ats.attachments.retrieve(...) +
client.filestorage.files.retrieve(...)
@@ -1571,7 +1768,7 @@ client.ats.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a `File` object with the given `id`.
@@ -1592,7 +1789,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.retrieve( +client.filestorage.files.retrieve( id="id", ) @@ -1618,7 +1815,7 @@ client.ats.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1642,22 +1839,6 @@ client.ats.attachments.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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.
@@ -1670,7 +1851,7 @@ client.ats.attachments.retrieve(
-
client.ats.attachments.meta_post_retrieve() +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -1682,7 +1863,7 @@ client.ats.attachments.retrieve(
-Returns metadata for `Attachment` POSTs. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -1703,7 +1884,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.meta_post_retrieve() +client.filestorage.files.download_request_meta_retrieve( + id="id", +) ``` @@ -1719,6 +1902,22 @@ client.ats.attachments.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -1731,8 +1930,7 @@ client.ats.attachments.meta_post_retrieve()
-## Ats AuditTrail -
client.ats.audit_trail.list(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -1744,7 +1942,7 @@ client.ats.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -1765,7 +1963,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.audit_trail.list() +client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1781,6 +1981,22 @@ client.ats.audit_trail.list()
+**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -1789,7 +2005,7 @@ client.ats.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**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/).
@@ -1797,7 +2013,7 @@ client.ats.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` +**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
@@ -1805,7 +2021,7 @@ client.ats.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -1813,7 +2029,7 @@ client.ats.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -1821,7 +2037,15 @@ client.ats.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. +**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -1841,8 +2065,7 @@ client.ats.audit_trail.list()
-## Ats AvailableActions -
client.ats.available_actions.retrieve() +
client.filestorage.files.meta_post_retrieve()
@@ -1854,7 +2077,7 @@ client.ats.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns metadata for `FileStorageFile` POSTs.
@@ -1875,7 +2098,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.available_actions.retrieve() +client.filestorage.files.meta_post_retrieve() ``` @@ -1903,8 +2126,8 @@ client.ats.available_actions.retrieve()
-## Ats Candidates -
client.ats.candidates.list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -1916,7 +2139,7 @@ client.ats.available_actions.retrieve()
-Returns a list of `Candidate` objects. +Returns a list of `Folder` objects.
@@ -1937,7 +2160,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.list() +client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1977,15 +2202,7 @@ client.ats.candidates.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. - -
-
- -
-
- -**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
@@ -1993,7 +2210,7 @@ client.ats.candidates.list()
-**first_name:** `typing.Optional[str]` — If provided, will only return candidates with this first name. +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2025,7 +2242,7 @@ client.ats.candidates.list()
-**last_name:** `typing.Optional[str]` — If provided, will only return candidates with this last name. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -2033,7 +2250,7 @@ client.ats.candidates.list()
-**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.
@@ -2041,7 +2258,7 @@ client.ats.candidates.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
@@ -2057,7 +2274,7 @@ client.ats.candidates.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
@@ -2065,7 +2282,7 @@ client.ats.candidates.list()
-**tags:** `typing.Optional[str]` — If provided, will only return candidates with these tags; multiple tags can be separated by commas. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -2085,7 +2302,7 @@ client.ats.candidates.list()
-
client.ats.candidates.create(...) +
client.filestorage.folders.create(...)
@@ -2097,7 +2314,7 @@ client.ats.candidates.list()
-Creates a `Candidate` object with the given values. +Creates a `Folder` object with the given values.
@@ -2113,15 +2330,14 @@ Creates a `Candidate` object with the given values. ```python from merge import Merge -from merge.resources.ats import CandidateRequest +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.create( - model=CandidateRequest(), - remote_user_id="remote_user_id", +client.filestorage.folders.create( + model=FolderRequest(), ) ``` @@ -2138,15 +2354,7 @@ client.ats.candidates.create(
-**model:** `CandidateRequest` - -
-
- -
-
- -**remote_user_id:** `str` +**model:** `FolderRequest`
@@ -2182,7 +2390,7 @@ client.ats.candidates.create(
-
client.ats.candidates.retrieve(...) +
client.filestorage.folders.retrieve(...)
@@ -2194,7 +2402,7 @@ client.ats.candidates.create(
-Returns a `Candidate` object with the given `id`. +Returns a `Folder` object with the given `id`.
@@ -2215,7 +2423,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.retrieve( +client.filestorage.folders.retrieve( id="id", ) @@ -2241,7 +2449,7 @@ client.ats.candidates.retrieve(
-**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2277,7 +2485,7 @@ client.ats.candidates.retrieve(
-
client.ats.candidates.partial_update(...) +
client.filestorage.folders.meta_post_retrieve()
@@ -2289,7 +2497,7 @@ client.ats.candidates.retrieve(
-Updates a `Candidate` object with the given `id`. +Returns metadata for `FileStorageFolder` POSTs.
@@ -2305,17 +2513,12 @@ Updates a `Candidate` object with the given `id`. ```python from merge import Merge -from merge.resources.ats import PatchedCandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.partial_update( - id="id", - model=PatchedCandidateRequest(), - remote_user_id="remote_user_id", -) +client.filestorage.folders.meta_post_retrieve() ``` @@ -2331,39 +2534,71 @@ client.ats.candidates.partial_update(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**model:** `PatchedCandidateRequest` -
+
+## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
-**remote_user_id:** `str` - +#### 📝 Description + +
+
+ +
+
+ +Create a remote key. +
+
+#### 🔌 Usage +
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### ⚙️ Parameters +
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
+
+ +**name:** `str` — The name of the remote key
@@ -2383,7 +2618,8 @@ client.ats.candidates.partial_update(
-
client.ats.candidates.ignore_create(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -2395,7 +2631,7 @@ client.ats.candidates.partial_update(
-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 list of `Group` objects.
@@ -2411,15 +2647,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.ats import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.ignore_create( - model_id="model_id", - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -2436,7 +2670,7 @@ client.ats.candidates.ignore_create(
-**model_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -2444,7 +2678,7 @@ client.ats.candidates.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -2452,7 +2686,71 @@ client.ats.candidates.ignore_create(
-**message:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — 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). + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -2472,7 +2770,7 @@ client.ats.candidates.ignore_create(
-
client.ats.candidates.meta_patch_retrieve(...) +
client.filestorage.groups.retrieve(...)
@@ -2484,7 +2782,7 @@ client.ats.candidates.ignore_create(
-Returns metadata for `Candidate` PATCHs. +Returns a `Group` object with the given `id`.
@@ -2505,7 +2803,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.meta_patch_retrieve( +client.filestorage.groups.retrieve( id="id", ) @@ -2531,64 +2829,27 @@ client.ats.candidates.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - - -
- -
client.ats.candidates.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
-Returns metadata for `Candidate` POSTs. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.candidates.meta_post_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). +
-#### ⚙️ Parameters - -
-
-
@@ -2604,8 +2865,8 @@ client.ats.candidates.meta_post_retrieve()
-## Ats Scopes -
client.ats.scopes.default_scopes_retrieve() +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -2617,7 +2878,7 @@ client.ats.candidates.meta_post_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). +Gets all issues for Organization.
@@ -2638,7 +2899,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scopes.default_scopes_retrieve() +client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -2654,160 +2917,116 @@ client.ats.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**account_token:** `typing.Optional[str]`
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.ats.scopes.linked_account_scopes_retrieve()
-#### 📝 Description - -
-
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time + +
+
-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). -
-
+**end_user_organization_name:** `typing.Optional[str]` +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.scopes.linked_account_scopes_retrieve() - -``` -
-
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +
-#### ⚙️ Parameters -
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. + +
+
+
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
- - +
+
+**integration_name:** `typing.Optional[str]` +
-
-
client.ats.scopes.linked_account_scopes_create(...)
-#### 📝 Description +**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. + +
+
+
-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) -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + -#### 🔌 Usage -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-```python -from merge import Merge -from merge.resources.ats import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.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, - ) - }, - ), - ], -) - -``` -
-
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + -#### ⚙️ Parameters -
-
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -2827,8 +3046,7 @@ client.ats.scopes.linked_account_scopes_create(
-## Ats DeleteAccount -
client.ats.delete_account.delete() +
client.filestorage.issues.retrieve(...)
@@ -2840,7 +3058,7 @@ client.ats.scopes.linked_account_scopes_create(
-Delete a linked account. +Get a specific issue.
@@ -2861,7 +3079,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.delete_account.delete() +client.filestorage.issues.retrieve( + id="id", +) ``` @@ -2877,6 +3097,14 @@ client.ats.delete_account.delete()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2889,8 +3117,8 @@ client.ats.delete_account.delete()
-## Ats Departments -
client.ats.departments.list(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -2902,7 +3130,7 @@ client.ats.delete_account.delete()
-Returns a list of `Department` objects. +Creates a link token to be used when linking a new end user.
@@ -2918,12 +3146,18 @@ Returns a list of `Department` objects. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.list() +client.filestorage.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], +) ``` @@ -2939,15 +3173,7 @@ client.ats.departments.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. +**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.
@@ -2955,7 +3181,7 @@ client.ats.departments.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -2963,7 +3189,7 @@ client.ats.departments.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_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.
@@ -2971,7 +3197,7 @@ client.ats.departments.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -2979,7 +3205,7 @@ client.ats.departments.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). +**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/.
@@ -2987,7 +3213,7 @@ client.ats.departments.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**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.
@@ -2995,7 +3221,7 @@ client.ats.departments.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -3003,7 +3229,7 @@ client.ats.departments.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -3011,7 +3237,7 @@ client.ats.departments.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**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.
@@ -3019,70 +3245,27 @@ client.ats.departments.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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.
- -
- - - - -
- -
client.ats.departments.retrieve(...) -
-
- -#### 📝 Description - -
-
-Returns a `Department` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.departments.retrieve( - id="id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
+**language:** `typing.Optional[LanguageEnum]` -
-
+The following subset of IETF language tags can be used to configure localization. -**id:** `str` +* `en` - en +* `de` - de
@@ -3090,7 +3273,7 @@ client.ats.departments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -3098,7 +3281,7 @@ client.ats.departments.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). +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -3118,8 +3301,8 @@ client.ats.departments.retrieve(
-## Ats Eeocs -
client.ats.eeocs.list(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -3131,7 +3314,7 @@ client.ats.departments.retrieve(
-Returns a list of `EEOC` objects. +List linked accounts for your organization.
@@ -3152,7 +3335,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.list() +client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -3168,15 +3353,17 @@ client.ats.eeocs.list()
-**candidate_id:** `typing.Optional[str]` — If provided, will only return EEOC info for this candidate. - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -3184,7 +3371,7 @@ client.ats.eeocs.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.
@@ -3192,7 +3379,7 @@ client.ats.eeocs.list()
-**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.
@@ -3200,7 +3387,7 @@ client.ats.eeocs.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -3208,7 +3395,7 @@ client.ats.eeocs.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_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -3216,7 +3403,7 @@ client.ats.eeocs.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_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -3224,7 +3411,7 @@ client.ats.eeocs.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). +**id:** `typing.Optional[str]`
@@ -3232,7 +3419,7 @@ client.ats.eeocs.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after 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.
@@ -3240,7 +3427,7 @@ client.ats.eeocs.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -3248,7 +3435,7 @@ client.ats.eeocs.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -3256,7 +3443,7 @@ client.ats.eeocs.list()
-**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` — 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.
@@ -3264,7 +3451,7 @@ client.ats.eeocs.list()
-**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.
@@ -3272,7 +3459,7 @@ client.ats.eeocs.list()
-**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` — 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`
@@ -3292,7 +3479,8 @@ client.ats.eeocs.list()
-
client.ats.eeocs.retrieve(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -3304,7 +3492,7 @@ client.ats.eeocs.list()
-Returns an `EEOC` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -3320,13 +3508,17 @@ Returns an `EEOC` object with the given `id`. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.retrieve( - id="id", +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -3343,47 +3535,7 @@ client.ats.eeocs.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["candidate"]]` — 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[EeocsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` — 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`
@@ -3403,8 +3555,8 @@ client.ats.eeocs.retrieve(
-## Ats FieldMapping -
client.ats.field_mapping.field_mappings_retrieve(...) +## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
@@ -3416,7 +3568,7 @@ client.ats.eeocs.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/). +Exchange remote keys.
@@ -3437,7 +3589,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_retrieve() +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -3453,7 +3607,7 @@ client.ats.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. +**name:** `str` — The name of the remote key
@@ -3473,7 +3627,8 @@ client.ats.field_mapping.field_mappings_retrieve()
-
client.ats.field_mapping.field_mappings_create(...) +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -3485,7 +3640,7 @@ client.ats.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. +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).
@@ -3506,13 +3661,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_create( - 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.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -3529,47 +3679,7 @@ client.ats.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. - -
-
- -
-
- -**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -3577,7 +3687,7 @@ client.ats.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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -3597,7 +3707,8 @@ client.ats.field_mapping.field_mappings_create(
-
client.ats.field_mapping.field_mappings_destroy(...) +## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
@@ -3609,7 +3720,7 @@ client.ats.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. +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.
@@ -3630,9 +3741,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.filestorage.force_resync.sync_status_resync_create() ``` @@ -3648,14 +3757,6 @@ client.ats.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3668,7 +3769,8 @@ client.ats.field_mapping.field_mappings_destroy(
-
client.ats.field_mapping.field_mappings_partial_update(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -3680,7 +3782,7 @@ client.ats.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 `User` objects.
@@ -3701,8 +3803,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -3719,7 +3821,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -3727,7 +3829,7 @@ client.ats.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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -3735,7 +3837,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -3743,7 +3845,63 @@ client.ats.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. +**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). + +
+
+ +
+
+ +**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -3763,7 +3921,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-
client.ats.field_mapping.remote_fields_retrieve(...) +
client.filestorage.users.retrieve(...)
@@ -3775,7 +3933,7 @@ client.ats.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 a `User` object with the given `id`.
@@ -3796,7 +3954,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.remote_fields_retrieve() +client.filestorage.users.retrieve( + id="id", +) ``` @@ -3812,7 +3972,7 @@ client.ats.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`
@@ -3820,7 +3980,15 @@ client.ats.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. +**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).
@@ -3840,7 +4008,8 @@ client.ats.field_mapping.remote_fields_retrieve()
-
client.ats.field_mapping.target_fields_retrieve() +## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
@@ -3852,7 +4021,7 @@ client.ats.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 `WebhookReceiver` objects.
@@ -3873,7 +4042,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.target_fields_retrieve() +client.filestorage.webhook_receivers.list() ``` @@ -3901,8 +4070,7 @@ client.ats.field_mapping.target_fields_retrieve()
-## Ats GenerateKey -
client.ats.generate_key.create(...) +
client.filestorage.webhook_receivers.create(...)
@@ -3914,7 +4082,7 @@ client.ats.field_mapping.target_fields_retrieve()
-Create a remote key. +Creates a `WebhookReceiver` object with the given values.
@@ -3935,8 +4103,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.generate_key.create( - name="Remote Deployment Key 1", +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -3953,7 +4122,23 @@ client.ats.generate_key.create(
-**name:** `str` — The name of the remote key +**event:** `str` + +
+
+ +
+
+ +**is_active:** `bool` + +
+
+ +
+
+ +**key:** `typing.Optional[str]`
@@ -3973,8 +4158,8 @@ client.ats.generate_key.create(
-## Ats Interviews -
client.ats.interviews.list(...) +## Hris AccountDetails +
client.hris.account_details.retrieve()
@@ -3986,7 +4171,7 @@ client.ats.generate_key.create(
-Returns a list of `ScheduledInterview` objects. +Get details for a linked account.
@@ -4007,7 +4192,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.list() +client.hris.account_details.retrieve() ``` @@ -4023,71 +4208,71 @@ client.ats.interviews.list()
-**application_id:** `typing.Optional[str]` — If provided, will only return interviews for this application. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. -
+
+## Hris AccountToken +
client.hris.account_token.retrieve(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
+#### 📝 Description
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**expand:** `typing.Optional[InterviewsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +Returns the account token for the end user with the provided public token. +
+
+#### 🔌 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/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+#### ⚙️ Parameters +
-**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_id:** `typing.Optional[str]` — If provided, wll only return interviews organized for this job. +**public_token:** `str`
@@ -4095,63 +4280,75 @@ client.ats.interviews.list()
-**job_interview_stage_id:** `typing.Optional[str]` — If provided, will only return interviews at this stage. +**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 AsyncPassthrough +
client.hris.async_passthrough.create(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+#### 📝 Description
-**organizer_id:** `typing.Optional[str]` — If provided, will only return interviews organized by this user. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +Asynchronously pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 Usage +
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +```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", + ), +) + +``` +
+
+#### ⚙️ Parameters +
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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`
@@ -4171,7 +4368,7 @@ client.ats.interviews.list()
-
client.ats.interviews.create(...) +
client.hris.async_passthrough.retrieve(...)
@@ -4183,7 +4380,7 @@ client.ats.interviews.list()
-Creates a `ScheduledInterview` object with the given values. +Retrieves data from earlier async-passthrough POST request
@@ -4199,15 +4396,13 @@ Creates a `ScheduledInterview` object with the given values. ```python from merge import Merge -from merge.resources.ats import ScheduledInterviewRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.create( - model=ScheduledInterviewRequest(), - remote_user_id="remote_user_id", +client.hris.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -4224,31 +4419,7 @@ client.ats.interviews.create(
-**model:** `ScheduledInterviewRequest` - -
-
- -
-
- -**remote_user_id:** `str` - -
-
- -
-
- -**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. +**async_passthrough_receipt_id:** `str`
@@ -4268,7 +4439,8 @@ client.ats.interviews.create(
-
client.ats.interviews.retrieve(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -4280,7 +4452,7 @@ client.ats.interviews.create(
-Returns a `ScheduledInterview` object with the given `id`. +Gets a list of audit trail events.
@@ -4301,8 +4473,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.retrieve( - id="id", +client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -4319,7 +4491,7 @@ client.ats.interviews.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -4327,7 +4499,7 @@ client.ats.interviews.retrieve(
-**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — 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
@@ -4335,7 +4507,7 @@ client.ats.interviews.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`
@@ -4343,7 +4515,7 @@ client.ats.interviews.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.
@@ -4351,7 +4523,7 @@ client.ats.interviews.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -4359,7 +4531,7 @@ client.ats.interviews.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +**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.
@@ -4379,7 +4551,8 @@ client.ats.interviews.retrieve(
-
client.ats.interviews.meta_post_retrieve() +## Hris AvailableActions +
client.hris.available_actions.retrieve()
@@ -4391,7 +4564,7 @@ client.ats.interviews.retrieve(
-Returns metadata for `ScheduledInterview` POSTs. +Returns a list of models and actions available for an account.
@@ -4412,7 +4585,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.meta_post_retrieve() +client.hris.available_actions.retrieve() ``` @@ -4440,8 +4613,8 @@ client.ats.interviews.meta_post_retrieve()
-## Ats Issues -
client.ats.issues.list(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -4453,7 +4626,7 @@ client.ats.interviews.meta_post_retrieve()
-Gets all issues for Organization. +Returns a list of `BankInfo` objects.
@@ -4474,7 +4647,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.issues.list() +client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4490,15 +4665,12 @@ client.ats.issues.list()
-**account_token:** `typing.Optional[str]` - -
-
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]` -
-
+If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') -**cursor:** `typing.Optional[str]` — The pagination cursor value. +* `SAVINGS` - SAVINGS +* `CHECKING` - CHECKING
@@ -4506,7 +4678,7 @@ client.ats.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
@@ -4514,7 +4686,7 @@ client.ats.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -4522,7 +4694,7 @@ client.ats.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -4530,7 +4702,7 @@ client.ats.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -4538,7 +4710,7 @@ client.ats.issues.list()
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee.
@@ -4546,7 +4718,7 @@ client.ats.issues.list()
-**integration_name:** `typing.Optional[str]` +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4554,7 +4726,7 @@ client.ats.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after 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/).
@@ -4562,7 +4734,7 @@ client.ats.issues.list()
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was 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.
@@ -4570,7 +4742,7 @@ client.ats.issues.list()
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**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).
@@ -4578,7 +4750,7 @@ client.ats.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -4586,7 +4758,7 @@ client.ats.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -4594,12 +4766,7 @@ client.ats.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
@@ -4607,70 +4774,31 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - - -
- -
client.ats.issues.retrieve(...) -
-
- -#### 📝 Description
-
-
- -Get a specific issue. -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.issues.retrieve( - id="id", -) - -``` -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**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)
@@ -4690,8 +4818,7 @@ client.ats.issues.retrieve(
-## Ats JobInterviewStages -
client.ats.job_interview_stages.list(...) +
client.hris.bank_info.retrieve(...)
@@ -4703,7 +4830,7 @@ client.ats.issues.retrieve(
-Returns a list of `JobInterviewStage` objects. +Returns a `BankInfo` object with the given `id`.
@@ -4724,7 +4851,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.list() +client.hris.bank_info.retrieve( + id="id", +) ``` @@ -4740,31 +4869,7 @@ client.ats.job_interview_stages.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. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -4772,7 +4877,7 @@ client.ats.job_interview_stages.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[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4796,31 +4901,7 @@ client.ats.job_interview_stages.list()
-**job_id:** `typing.Optional[str]` — If provided, will only return interview stages for this job. - -
-
- -
-
- -**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. +**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
@@ -4828,7 +4909,7 @@ client.ats.job_interview_stages.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**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)
@@ -4848,7 +4929,8 @@ client.ats.job_interview_stages.list()
-
client.ats.job_interview_stages.retrieve(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -4860,7 +4942,7 @@ client.ats.job_interview_stages.list()
-Returns a `JobInterviewStage` object with the given `id`. +Returns a list of `Benefit` objects.
@@ -4881,8 +4963,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.retrieve( - id="id", +client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -4899,101 +4981,15 @@ client.ats.job_interview_stages.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["job"]]` — 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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Ats JobPostings -
client.ats.job_postings.list(...) -
-
- -#### 📝 Description
-
-
- -Returns a list of `JobPosting` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.job_postings.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.
@@ -5001,7 +4997,7 @@ client.ats.job_postings.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.
@@ -5009,7 +5005,7 @@ client.ats.job_postings.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
@@ -5017,7 +5013,7 @@ client.ats.job_postings.list()
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5081,22 +5077,6 @@ client.ats.job_postings.list()
-**status:** `typing.Optional[JobPostingsListRequestStatus]` - -If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') - -* `PUBLISHED` - PUBLISHED -* `CLOSED` - CLOSED -* `DRAFT` - DRAFT -* `INTERNAL` - INTERNAL -* `PENDING` - PENDING - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -5109,7 +5089,7 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-
client.ats.job_postings.retrieve(...) +
client.hris.benefits.retrieve(...)
@@ -5121,7 +5101,7 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-Returns a `JobPosting` object with the given `id`. +Returns a `Benefit` object with the given `id`.
@@ -5142,7 +5122,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.retrieve( +client.hris.benefits.retrieve( id="id", ) @@ -5168,7 +5148,7 @@ client.ats.job_postings.retrieve(
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5204,8 +5184,8 @@ client.ats.job_postings.retrieve(
-## Ats Jobs -
client.ats.jobs.list(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -5217,7 +5197,7 @@ client.ats.job_postings.retrieve(
-Returns a list of `Job` objects. +Returns a list of `Company` objects.
@@ -5238,7 +5218,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.list() +client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -5254,14 +5236,6 @@ client.ats.jobs.list()
-**code:** `typing.Optional[str]` — If provided, will only return jobs with this code. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -5286,7 +5260,7 @@ client.ats.jobs.list()
-**expand:** `typing.Optional[JobsListRequestExpand]` — 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/).
@@ -5294,7 +5268,7 @@ client.ats.jobs.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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5302,7 +5276,7 @@ client.ats.jobs.list()
-**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).
@@ -5310,7 +5284,7 @@ client.ats.jobs.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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -5318,7 +5292,7 @@ client.ats.jobs.list()
-**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.
@@ -5326,7 +5300,7 @@ client.ats.jobs.list()
-**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.
@@ -5334,7 +5308,7 @@ client.ats.jobs.list()
-**offices:** `typing.Optional[str]` — If provided, will only return jobs for this office; multiple offices can be separated by commas. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -5342,31 +5316,70 @@ client.ats.jobs.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + +
+
+ +
client.hris.companies.retrieve(...)
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. - +#### 📝 Description + +
+
+ +
+
+ +Returns a `Company` object with the given `id`. +
+
+#### 🔌 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.companies.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +
+
+ +**id:** `str`
@@ -5374,15 +5387,15 @@ client.ats.jobs.list()
-**status:** `typing.Optional[JobsListRequestStatus]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') +
+
-* `OPEN` - OPEN -* `CLOSED` - CLOSED -* `DRAFT` - DRAFT -* `ARCHIVED` - ARCHIVED -* `PENDING` - PENDING +**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).
@@ -5402,7 +5415,8 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-
client.ats.jobs.retrieve(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -5414,7 +5428,7 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-Returns a `Job` object with the given `id`. +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).
@@ -5435,9 +5449,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.retrieve( - id="id", -) +client.hris.scopes.default_scopes_retrieve() ``` @@ -5453,50 +5465,63 @@ client.ats.jobs.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.hris.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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["status"]]` — Deprecated. Use show_enum_origins. - +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). +
+
+#### 🔌 Usage +
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.scopes.linked_account_scopes_retrieve() + +```
+
+
+ +#### ⚙️ Parameters + +
+
@@ -5513,7 +5538,7 @@ client.ats.jobs.retrieve(
-
client.ats.jobs.screening_questions_list(...) +
client.hris.scopes.linked_account_scopes_create(...)
@@ -5525,7 +5550,7 @@ client.ats.jobs.retrieve(
-Returns a list of `ScreeningQuestion` objects. +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)
@@ -5541,13 +5566,42 @@ Returns a list of `ScreeningQuestion` objects. ```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.ats.jobs.screening_questions_list( - job_id="job_id", +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, + ) + }, + ), + ], ) ``` @@ -5564,7 +5618,7 @@ client.ats.jobs.screening_questions_list(
-**job_id:** `str` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -5572,51 +5626,65 @@ client.ats.jobs.screening_questions_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Hris DeleteAccount +
client.hris.delete_account.delete()
-**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). - +Delete a linked account. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.delete_account.delete() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -5632,8 +5700,8 @@ client.ats.jobs.screening_questions_list(
-## Ats LinkToken -
client.ats.link_token.create(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -5645,7 +5713,7 @@ client.ats.jobs.screening_questions_list(
-Creates a link token to be used when linking a new end user. +Returns a list of `Dependent` objects.
@@ -5661,17 +5729,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ats import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.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.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -5688,7 +5752,7 @@ client.ats.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.
@@ -5696,7 +5760,7 @@ client.ats.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.
@@ -5704,7 +5768,7 @@ client.ats.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.
@@ -5712,7 +5776,7 @@ client.ats.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/).
@@ -5720,7 +5784,7 @@ client.ats.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.
@@ -5728,7 +5792,7 @@ client.ats.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_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -5736,7 +5800,7 @@ client.ats.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. +**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).
@@ -5744,7 +5808,7 @@ client.ats.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_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -5752,7 +5816,7 @@ client.ats.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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -5760,14 +5824,7 @@ client.ats.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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -5775,20 +5832,78 @@ client.ats.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
-The following subset of IETF language tags can be used to configure localization. +
+
-* `en` - en -* `de` - de +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.hris.dependents.retrieve(...)
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +#### 📝 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", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -5796,7 +5911,23 @@ 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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**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).
@@ -5816,8 +5947,8 @@ The following subset of IETF language tags can be used to configure localization
-## Ats LinkedAccounts -
client.ats.linked_accounts.list(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -5829,7 +5960,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `EmployeePayrollRun` objects.
@@ -5850,7 +5981,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.linked_accounts.list() +client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -5866,17 +5999,15 @@ client.ats.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`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -5892,7 +6023,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. +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -5900,7 +6031,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. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
@@ -5908,7 +6039,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. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
@@ -5916,7 +6047,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. +**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5924,7 +6055,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**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/).
@@ -5932,7 +6063,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5940,7 +6071,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**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).
@@ -5948,7 +6079,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -5956,7 +6087,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -5972,7 +6103,31 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. + +
+
+ +
+
+ +**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 employee payroll runs started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -5992,8 +6147,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ats Offers -
client.ats.offers.list(...) +
client.hris.employee_payroll_runs.retrieve(...)
@@ -6005,7 +6159,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Offer` objects. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -6026,7 +6180,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offers.list() +client.hris.employee_payroll_runs.retrieve( + id="id", +) ``` @@ -6042,7 +6198,103 @@ client.ats.offers.list()
-**application_id:** `typing.Optional[str]` — If provided, will only return offers for this application. +**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. + +
+
+ +
+ + + + +
+ +## Hris Employees +
client.hris.employees.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Employee` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -6066,7 +6318,7 @@ client.ats.offers.list()
-**creator_id:** `typing.Optional[str]` — If provided, will only return offers created by this user. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -6074,7 +6326,7 @@ client.ats.offers.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -6082,7 +6334,53 @@ client.ats.offers.list()
-**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` + +If provided, will only return employees with this employment status. + +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE + +
+
+ +
+
+ +**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type. + +
+
+ +
+
+ +**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name. + +
+
+ +
+
+ +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas. + +
+
+ +
+
+ +**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
@@ -6106,7 +6404,7 @@ client.ats.offers.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_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -6114,7 +6412,7 @@ client.ats.offers.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**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).
@@ -6122,7 +6420,7 @@ client.ats.offers.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title.
@@ -6130,7 +6428,7 @@ client.ats.offers.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
@@ -6138,7 +6436,7 @@ client.ats.offers.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
@@ -6146,7 +6444,7 @@ client.ats.offers.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -6154,7 +6452,7 @@ client.ats.offers.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -6162,70 +6460,63 @@ client.ats.offers.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
+
+
+**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group +
-
-
client.ats.offers.retrieve(...)
-#### 📝 Description - -
-
+**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email + +
+
-Returns an `Offer` object with the given `id`. -
-
+**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
-#### 🔌 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.ats.offers.retrieve( - id="id", -) - -``` -
-
+**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) + -#### ⚙️ Parameters -
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. + +
+
+
-**id:** `str` +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -6233,7 +6524,7 @@ client.ats.offers.retrieve(
-**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -6241,7 +6532,7 @@ client.ats.offers.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -6249,7 +6540,7 @@ client.ats.offers.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). +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -6257,7 +6548,7 @@ client.ats.offers.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -6265,7 +6556,7 @@ client.ats.offers.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -6285,8 +6576,7 @@ client.ats.offers.retrieve(
-## Ats Offices -
client.ats.offices.list(...) +
client.hris.employees.create(...)
@@ -6298,7 +6588,7 @@ client.ats.offers.retrieve(
-Returns a list of `Office` objects. +Creates an `Employee` object with the given values.
@@ -6314,12 +6604,15 @@ Returns a list of `Office` objects. ```python from merge import Merge +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.list() +client.hris.employees.create( + model=EmployeeRequest(), +) ``` @@ -6335,63 +6628,7 @@ client.ats.offices.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. - -
-
- -
-
- -**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). - -
-
- -
-
- -**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. +**model:** `EmployeeRequest`
@@ -6399,7 +6636,7 @@ client.ats.offices.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -6407,7 +6644,7 @@ client.ats.offices.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -6427,7 +6664,7 @@ client.ats.offices.list()
-
client.ats.offices.retrieve(...) +
client.hris.employees.retrieve(...)
@@ -6439,7 +6676,7 @@ client.ats.offices.list()
-Returns an `Office` object with the given `id`. +Returns an `Employee` object with the given `id`.
@@ -6460,7 +6697,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.retrieve( +client.hris.employees.retrieve( id="id", ) @@ -6486,6 +6723,14 @@ client.ats.offices.retrieve(
+**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.
@@ -6494,6 +6739,14 @@ client.ats.offices.retrieve(
+**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).
@@ -6502,6 +6755,22 @@ client.ats.offices.retrieve(
+**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -6514,8 +6783,7 @@ client.ats.offices.retrieve(
-## Ats Passthrough -
client.ats.passthrough.create(...) +
client.hris.employees.ignore_create(...)
@@ -6527,7 +6795,7 @@ client.ats.offices.retrieve(
-Pull data from an endpoint not currently supported by Merge. +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.
@@ -6543,17 +6811,15 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum +from merge.resources.hris import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, ) ``` @@ -6570,7 +6836,23 @@ client.ats.passthrough.create(
-**request:** `DataPassthroughRequest` +**model_id:** `str` + +
+
+ +
+
+ +**reason:** `IgnoreCommonModelRequestReason` + +
+
+ +
+
+ +**message:** `typing.Optional[str]`
@@ -6590,8 +6872,7 @@ client.ats.passthrough.create(
-## Ats RegenerateKey -
client.ats.regenerate_key.create(...) +
client.hris.employees.meta_post_retrieve()
@@ -6603,7 +6884,7 @@ client.ats.passthrough.create(
-Exchange remote keys. +Returns metadata for `Employee` POSTs.
@@ -6624,9 +6905,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.hris.employees.meta_post_retrieve() ``` @@ -6642,14 +6921,6 @@ client.ats.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -6662,8 +6933,8 @@ client.ats.regenerate_key.create(
-## Ats RejectReasons -
client.ats.reject_reasons.list(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -6675,7 +6946,7 @@ client.ats.regenerate_key.create(
-Returns a list of `RejectReason` objects. +Returns a list of `EmployerBenefit` objects.
@@ -6696,7 +6967,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.list() +client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6804,7 +7077,7 @@ client.ats.reject_reasons.list()
-
client.ats.reject_reasons.retrieve(...) +
client.hris.employer_benefits.retrieve(...)
@@ -6816,7 +7089,7 @@ client.ats.reject_reasons.list()
-Returns a `RejectReason` object with the given `id`. +Returns an `EmployerBenefit` object with the given `id`.
@@ -6837,7 +7110,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.retrieve( +client.hris.employer_benefits.retrieve( id="id", ) @@ -6891,8 +7164,8 @@ client.ats.reject_reasons.retrieve(
-## Ats Scorecards -
client.ats.scorecards.list(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -6904,7 +7177,7 @@ client.ats.reject_reasons.retrieve(
-Returns a list of `Scorecard` objects. +Returns a list of `Employment` objects.
@@ -6925,7 +7198,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.list() +client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6941,7 +7216,7 @@ client.ats.scorecards.list()
-**application_id:** `typing.Optional[str]` — If provided, will only return scorecards for this application. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -6949,7 +7224,7 @@ client.ats.scorecards.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.
@@ -6957,7 +7232,7 @@ client.ats.scorecards.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.
@@ -6965,7 +7240,7 @@ client.ats.scorecards.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -6973,7 +7248,7 @@ client.ats.scorecards.list()
-**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7005,15 +7280,7 @@ client.ats.scorecards.list()
-**interview_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interview. - -
-
- -
-
- -**interviewer_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interviewer. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -7021,7 +7288,7 @@ client.ats.scorecards.list()
-**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.
@@ -7029,7 +7296,7 @@ client.ats.scorecards.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
@@ -7045,7 +7312,7 @@ client.ats.scorecards.list()
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -7061,7 +7328,7 @@ client.ats.scorecards.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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) +**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)
@@ -7081,7 +7348,7 @@ client.ats.scorecards.list()
-
client.ats.scorecards.retrieve(...) +
client.hris.employments.retrieve(...)
@@ -7093,7 +7360,7 @@ client.ats.scorecards.list()
-Returns a `Scorecard` object with the given `id`. +Returns an `Employment` object with the given `id`.
@@ -7114,7 +7381,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.retrieve( +client.hris.employments.retrieve( id="id", ) @@ -7140,7 +7407,7 @@ client.ats.scorecards.retrieve(
-**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7164,7 +7431,7 @@ client.ats.scorecards.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -7172,7 +7439,7 @@ client.ats.scorecards.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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) +**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)
@@ -7192,8 +7459,8 @@ client.ats.scorecards.retrieve(
-## Ats SyncStatus -
client.ats.sync_status.list(...) +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -7205,7 +7472,7 @@ client.ats.scorecards.retrieve(
-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 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/).
@@ -7226,7 +7493,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.sync_status.list() +client.hris.field_mapping.field_mappings_retrieve() ``` @@ -7242,15 +7509,7 @@ client.ats.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -7270,8 +7529,7 @@ client.ats.sync_status.list()
-## Ats ForceResync -
client.ats.force_resync.sync_status_resync_create() +
client.hris.field_mapping.field_mappings_create(...)
@@ -7283,7 +7541,7 @@ client.ats.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 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.
@@ -7304,7 +7562,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.force_resync.sync_status_resync_create() +client.hris.field_mapping.field_mappings_create( + 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", +) ``` @@ -7320,6 +7585,62 @@ client.ats.force_resync.sync_status_resync_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. + +
+
+ +
+
+ +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**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.
@@ -7332,8 +7653,7 @@ client.ats.force_resync.sync_status_resync_create()
-## Ats Tags -
client.ats.tags.list(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -7345,7 +7665,7 @@ client.ats.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +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.
@@ -7366,7 +7686,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.tags.list() +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -7382,7 +7704,7 @@ client.ats.tags.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**field_mapping_id:** `str`
@@ -7390,47 +7712,70 @@ client.ats.tags.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. -
+
+
client.hris.field_mapping.field_mappings_partial_update(...)
-**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. - +
+
+ +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. +
+
+#### 🔌 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.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**field_mapping_id:** `str`
@@ -7438,7 +7783,7 @@ client.ats.tags.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -7446,7 +7791,7 @@ client.ats.tags.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -7454,7 +7799,7 @@ client.ats.tags.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -7474,8 +7819,7 @@ client.ats.tags.list()
-## Ats Users -
client.ats.users.list(...) +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -7487,7 +7831,7 @@ client.ats.tags.list()
-Returns a list of `RemoteUser` objects. +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/).
@@ -7508,7 +7852,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.list() +client.hris.field_mapping.remote_fields_retrieve() ``` @@ -7524,7 +7868,7 @@ client.ats.users.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -7532,7 +7876,7 @@ client.ats.users.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**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.
@@ -7540,87 +7884,132 @@ client.ats.users.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**email:** `typing.Optional[str]` — If provided, will only return remote users with the given email address -
+
+
client.hris.field_mapping.target_fields_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. - +
+
+ +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/). +
+
+#### 🔌 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.hris.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**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. -
+
+## Hris GenerateKey +
client.hris.generate_key.create(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+#### 📝 Description
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. - +
+
+ +Create a remote key.
+
+
+ +#### 🔌 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.generate_key.create( + name="Remote Deployment Key 1", +) + +```
+
+
+ +#### ⚙️ Parameters
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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) +
+
+ +**name:** `str` — The name of the remote key
@@ -7640,7 +8029,8 @@ client.ats.users.list()
-
client.ats.users.retrieve(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -7652,7 +8042,7 @@ client.ats.users.list()
-Returns a `RemoteUser` object with the given `id`. +Returns a list of `Group` objects.
@@ -7673,8 +8063,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.retrieve( - id="id", +client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -7691,7 +8081,7 @@ client.ats.users.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -7699,7 +8089,7 @@ client.ats.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -7707,7 +8097,7 @@ client.ats.users.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). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -7715,7 +8105,7 @@ client.ats.users.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. +**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/).
@@ -7723,7 +8113,7 @@ client.ats.users.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -7731,133 +8121,63 @@ client.ats.users.retrieve(
-**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).
- -
- - - - -
- -## Ats WebhookReceivers -
client.ats.webhook_receivers.list() -
-
- -#### 📝 Description
-
-
- -Returns a list of `WebhookReceiver` objects. -
-
+**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. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.webhook_receivers.list() - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**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.ats.webhook_receivers.create(...)
-#### 📝 Description - -
-
+**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. + +
+
-Creates a `WebhookReceiver` object with the given values. -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.webhook_receivers.create( - event="event", - is_active=True, -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
-
-
- -**event:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -7865,7 +8185,7 @@ client.ats.webhook_receivers.create(
-**is_active:** `bool` +**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)
@@ -7873,7 +8193,7 @@ client.ats.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -7893,8 +8213,7 @@ client.ats.webhook_receivers.create(
-## Crm AccountDetails -
client.crm.account_details.retrieve() +
client.hris.groups.retrieve(...)
@@ -7906,7 +8225,7 @@ client.ats.webhook_receivers.create(
-Get details for a linked account. +Returns a `Group` object with the given `id`.
@@ -7927,7 +8246,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.hris.groups.retrieve( + id="id", +) ``` @@ -7943,71 +8264,39 @@ client.crm.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
-## Crm AccountToken -
client.crm.account_token.retrieve(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns the account token for the end user with the provided public token. -
-
+**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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**public_token:** `str` +**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)
@@ -8027,8 +8316,8 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -8040,7 +8329,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Gets all issues for Organization.
@@ -8061,7 +8350,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list() +client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8077,7 +8368,7 @@ client.crm.accounts.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**account_token:** `typing.Optional[str]`
@@ -8085,7 +8376,7 @@ client.crm.accounts.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.
@@ -8093,7 +8384,7 @@ client.crm.accounts.list()
-**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
@@ -8101,7 +8392,7 @@ client.crm.accounts.list()
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `typing.Optional[str]`
@@ -8109,7 +8400,7 @@ client.crm.accounts.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/). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -8117,7 +8408,7 @@ client.crm.accounts.list()
-**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.
@@ -8125,7 +8416,7 @@ client.crm.accounts.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -8133,7 +8424,7 @@ client.crm.accounts.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). +**integration_name:** `typing.Optional[str]`
@@ -8141,7 +8432,7 @@ client.crm.accounts.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after 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.
@@ -8149,7 +8440,7 @@ client.crm.accounts.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before 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.
@@ -8157,7 +8448,7 @@ client.crm.accounts.list()
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -8165,7 +8456,7 @@ client.crm.accounts.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8173,7 +8464,7 @@ client.crm.accounts.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -8181,7 +8472,12 @@ client.crm.accounts.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -8201,7 +8497,7 @@ client.crm.accounts.list()
-
client.crm.accounts.create(...) +
client.hris.issues.retrieve(...)
@@ -8213,7 +8509,7 @@ client.crm.accounts.list()
-Creates an `Account` object with the given values. +Get a specific issue.
@@ -8229,14 +8525,13 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( - model=AccountRequest(), +client.hris.issues.retrieve( + id="id", ) ``` @@ -8253,23 +8548,7 @@ client.crm.accounts.create(
-**model:** `AccountRequest` - -
-
- -
-
- -**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`
@@ -8289,7 +8568,8 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -8301,7 +8581,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -8317,13 +8597,17 @@ Returns an `Account` object with the given `id`. ```python from merge import Merge +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( - id="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], ) ``` @@ -8340,7 +8624,7 @@ client.crm.accounts.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.
@@ -8348,7 +8632,7 @@ client.crm.accounts.retrieve(
-**expand:** `typing.Optional[typing.Literal["owner"]]` — 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.
@@ -8356,7 +8640,7 @@ client.crm.accounts.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.
@@ -8364,7 +8648,7 @@ client.crm.accounts.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -8372,7 +8656,7 @@ client.crm.accounts.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). +**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/.
@@ -8380,72 +8664,46 @@ client.crm.accounts.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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.
- -
- - - - -
-
client.crm.accounts.partial_update(...)
-#### 📝 Description - -
-
+**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. + +
+
-Updates an `Account` object with the given `id`. -
-
+**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. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.crm import PatchedAccountRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.accounts.partial_update( - id="id", - model=PatchedAccountRequest(), -) - -``` -
-
+**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. +
-#### ⚙️ Parameters -
-
-
- -**id:** `str` +**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.
@@ -8453,7 +8711,12 @@ client.crm.accounts.partial_update(
-**model:** `PatchedAccountRequest` +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -8461,7 +8724,7 @@ client.crm.accounts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -8469,7 +8732,7 @@ client.crm.accounts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -8489,7 +8752,8 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -8501,7 +8765,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +List linked accounts for your organization.
@@ -8522,8 +8786,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", +client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8540,7 +8804,17 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` +**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
@@ -8548,64 +8822,99 @@ client.crm.accounts.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.accounts.meta_post_retrieve()
-#### 📝 Description +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. + +
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + +
+
+
-Returns metadata for `CRMAccount` POSTs. +**id:** `typing.Optional[str]` +
+ +
+
+ +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +
-#### 🔌 Usage -
+**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. + +
+
+
-```python -from merge import Merge +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.accounts.meta_post_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. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -8621,7 +8930,8 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -8633,7 +8943,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Location` objects.
@@ -8654,7 +8964,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list() +client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8670,6 +8982,22 @@ client.crm.accounts.remote_field_classes_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.
@@ -8694,14 +9022,6 @@ client.crm.accounts.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -8710,15 +9030,12 @@ client.crm.accounts.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` -
-
+If provided, will only return locations with this location_type -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +* `HOME` - HOME +* `WORK` - WORK
@@ -8726,7 +9043,7 @@ client.crm.accounts.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -8734,75 +9051,15 @@ client.crm.accounts.remote_field_classes_list()
-**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.
- -
- - - -
-
- -## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) -
-
- -#### 📝 Description
-
-
- -Asynchronously pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request:** `DataPassthroughRequest` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8810,70 +9067,23 @@ client.crm.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
- -
-
-
- -
client.crm.async_passthrough.retrieve(...)
-#### 📝 Description - -
-
- -
-
- -Retrieves data from earlier async-passthrough POST request -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters - -
-
-
-**async_passthrough_receipt_id:** `str` +**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)
@@ -8893,8 +9103,7 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail -
client.crm.audit_trail.list(...) +
client.hris.locations.retrieve(...)
@@ -8906,7 +9115,7 @@ client.crm.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns a `Location` object with the given `id`.
@@ -8927,7 +9136,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.audit_trail.list() +client.hris.locations.retrieve( + id="id", +) ``` @@ -8943,15 +9154,7 @@ client.crm.audit_trail.list()
-**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 +**id:** `str`
@@ -8959,7 +9162,7 @@ client.crm.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` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8967,7 +9170,7 @@ client.crm.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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).
@@ -8975,7 +9178,7 @@ client.crm.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -8983,7 +9186,7 @@ client.crm.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. +**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)
@@ -9003,8 +9206,8 @@ client.crm.audit_trail.list()
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -9016,7 +9219,7 @@ client.crm.audit_trail.list()
-Returns a list of models and actions available for an account. +Pull data from an endpoint not currently supported by Merge.
@@ -9032,12 +9235,18 @@ Returns a list of models and actions available for an account. ```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.crm.available_actions.retrieve() +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -9053,6 +9262,14 @@ client.crm.available_actions.retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9065,8 +9282,8 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -9078,7 +9295,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +Returns a list of `PayGroup` objects.
@@ -9099,7 +9316,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list() +client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9115,14 +9334,6 @@ client.crm.contacts.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9147,22 +9358,6 @@ client.crm.contacts.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - -
-
- -
-
- -**expand:** `typing.Optional[ContactsListRequestExpand]` — 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/).
@@ -9179,14 +9374,6 @@ client.crm.contacts.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -9219,14 +9406,6 @@ client.crm.contacts.list()
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9247,7 +9426,7 @@ client.crm.contacts.list()
-
client.crm.contacts.create(...) +
client.hris.pay_groups.retrieve(...)
@@ -9259,7 +9438,7 @@ client.crm.contacts.list()
-Creates a `Contact` object with the given values. +Returns a `PayGroup` object with the given `id`.
@@ -9275,14 +9454,13 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.create( - model=ContactRequest(), +client.hris.pay_groups.retrieve( + id="id", ) ``` @@ -9299,7 +9477,7 @@ client.crm.contacts.create(
-**model:** `ContactRequest` +**id:** `str`
@@ -9307,7 +9485,7 @@ client.crm.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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.
@@ -9315,7 +9493,7 @@ client.crm.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -9335,7 +9513,8 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -9347,7 +9526,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns a list of `PayrollRun` objects.
@@ -9368,8 +9547,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", +client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -9386,7 +9565,7 @@ client.crm.contacts.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9394,7 +9573,7 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — 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.
@@ -9402,7 +9581,7 @@ client.crm.contacts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9410,7 +9589,7 @@ client.crm.contacts.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
@@ -9418,7 +9597,7 @@ client.crm.contacts.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). +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
@@ -9426,72 +9605,79 @@ client.crm.contacts.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.contacts.partial_update(...)
-#### 📝 Description +**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. + +
+
+
-Updates a `Contact` object with the given `id`. -
-
+**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. + +
+
+
-```python -from merge import Merge -from merge.resources.crm import PatchedContactRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.partial_update( - id="id", - model=PatchedContactRequest(), -) - -``` -
-
+**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**id:** `str` +**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` + +If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') + +* `REGULAR` - REGULAR +* `OFF_CYCLE` - OFF_CYCLE +* `CORRECTION` - CORRECTION +* `TERMINATION` - TERMINATION +* `SIGN_ON_BONUS` - SIGN_ON_BONUS
@@ -9499,7 +9685,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**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)
@@ -9507,7 +9693,7 @@ client.crm.contacts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
@@ -9515,7 +9701,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime.
@@ -9535,7 +9721,7 @@ client.crm.contacts.partial_update(
-
client.crm.contacts.ignore_create(...) +
client.hris.payroll_runs.retrieve(...)
@@ -9547,7 +9733,7 @@ client.crm.contacts.partial_update(
-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 `PayrollRun` object with the given `id`.
@@ -9563,17 +9749,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), +client.hris.payroll_runs.retrieve( + id="id", ) ``` @@ -9590,7 +9772,7 @@ client.crm.contacts.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -9598,7 +9780,7 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9606,70 +9788,23 @@ client.crm.contacts.ignore_create(
-**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).
- -
- - - - -
- -
client.crm.contacts.meta_patch_retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `CRMContact` PATCHs. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.meta_patch_retrieve( - id="id", -) - -``` -
-
+**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**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)
@@ -9689,7 +9824,8 @@ client.crm.contacts.meta_patch_retrieve(
-
client.crm.contacts.meta_post_retrieve() +## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
@@ -9701,7 +9837,7 @@ client.crm.contacts.meta_patch_retrieve(
-Returns metadata for `CRMContact` POSTs. +Exchange remote keys.
@@ -9722,7 +9858,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_post_retrieve() +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -9738,6 +9876,14 @@ client.crm.contacts.meta_post_retrieve()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9750,7 +9896,8 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -9762,7 +9909,7 @@ client.crm.contacts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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).
@@ -9783,7 +9930,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list() +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9807,7 +9956,7 @@ client.crm.contacts.remote_field_classes_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/). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -9815,51 +9964,65 @@ client.crm.contacts.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. -
+
+## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
-**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). - -
-
+#### 📝 Description
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +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.
+ + + +#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.force_resync.sync_status_resync_create() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -9875,8 +10038,8 @@ client.crm.contacts.remote_field_classes_list()
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +## Hris Teams +
client.hris.teams.list(...)
@@ -9888,7 +10051,7 @@ client.crm.contacts.remote_field_classes_list()
-Returns a list of `CustomObjectClass` objects. +Returns a list of `Team` objects.
@@ -9909,7 +10072,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list() +client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9949,7 +10114,7 @@ client.crm.custom_object_classes.list()
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10005,6 +10170,14 @@ client.crm.custom_object_classes.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.
@@ -10025,7 +10198,7 @@ client.crm.custom_object_classes.list()
-
client.crm.custom_object_classes.retrieve(...) +
client.hris.teams.retrieve(...)
@@ -10037,7 +10210,7 @@ client.crm.custom_object_classes.list()
-Returns a `CustomObjectClass` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -10058,7 +10231,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( +client.hris.teams.retrieve( id="id", ) @@ -10084,7 +10257,7 @@ client.crm.custom_object_classes.retrieve(
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10120,8 +10293,8 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +## Hris TimeOff +
client.hris.time_off.list(...)
@@ -10133,7 +10306,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a list of `TimeOff` objects.
@@ -10154,8 +10327,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_list( - custom_object_class_id="custom_object_class_id", +client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10172,7 +10345,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -10204,7 +10377,31 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. + +
+
+ +
+
+ +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. + +
+
+ +
+
+ +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. + +
+
+ +
+
+ +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10260,6 +10457,14 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -10268,6 +10473,63 @@ client.crm.association_types.custom_object_classes_association_types_list(
+**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. + +
+
+ +
+
+ +**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 + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10280,7 +10542,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +
client.hris.time_off.create(...)
@@ -10292,7 +10554,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Creates a `TimeOff` object with the given values.
@@ -10308,31 +10570,14 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_create( - custom_object_class_id="custom_object_class_id", - model=AssociationTypeRequestRequest( - source_object_class=ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ), - target_object_classes=[ - ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ) - ], - remote_key_name="remote_key_name", - ), +client.hris.time_off.create( + model=TimeOffRequest(), ) ``` @@ -10349,15 +10594,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` +**model:** `TimeOffRequest`
@@ -10393,7 +10630,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +
client.hris.time_off.retrieve(...)
@@ -10405,7 +10642,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Returns a `TimeOff` object with the given `id`.
@@ -10426,8 +10663,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_retrieve( - custom_object_class_id="custom_object_class_id", +client.hris.time_off.retrieve( id="id", ) @@ -10445,7 +10681,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -10453,7 +10689,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**id:** `str` +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10461,7 +10697,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — 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.
@@ -10469,7 +10705,7 @@ client.crm.association_types.custom_object_classes_association_types_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).
@@ -10477,7 +10713,15 @@ client.crm.association_types.custom_object_classes_association_types_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_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)
@@ -10497,7 +10741,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...) +
client.hris.time_off.meta_post_retrieve()
@@ -10509,7 +10753,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-Returns metadata for `CRMAssociationType` POSTs. +Returns metadata for `TimeOff` POSTs.
@@ -10530,9 +10774,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", -) +client.hris.time_off.meta_post_retrieve() ``` @@ -10548,14 +10790,6 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-**custom_object_class_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10568,8 +10802,8 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -10581,7 +10815,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Returns a list of `TimeOffBalance` objects.
@@ -10602,8 +10836,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_list( - custom_object_class_id="custom_object_class_id", +client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10620,14 +10854,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10652,15 +10878,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee.
@@ -10668,7 +10886,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10676,7 +10894,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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_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/).
@@ -10684,7 +10902,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10692,7 +10910,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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).
@@ -10700,7 +10918,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -10708,7 +10926,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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.
@@ -10716,74 +10934,24 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - -
-
- -
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates a `CustomObject` object with the given values. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge -from merge.resources.crm import CustomObjectRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.custom_objects.custom_object_classes_custom_objects_create( - custom_object_class_id="custom_object_class_id", - model=CustomObjectRequest( - fields={"test_field": "hello"}, - ), -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` -
-
+If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') -**custom_object_class_id:** `str` +* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT
@@ -10791,7 +10959,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**model:** `CustomObjectRequest` +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
@@ -10799,7 +10967,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -10807,7 +10975,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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)
@@ -10827,7 +10995,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -10839,7 +11007,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-Returns a `CustomObject` object with the given `id`. +Returns a `TimeOffBalance` object with the given `id`.
@@ -10860,8 +11028,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( - custom_object_class_id="custom_object_class_id", +client.hris.time_off_balances.retrieve( id="id", ) @@ -10879,7 +11046,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -10887,7 +11054,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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.
@@ -10903,7 +11070,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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).
@@ -10911,7 +11078,15 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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_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)
@@ -10931,7 +11106,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -10943,7 +11119,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Returns a list of `TimesheetEntry` objects.
@@ -10964,8 +11140,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", +client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10982,7 +11158,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10990,68 +11166,71 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**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.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-#### 📝 Description +**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. + +
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. + +
+
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. + -#### 🔌 Usage -
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_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/). + -#### ⚙️ Parameters -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-**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).
@@ -11059,7 +11238,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**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/). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -11067,7 +11246,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -11075,7 +11254,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -11083,7 +11262,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**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.
@@ -11091,7 +11270,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -11099,7 +11278,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -11107,7 +11286,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -11127,8 +11306,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +
client.hris.timesheet_entries.create(...)
@@ -11140,7 +11318,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +Creates a `TimesheetEntry` object with the given values.
@@ -11156,14 +11334,14 @@ Returns a list of `Association` objects. ```python from merge import Merge +from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_list( - custom_object_class_id="custom_object_class_id", - object_id="object_id", +client.hris.timesheet_entries.create( + model=TimesheetEntryRequest(), ) ``` @@ -11180,95 +11358,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**object_id:** `str` - -
-
- -
-
- -**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. - -
-
- -
-
- -**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. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["association_type"]]` — 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). - -
-
- -
-
- -**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. +**model:** `TimesheetEntryRequest`
@@ -11276,7 +11366,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -11284,7 +11374,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -11304,7 +11394,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +
client.hris.timesheet_entries.retrieve(...)
@@ -11316,7 +11406,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Returns a `TimesheetEntry` object with the given `id`.
@@ -11337,12 +11427,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_update( - association_type_id="association_type_id", - source_class_id="source_class_id", - source_object_id="source_object_id", - target_class_id="target_class_id", - target_object_id="target_object_id", +client.hris.timesheet_entries.retrieve( + id="id", ) ``` @@ -11359,31 +11445,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**association_type_id:** `str` - -
-
- -
-
- -**source_class_id:** `str` - -
-
- -
-
- -**source_object_id:** `str` - -
-
- -
-
- -**target_class_id:** `str` +**id:** `str`
@@ -11391,7 +11453,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**target_object_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.
@@ -11399,7 +11461,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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.
@@ -11407,7 +11469,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -11427,8 +11489,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -11440,7 +11501,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-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). +Returns metadata for `TimesheetEntry` POSTs.
@@ -11461,7 +11522,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -11489,7 +11550,8 @@ client.crm.scopes.default_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_retrieve() +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -11501,7 +11563,7 @@ client.crm.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 `WebhookReceiver` objects.
@@ -11522,7 +11584,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_retrieve() +client.hris.webhook_receivers.list() ``` @@ -11550,7 +11612,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +
client.hris.webhook_receivers.create(...)
@@ -11562,7 +11624,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-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) +Creates a `WebhookReceiver` object with the given values.
@@ -11578,42 +11640,14 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.crm import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.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, - ) - }, - ), - ], +client.hris.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -11630,7 +11664,23 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**event:** `str` + +
+
+ +
+
+ +**is_active:** `bool` + +
+
+ +
+
+ +**key:** `typing.Optional[str]`
@@ -11650,8 +11700,8 @@ client.crm.scopes.linked_account_scopes_create(
-## Crm DeleteAccount -
client.crm.delete_account.delete() +## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
@@ -11663,7 +11713,7 @@ client.crm.scopes.linked_account_scopes_create(
-Delete a linked account. +Get details for a linked account.
@@ -11684,7 +11734,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.delete_account.delete() +client.ticketing.account_details.retrieve() ``` @@ -11712,8 +11762,8 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +## Ticketing AccountToken +
client.ticketing.account_token.retrieve(...)
@@ -11725,7 +11775,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Returns the account token for the end user with the provided public token.
@@ -11746,7 +11796,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list() +client.ticketing.account_token.retrieve( + public_token="public_token", +) ``` @@ -11762,7 +11814,7 @@ client.crm.engagement_types.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**public_token:** `str`
@@ -11770,15 +11822,71 @@ client.crm.engagement_types.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.
+ +
+ + + + +
+## Ticketing Accounts +
client.ticketing.accounts.list(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Account` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11786,7 +11894,7 @@ client.crm.engagement_types.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/). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -11794,7 +11902,7 @@ client.crm.engagement_types.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -11802,7 +11910,15 @@ client.crm.engagement_types.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -11862,7 +11978,7 @@ client.crm.engagement_types.list()
-
client.crm.engagement_types.retrieve(...) +
client.ticketing.accounts.retrieve(...)
@@ -11874,7 +11990,7 @@ client.crm.engagement_types.list()
-Returns an `EngagementType` object with the given `id`. +Returns an `Account` object with the given `id`.
@@ -11895,7 +12011,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( +client.ticketing.accounts.retrieve( id="id", ) @@ -11929,14 +12045,6 @@ client.crm.engagement_types.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -11957,7 +12065,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
@@ -11969,7 +12078,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -11985,12 +12094,18 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list() +client.ticketing.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -12006,7 +12121,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request:** `DataPassthroughRequest`
@@ -12014,55 +12129,70 @@ client.crm.engagement_types.remote_field_classes_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.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.ticketing.async_passthrough.retrieve(...)
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**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). - -
-
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**async_passthrough_receipt_id:** `str`
@@ -12082,8 +12212,8 @@ client.crm.engagement_types.remote_field_classes_list()
-## Crm Engagements -
client.crm.engagements.list(...) +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -12095,7 +12225,7 @@ client.crm.engagement_types.remote_field_classes_list()
-Returns a list of `Engagement` objects. +Returns a list of `Attachment` objects.
@@ -12116,7 +12246,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list() +client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12156,7 +12288,7 @@ client.crm.engagements.list()
-**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12180,14 +12312,6 @@ client.crm.engagements.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -12220,7 +12344,7 @@ client.crm.engagements.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
@@ -12228,7 +12352,7 @@ client.crm.engagements.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -12236,7 +12360,7 @@ client.crm.engagements.list()
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -12256,7 +12380,7 @@ client.crm.engagements.list()
-
client.crm.engagements.create(...) +
client.ticketing.attachments.create(...)
@@ -12268,7 +12392,7 @@ client.crm.engagements.list()
-Creates an `Engagement` object with the given values. +Creates an `Attachment` object with the given values.
@@ -12284,14 +12408,14 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest +from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( - model=EngagementRequest(), +client.ticketing.attachments.create( + model=AttachmentRequest(), ) ``` @@ -12308,7 +12432,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**model:** `AttachmentRequest`
@@ -12344,7 +12468,7 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +
client.ticketing.attachments.retrieve(...)
@@ -12356,7 +12480,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Returns an `Attachment` object with the given `id`.
@@ -12377,7 +12501,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.retrieve( +client.ticketing.attachments.retrieve( id="id", ) @@ -12403,7 +12527,7 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12419,14 +12543,6 @@ client.crm.engagements.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -12447,7 +12563,7 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +
client.ticketing.attachments.meta_post_retrieve()
@@ -12459,7 +12575,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Returns metadata for `TicketingAttachment` POSTs.
@@ -12475,16 +12591,12 @@ Updates an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.partial_update( - id="id", - model=PatchedEngagementRequest(), -) +client.ticketing.attachments.meta_post_retrieve() ``` @@ -12500,38 +12612,6 @@ client.crm.engagements.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedEngagementRequest` - -
-
- -
-
- -**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.
@@ -12544,7 +12624,8 @@ client.crm.engagements.partial_update(
-
client.crm.engagements.meta_patch_retrieve(...) +## Ticketing AuditTrail +
client.ticketing.audit_trail.list(...)
@@ -12556,7 +12637,7 @@ client.crm.engagements.partial_update(
-Returns metadata for `Engagement` PATCHs. +Gets a list of audit trail events.
@@ -12577,8 +12658,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_patch_retrieve( - id="id", +client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -12595,7 +12676,47 @@ client.crm.engagements.meta_patch_retrieve(
-**id:** `str` +**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 + +
+
+ +
+
+ +**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` + +
+
+ +
+
+ +**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.
@@ -12615,7 +12736,8 @@ client.crm.engagements.meta_patch_retrieve(
-
client.crm.engagements.meta_post_retrieve() +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -12627,7 +12749,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Returns a list of models and actions available for an account.
@@ -12648,7 +12770,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.ticketing.available_actions.retrieve() ``` @@ -12676,7 +12798,8 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +## Ticketing Collections +
client.ticketing.collections.list(...)
@@ -12688,7 +12811,7 @@ client.crm.engagements.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Collection` objects.
@@ -12709,7 +12832,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list() +client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12725,7 +12850,7 @@ client.crm.engagements.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type.
@@ -12733,7 +12858,7 @@ client.crm.engagements.remote_field_classes_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/). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -12741,7 +12866,7 @@ client.crm.engagements.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -12749,7 +12874,7 @@ client.crm.engagements.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12757,7 +12882,7 @@ client.crm.engagements.remote_field_classes_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). +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12765,7 +12890,7 @@ client.crm.engagements.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field 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/).
@@ -12773,7 +12898,7 @@ client.crm.engagements.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12781,7 +12906,7 @@ client.crm.engagements.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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).
@@ -12789,69 +12914,55 @@ client.crm.engagements.remote_field_classes_list()
-**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.
- -
+
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...)
-#### 📝 Description - -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-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/). -
-
+**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.field_mappings_retrieve() - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**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. +**show_enum_origins:** `typing.Optional[typing.Literal["collection_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)
@@ -12871,7 +12982,7 @@ client.crm.field_mapping.field_mappings_retrieve()
-
client.crm.field_mapping.field_mappings_create(...) +
client.ticketing.collections.viewers_list(...)
@@ -12883,7 +12994,7 @@ client.crm.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 list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -12904,13 +13015,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_create( - 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.ticketing.collections.viewers_list( + collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -12927,7 +13034,7 @@ client.crm.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**collection_id:** `str`
@@ -12935,7 +13042,7 @@ client.crm.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12943,7 +13050,7 @@ client.crm.field_mapping.field_mappings_create(
-**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. +**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12951,7 +13058,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**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/).
@@ -12959,7 +13066,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12967,7 +13074,7 @@ client.crm.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_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).
@@ -12975,7 +13082,7 @@ client.crm.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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -12995,7 +13102,7 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +
client.ticketing.collections.retrieve(...)
@@ -13007,7 +13114,7 @@ client.crm.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 `Collection` object with the given `id`.
@@ -13028,8 +13135,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.ticketing.collections.retrieve( + id="id", ) ``` @@ -13046,7 +13153,7 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str`
@@ -13054,70 +13161,15 @@ client.crm.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - -
- -
client.crm.field_mapping.field_mappings_partial_update(...)
-#### 📝 Description - -
-
- -
-
- -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. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**field_mapping_id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13125,7 +13177,7 @@ client.crm.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. +**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).
@@ -13133,7 +13185,7 @@ client.crm.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_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
@@ -13141,7 +13193,7 @@ client.crm.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. +**show_enum_origins:** `typing.Optional[typing.Literal["collection_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)
@@ -13161,7 +13213,8 @@ client.crm.field_mapping.field_mappings_partial_update(
-
client.crm.field_mapping.remote_fields_retrieve(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -13173,7 +13226,7 @@ client.crm.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 a list of `Comment` objects.
@@ -13194,7 +13247,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.remote_fields_retrieve() +client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13210,7 +13265,7 @@ client.crm.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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13218,7 +13273,7 @@ client.crm.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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13226,132 +13281,87 @@ client.crm.field_mapping.remote_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.crm.field_mapping.target_fields_retrieve()
-#### 📝 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/). + +
+
-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/). -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.target_fields_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). +
-#### ⚙️ Parameters -
-
-
- -**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.
-
-
+
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-
-## Crm GenerateKey -
client.crm.generate_key.create(...)
-#### 📝 Description - -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-Create a remote key. -
-
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -13371,8 +13381,7 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +
client.ticketing.comments.create(...)
@@ -13384,7 +13393,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Creates a `Comment` object with the given values.
@@ -13400,12 +13409,15 @@ Gets all issues for Organization. ```python from merge import Merge +from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list() +client.ticketing.comments.create( + model=CommentRequest(), +) ``` @@ -13421,7 +13433,7 @@ client.crm.issues.list()
-**account_token:** `typing.Optional[str]` +**model:** `CommentRequest`
@@ -13429,7 +13441,7 @@ client.crm.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -13437,7 +13449,7 @@ client.crm.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -13445,63 +13457,70 @@ client.crm.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. -
+
+
client.ticketing.comments.retrieve(...)
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
+#### 📝 Description
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
-
-**integration_name:** `typing.Optional[str]` - +Returns a `Comment` object with the given `id`.
+ + + +#### 🔌 Usage
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.comments.retrieve( + id="id", +) + +```
+ + + +#### ⚙️ Parameters
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +
+
+ +**id:** `str`
@@ -13509,7 +13528,7 @@ client.crm.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13517,7 +13536,7 @@ client.crm.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13525,12 +13544,7 @@ client.crm.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**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).
@@ -13550,7 +13564,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.ticketing.comments.meta_post_retrieve()
@@ -13562,7 +13576,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `Comment` POSTs.
@@ -13583,9 +13597,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( - id="id", -) +client.ticketing.comments.meta_post_retrieve() ``` @@ -13601,14 +13613,6 @@ client.crm.issues.retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13621,8 +13625,8 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +## Ticketing Contacts +
client.ticketing.contacts.list(...)
@@ -13634,7 +13638,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Returns a list of `Contact` objects.
@@ -13655,7 +13659,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list() +client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13671,22 +13677,6 @@ client.crm.leads.list()
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. - -
-
- -
-
- -**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13711,15 +13701,7 @@ client.crm.leads.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - -
-
- -
-
- -**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13743,14 +13725,6 @@ client.crm.leads.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -13775,14 +13749,6 @@ client.crm.leads.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13791,14 +13757,6 @@ client.crm.leads.list()
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13819,7 +13777,7 @@ client.crm.leads.list()
-
client.crm.leads.create(...) +
client.ticketing.contacts.create(...)
@@ -13831,7 +13789,7 @@ client.crm.leads.list()
-Creates a `Lead` object with the given values. +Creates a `Contact` object with the given values.
@@ -13847,14 +13805,14 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest +from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - model=LeadRequest(), +client.ticketing.contacts.create( + model=ContactRequest(), ) ``` @@ -13871,7 +13829,7 @@ client.crm.leads.create(
-**model:** `LeadRequest` +**model:** `ContactRequest`
@@ -13907,7 +13865,7 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +
client.ticketing.contacts.retrieve(...)
@@ -13919,7 +13877,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +Returns a `Contact` object with the given `id`.
@@ -13940,7 +13898,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( +client.ticketing.contacts.retrieve( id="id", ) @@ -13966,7 +13924,7 @@ client.crm.leads.retrieve(
-**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13982,14 +13940,6 @@ client.crm.leads.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -14010,7 +13960,7 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +
client.ticketing.contacts.meta_post_retrieve()
@@ -14022,7 +13972,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +Returns metadata for `TicketingContact` POSTs.
@@ -14043,7 +13993,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.ticketing.contacts.meta_post_retrieve() ``` @@ -14071,7 +14021,8 @@ client.crm.leads.meta_post_retrieve()
-
client.crm.leads.remote_field_classes_list(...) +## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
@@ -14083,7 +14034,7 @@ client.crm.leads.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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).
@@ -14104,7 +14055,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list() +client.ticketing.scopes.default_scopes_retrieve() ``` @@ -14120,63 +14071,160 @@ client.crm.leads.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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/). -
+
+
client.ticketing.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +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). +
+
+#### 🔌 Usage +
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.scopes.linked_account_scopes_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**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.
+
+
+ + +
+
+
+ +
client.ticketing.scopes.linked_account_scopes_create(...) +
+
+ +#### 📝 Description
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - +
+
+ +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 +
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +
+
+ +```python +from merge import Merge +from merge.resources.ticketing import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.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. +
+
+ +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -14196,8 +14244,8 @@ client.crm.leads.remote_field_classes_list()
-## Crm LinkToken -
client.crm.link_token.create(...) +## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
@@ -14209,7 +14257,7 @@ client.crm.leads.remote_field_classes_list()
-Creates a link token to be used when linking a new end user. +Delete a linked account.
@@ -14225,18 +14273,12 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.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.ticketing.delete_account.delete() ``` @@ -14252,31 +14294,69 @@ client.crm.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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve(...)
-**end_user_organization_name:** `str` — Your end user's organization. - +#### 📝 Description + +
+
+ +
+
+ +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 +
-**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. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +
+
+ +**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.
@@ -14284,31 +14364,75 @@ client.crm.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/. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ +
+
+
+ +
client.ticketing.field_mapping.field_mappings_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. - +#### 📝 Description + +
+
+ +
+
+ +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. +
+
+#### 🔌 Usage +
-**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. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_create( + 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", +) + +```
+
+
+ +#### ⚙️ Parameters
-**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. +
+
+ +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -14316,7 +14440,7 @@ client.crm.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. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -14324,14 +14448,7 @@ client.crm.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_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.
@@ -14339,12 +14456,15 @@ client.crm.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. + +
+
-The following subset of IETF language tags can be used to configure localization. +
+
-* `en` - en -* `de` - de +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -14352,7 +14472,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. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -14360,7 +14480,7 @@ 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. +**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.
@@ -14380,8 +14500,7 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +
client.ticketing.field_mapping.field_mappings_destroy(...)
@@ -14393,7 +14512,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +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.
@@ -14414,7 +14533,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list() +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -14430,17 +14551,7 @@ client.crm.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 +**field_mapping_id:** `str`
@@ -14448,71 +14559,70 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. -
+
+
client.ticketing.field_mapping.field_mappings_partial_update(...)
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. - -
-
+#### 📝 Description
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. - -
-
-
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +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. +
+
+#### 🔌 Usage +
-**id:** `typing.Optional[str]` - -
-
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ 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. - -
-
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**field_mapping_id:** `str`
@@ -14520,7 +14630,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**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.
@@ -14528,7 +14638,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -14536,7 +14646,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -14556,8 +14666,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +
client.ticketing.field_mapping.remote_fields_retrieve(...)
@@ -14569,7 +14678,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +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/).
@@ -14590,7 +14699,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list() +client.ticketing.field_mapping.remote_fields_retrieve() ``` @@ -14606,7 +14715,7 @@ client.crm.notes.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -14614,7 +14723,7 @@ client.crm.notes.list()
-**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact. +**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.
@@ -14622,111 +14731,132 @@ client.crm.notes.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. -
+
+
client.ticketing.field_mapping.target_fields_retrieve()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
+#### 📝 Description
-**expand:** `typing.Optional[NotesListRequestExpand]` — 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/). - +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/). +
+
+#### 🔌 Usage +
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
+
+ +**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). -
+
+## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. - +Create a remote key. +
+
+#### 🔌 Usage +
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.generate_key.create( + name="Remote Deployment Key 1", +) + +```
+ + + +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**name:** `str` — The name of the remote key
@@ -14746,7 +14876,8 @@ client.crm.notes.list()
-
client.crm.notes.create(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -14758,7 +14889,7 @@ client.crm.notes.list()
-Creates a `Note` object with the given values. +Gets all issues for Organization.
@@ -14774,14 +14905,13 @@ Creates a `Note` object with the given values. ```python from merge import Merge -from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.create( - model=NoteRequest(), +client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -14798,7 +14928,7 @@ client.crm.notes.create(
-**model:** `NoteRequest` +**account_token:** `typing.Optional[str]`
@@ -14806,7 +14936,7 @@ client.crm.notes.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14814,7 +14944,7 @@ client.crm.notes.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -14822,70 +14952,55 @@ client.crm.notes.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.notes.retrieve(...)
-#### 📝 Description - -
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. + +
+
-Returns a `Note` object with the given `id`. -
-
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.notes.retrieve( - id="id", -) - -``` -
-
+**integration_name:** `typing.Optional[str]` +
-#### ⚙️ Parameters -
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. + +
+
+
-**id:** `str` +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -14893,7 +15008,7 @@ client.crm.notes.retrieve(
-**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -14901,7 +15016,7 @@ client.crm.notes.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.
@@ -14909,7 +15024,7 @@ client.crm.notes.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -14917,7 +15032,12 @@ client.crm.notes.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[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -14937,7 +15057,7 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +
client.ticketing.issues.retrieve(...)
@@ -14949,7 +15069,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` POSTs. +Get a specific issue.
@@ -14970,7 +15090,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.ticketing.issues.retrieve( + id="id", +) ``` @@ -14986,6 +15108,14 @@ client.crm.notes.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -14998,7 +15128,8 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +## Ticketing LinkToken +
client.ticketing.link_token.create(...)
@@ -15010,7 +15141,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Creates a link token to be used when linking a new end user.
@@ -15026,12 +15157,18 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list() +client.ticketing.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], +) ``` @@ -15047,7 +15184,7 @@ client.crm.notes.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -15055,7 +15192,7 @@ client.crm.notes.remote_field_classes_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:** `str` — Your end user's organization.
@@ -15063,7 +15200,7 @@ client.crm.notes.remote_field_classes_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:** `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.
@@ -15071,7 +15208,7 @@ client.crm.notes.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -15079,7 +15216,7 @@ client.crm.notes.remote_field_classes_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). +**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/.
@@ -15087,7 +15224,7 @@ client.crm.notes.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**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.
@@ -15095,7 +15232,7 @@ client.crm.notes.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**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.
@@ -15103,7 +15240,7 @@ client.crm.notes.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -15111,61 +15248,90 @@ client.crm.notes.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
+
+
+ +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de +
-
-## Crm Opportunities -
client.crm.opportunities.list(...)
-#### 📝 Description +**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. + +
+
+
-Returns a list of `Opportunity` objects. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +
-#### 🔌 Usage + + +
+ +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
+#### 📝 Description +
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.list() +
+
-``` +List linked accounts for your organization.
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -15173,55 +15339,42 @@ client.crm.opportunities.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) -**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. - -
-
+#### ⚙️ Parameters
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — 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/). - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -15229,7 +15382,7 @@ client.crm.opportunities.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15237,7 +15390,7 @@ client.crm.opportunities.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_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -15245,7 +15398,7 @@ client.crm.opportunities.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -15253,7 +15406,7 @@ client.crm.opportunities.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -15261,7 +15414,7 @@ client.crm.opportunities.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -15269,7 +15422,7 @@ client.crm.opportunities.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `typing.Optional[str]`
@@ -15277,7 +15430,7 @@ client.crm.opportunities.list()
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -15285,7 +15438,7 @@ client.crm.opportunities.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**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.
@@ -15293,7 +15446,7 @@ client.crm.opportunities.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -15301,7 +15454,7 @@ client.crm.opportunities.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -15309,7 +15462,7 @@ client.crm.opportunities.list()
-**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15317,13 +15470,7 @@ client.crm.opportunities.list()
-**status:** `typing.Optional[OpportunitiesListRequestStatus]` - -If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') - -* `OPEN` - OPEN -* `WON` - WON -* `LOST` - LOST +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -15343,7 +15490,8 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -15355,7 +15503,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Pull data from an endpoint not currently supported by Merge.
@@ -15371,14 +15519,17 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( - model=OpportunityRequest(), +client.ticketing.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -15395,23 +15546,7 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` - -
-
- -
-
- -**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:** `DataPassthroughRequest`
@@ -15431,7 +15566,8 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -15443,7 +15579,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` object with the given `id`. +Returns a list of `Project` objects.
@@ -15464,8 +15600,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( - id="id", +client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -15482,7 +15618,7 @@ client.crm.opportunities.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15490,7 +15626,7 @@ client.crm.opportunities.retrieve(
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — 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.
@@ -15498,7 +15634,7 @@ client.crm.opportunities.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15506,7 +15642,15 @@ client.crm.opportunities.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -15522,7 +15666,7 @@ client.crm.opportunities.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15530,7 +15674,23 @@ client.crm.opportunities.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15550,7 +15710,7 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +
client.ticketing.projects.retrieve(...)
@@ -15562,7 +15722,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Returns a `Project` object with the given `id`.
@@ -15578,15 +15738,13 @@ Updates an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.partial_update( +client.ticketing.projects.retrieve( id="id", - model=PatchedOpportunityRequest(), ) ``` @@ -15611,15 +15769,7 @@ client.crm.opportunities.partial_update(
-**model:** `PatchedOpportunityRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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.
@@ -15627,7 +15777,7 @@ client.crm.opportunities.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -15647,7 +15797,7 @@ client.crm.opportunities.partial_update(
-
client.crm.opportunities.meta_patch_retrieve(...) +
client.ticketing.projects.users_list(...)
@@ -15659,7 +15809,7 @@ client.crm.opportunities.partial_update(
-Returns metadata for `Opportunity` PATCHs. +Returns a list of `User` objects.
@@ -15680,8 +15830,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_patch_retrieve( - id="id", +client.ticketing.projects.users_list( + parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -15698,7 +15849,55 @@ client.crm.opportunities.meta_patch_retrieve(
-**id:** `str` +**parent_id:** `str` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — 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). + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15718,7 +15917,8 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +## Ticketing RegenerateKey +
client.ticketing.regenerate_key.create(...)
@@ -15730,7 +15930,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Exchange remote keys.
@@ -15751,7 +15951,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.ticketing.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -15767,6 +15969,14 @@ client.crm.opportunities.meta_post_retrieve()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -15779,7 +15989,8 @@ client.crm.opportunities.meta_post_retrieve()
-
client.crm.opportunities.remote_field_classes_list(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -15791,7 +16002,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Role` objects.
@@ -15812,7 +16023,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list() +client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -15828,6 +16041,22 @@ client.crm.opportunities.remote_field_classes_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.
@@ -15852,7 +16081,7 @@ client.crm.opportunities.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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).
@@ -15860,7 +16089,7 @@ client.crm.opportunities.remote_field_classes_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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15868,7 +16097,7 @@ client.crm.opportunities.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -15876,7 +16105,7 @@ client.crm.opportunities.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15884,7 +16113,7 @@ client.crm.opportunities.remote_field_classes_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.
@@ -15904,8 +16133,7 @@ client.crm.opportunities.remote_field_classes_list()
-## Crm Passthrough -
client.crm.passthrough.create(...) +
client.ticketing.roles.retrieve(...)
@@ -15917,7 +16145,7 @@ client.crm.opportunities.remote_field_classes_list()
-Pull data from an endpoint not currently supported by Merge. +Returns a `Role` object with the given `id`.
@@ -15933,17 +16161,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ticketing.roles.retrieve( + id="id", ) ``` @@ -15960,7 +16184,23 @@ client.crm.passthrough.create(
-**request:** `DataPassthroughRequest` +**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).
@@ -15980,8 +16220,8 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +## Ticketing SyncStatus +
client.ticketing.sync_status.list(...)
@@ -15993,7 +16233,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +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).
@@ -16014,8 +16254,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -16032,7 +16272,15 @@ client.crm.regenerate_key.create(
-**name:** `str` — The name of the remote key +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16052,8 +16300,8 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +## Ticketing ForceResync +
client.ticketing.force_resync.sync_status_resync_create()
@@ -16065,7 +16313,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +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.
@@ -16086,7 +16334,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list() +client.ticketing.force_resync.sync_status_resync_create() ``` @@ -16102,15 +16350,71 @@ client.crm.stages.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.
+ +
+ + + +
+ +## Ticketing Tags +
client.ticketing.tags.list(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Tag` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16118,7 +16422,7 @@ client.crm.stages.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.
@@ -16126,7 +16430,7 @@ client.crm.stages.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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16134,7 +16438,7 @@ client.crm.stages.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/).
@@ -16142,7 +16446,7 @@ client.crm.stages.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16202,7 +16506,7 @@ client.crm.stages.list()
-
client.crm.stages.retrieve(...) +
client.ticketing.tags.retrieve(...)
@@ -16214,7 +16518,7 @@ client.crm.stages.list()
-Returns a `Stage` object with the given `id`. +Returns a `Tag` object with the given `id`.
@@ -16235,7 +16539,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( +client.ticketing.tags.retrieve( id="id", ) @@ -16269,14 +16573,6 @@ client.crm.stages.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -16297,7 +16593,8 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -16309,7 +16606,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Team` objects.
@@ -16330,7 +16627,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list() +client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16346,6 +16645,22 @@ client.crm.stages.remote_field_classes_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.
@@ -16370,7 +16685,7 @@ client.crm.stages.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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).
@@ -16378,7 +16693,7 @@ client.crm.stages.remote_field_classes_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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -16386,7 +16701,7 @@ client.crm.stages.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -16394,7 +16709,7 @@ client.crm.stages.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16402,7 +16717,7 @@ client.crm.stages.remote_field_classes_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.
@@ -16422,8 +16737,7 @@ client.crm.stages.remote_field_classes_list()
-## Crm SyncStatus -
client.crm.sync_status.list(...) +
client.ticketing.teams.retrieve(...)
@@ -16435,7 +16749,7 @@ client.crm.stages.remote_field_classes_list()
-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 a `Team` object with the given `id`.
@@ -16456,7 +16770,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list() +client.ticketing.teams.retrieve( + id="id", +) ``` @@ -16472,7 +16788,7 @@ client.crm.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -16480,7 +16796,15 @@ client.crm.sync_status.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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).
@@ -16500,8 +16824,8 @@ client.crm.sync_status.list()
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -16513,7 +16837,7 @@ client.crm.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. +Returns a list of `Ticket` objects.
@@ -16534,7 +16858,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.force_resync.sync_status_resync_create() +client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16550,69 +16876,71 @@ client.crm.force_resync.sync_status_resync_create()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
- -
+
+
+**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. +
-
-## Crm Tasks -
client.crm.tasks.list(...)
-#### 📝 Description +**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. + +
+
+**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. + +
+
+
-Returns a list of `Task` objects. -
-
+**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. + -#### 🔌 Usage -
+**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.list() - -``` -
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + -#### ⚙️ Parameters -
+**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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16620,7 +16948,7 @@ client.crm.tasks.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
@@ -16628,7 +16956,7 @@ client.crm.tasks.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
@@ -16636,7 +16964,7 @@ client.crm.tasks.list()
-**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16700,6 +17028,53 @@ client.crm.tasks.list()
+**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. + +
+
+ +
+
+ +**priority:** `typing.Optional[TicketsListRequestPriority]` + +If provided, will only return tickets of this priority. + +* `URGENT` - URGENT +* `HIGH` - HIGH +* `NORMAL` - NORMAL +* `LOW` - LOW + +
+
+ +
+
+ +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. + +
+
+ +
+
+ +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16708,6 +17083,62 @@ client.crm.tasks.list()
+**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. + +
+
+ +
+
+ +**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` — 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]` — If provided, will only return tickets of this status. + +
+
+ +
+
+ +**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. + +
+
+ +
+
+ +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. + +
+
+ +
+
+ +**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16720,7 +17151,7 @@ client.crm.tasks.list()
-
client.crm.tasks.create(...) +
client.ticketing.tickets.create(...)
@@ -16732,7 +17163,7 @@ client.crm.tasks.list()
-Creates a `Task` object with the given values. +Creates a `Ticket` object with the given values.
@@ -16748,14 +17179,14 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest +from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - model=TaskRequest(), +client.ticketing.tickets.create( + model=TicketRequest(), ) ``` @@ -16772,7 +17203,7 @@ client.crm.tasks.create(
-**model:** `TaskRequest` +**model:** `TicketRequest`
@@ -16808,7 +17239,7 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +
client.ticketing.tickets.retrieve(...)
@@ -16820,7 +17251,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Returns a `Ticket` object with the given `id`.
@@ -16841,7 +17272,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.retrieve( +client.ticketing.tickets.retrieve( id="id", ) @@ -16867,7 +17298,7 @@ client.crm.tasks.retrieve(
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16899,6 +17330,22 @@ client.crm.tasks.retrieve(
+**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` — 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.
@@ -16911,7 +17358,7 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +
client.ticketing.tickets.partial_update(...)
@@ -16923,7 +17370,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +Updates a `Ticket` object with the given `id`.
@@ -16939,15 +17386,15 @@ Updates a `Task` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedTaskRequest +from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.partial_update( +client.ticketing.tickets.partial_update( id="id", - model=PatchedTaskRequest(), + model=PatchedTicketRequest(), ) ``` @@ -16972,7 +17419,7 @@ client.crm.tasks.partial_update(
-**model:** `PatchedTaskRequest` +**model:** `PatchedTicketRequest`
@@ -17008,7 +17455,7 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +
client.ticketing.tickets.viewers_list(...)
@@ -17020,7 +17467,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -17041,7 +17488,127 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( +client.ticketing.tickets.viewers_list( + ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticket_id:** `str` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — 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). + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +
client.ticketing.tickets.meta_patch_retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Ticket` PATCHs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.meta_patch_retrieve( id="id", ) @@ -17079,7 +17646,7 @@ client.crm.tasks.meta_patch_retrieve(
-
client.crm.tasks.meta_post_retrieve() +
client.ticketing.tickets.meta_post_retrieve(...)
@@ -17091,7 +17658,7 @@ client.crm.tasks.meta_patch_retrieve(
-Returns metadata for `Task` POSTs. +Returns metadata for `Ticket` POSTs.
@@ -17112,7 +17679,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_post_retrieve() +client.ticketing.tickets.meta_post_retrieve() ``` @@ -17128,6 +17695,22 @@ client.crm.tasks.meta_post_retrieve()
+**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. + +
+
+ +
+
+ +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17140,7 +17723,7 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +
client.ticketing.tickets.remote_field_classes_list(...)
@@ -17173,7 +17756,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list() +client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -17197,7 +17782,7 @@ client.crm.tasks.remote_field_classes_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/). +**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list
@@ -17205,7 +17790,7 @@ client.crm.tasks.remote_field_classes_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/).
@@ -17213,7 +17798,7 @@ client.crm.tasks.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17265,8 +17850,8 @@ client.crm.tasks.remote_field_classes_list()
-## Crm Users -
client.crm.users.list(...) +## Ticketing Users +
client.ticketing.users.list(...)
@@ -17299,7 +17884,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list() +client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -17339,7 +17926,7 @@ client.crm.users.list()
-**email:** `typing.Optional[str]` — If provided, will only return users with this email. +**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
@@ -17347,7 +17934,7 @@ client.crm.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/). +**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17355,7 +17942,7 @@ client.crm.users.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/).
@@ -17363,7 +17950,7 @@ client.crm.users.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17411,6 +17998,14 @@ client.crm.users.list()
+**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17423,7 +18018,7 @@ client.crm.users.list()
-
client.crm.users.retrieve(...) +
client.ticketing.users.retrieve(...)
@@ -17456,7 +18051,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( +client.ticketing.users.retrieve( id="id", ) @@ -17482,7 +18077,7 @@ client.crm.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17490,7 +18085,7 @@ client.crm.users.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17518,7 +18113,8 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +## Ticketing WebhookReceivers +
client.ticketing.webhook_receivers.list()
@@ -17530,7 +18126,7 @@ client.crm.users.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 list of `WebhookReceiver` objects.
@@ -17546,18 +18142,12 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), -) +client.ticketing.webhook_receivers.list() ``` @@ -17573,22 +18163,6 @@ client.crm.users.ignore_create(
-**model_id:** `str` - -
-
- -
-
- -**request:** `IgnoreCommonModelRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17601,7 +18175,7 @@ client.crm.users.ignore_create(
-
client.crm.users.remote_field_classes_list(...) +
client.ticketing.webhook_receivers.create(...)
@@ -17613,7 +18187,7 @@ client.crm.users.ignore_create(
-Returns a list of `RemoteFieldClass` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -17634,7 +18208,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list() +client.ticketing.webhook_receivers.create( + event="event", + is_active=True, +) ``` @@ -17650,47 +18227,7 @@ client.crm.users.remote_field_classes_list()
-**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/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**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). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**event:** `str`
@@ -17698,7 +18235,7 @@ client.crm.users.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**is_active:** `bool`
@@ -17706,7 +18243,7 @@ client.crm.users.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**key:** `typing.Optional[str]`
@@ -17726,8 +18263,8 @@ client.crm.users.remote_field_classes_list()
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +## Ats AccountDetails +
client.ats.account_details.retrieve()
@@ -17739,7 +18276,7 @@ client.crm.users.remote_field_classes_list()
-Returns a list of `WebhookReceiver` objects. +Get details for a linked account.
@@ -17760,7 +18297,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.ats.account_details.retrieve() ``` @@ -17788,7 +18325,8 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +## Ats AccountToken +
client.ats.account_token.retrieve(...)
@@ -17800,7 +18338,7 @@ client.crm.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns the account token for the end user with the provided public token.
@@ -17821,9 +18359,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( - event="event", - is_active=True, +client.ats.account_token.retrieve( + public_token="public_token", ) ``` @@ -17840,23 +18377,7 @@ client.crm.webhook_receivers.create(
-**event:** `str` - -
-
- -
-
- -**is_active:** `bool` - -
-
- -
-
- -**key:** `typing.Optional[str]` +**public_token:** `str`
@@ -17876,8 +18397,8 @@ client.crm.webhook_receivers.create(
-## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Ats Activities +
client.ats.activities.list(...)
@@ -17889,7 +18410,7 @@ client.crm.webhook_receivers.create(
-Get details for a linked account. +Returns a list of `Activity` objects.
@@ -17910,7 +18431,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -17926,71 +18449,31 @@ client.filestorage.account_details.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.
- -
- - - - -
- -## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) -
-
- -#### 📝 Description
-
-
- -Returns the account token for the end user with the provided public token. -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters - -
-
-
-**public_token:** `str` +**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17998,75 +18481,31 @@ client.filestorage.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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/).
-
-
- - -
-
-
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...)
-#### 📝 Description - -
-
- -
-
- -Asynchronously pull data from an endpoint not currently supported by Merge. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**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). +
-#### ⚙️ Parameters - -
-
-
-**request:** `DataPassthroughRequest` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -18074,70 +18513,47 @@ client.filestorage.async_passthrough.create(
-**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.
-
-
+
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-
-
client.filestorage.async_passthrough.retrieve(...)
-#### 📝 Description - -
-
+**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
-Retrieves data from earlier async-passthrough POST request -
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` — 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 - -
-
-
-**async_passthrough_receipt_id:** `str` +**user_id:** `typing.Optional[str]` — If provided, will only return activities done by this user.
@@ -18157,8 +18573,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.ats.activities.create(...)
@@ -18170,7 +18585,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Creates an `Activity` object with the given values.
@@ -18186,12 +18601,16 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.ats import ActivityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list() +client.ats.activities.create( + model=ActivityRequest(), + remote_user_id="remote_user_id", +) ``` @@ -18207,23 +18626,7 @@ client.filestorage.audit_trail.list()
-**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 - -
-
- -
-
- -**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` +**model:** `ActivityRequest`
@@ -18231,7 +18634,7 @@ client.filestorage.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_user_id:** `str`
@@ -18239,7 +18642,7 @@ client.filestorage.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18247,7 +18650,7 @@ client.filestorage.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. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18267,8 +18670,7 @@ client.filestorage.audit_trail.list()
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +
client.ats.activities.retrieve(...)
@@ -18280,7 +18682,7 @@ client.filestorage.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns an `Activity` object with the given `id`.
@@ -18301,7 +18703,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.ats.activities.retrieve( + id="id", +) ``` @@ -18317,65 +18721,51 @@ client.filestorage.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_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 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). -
-
+**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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.default_scopes_retrieve() - -``` -
-
+**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
+**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` — 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) + +
+
+
@@ -18391,7 +18781,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +
client.ats.activities.meta_post_retrieve()
@@ -18403,7 +18793,7 @@ client.filestorage.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 metadata for `Activity` POSTs.
@@ -18424,7 +18814,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_retrieve() +client.ats.activities.meta_post_retrieve() ``` @@ -18452,7 +18842,8 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_create(...) +## Ats Applications +
client.ats.applications.list(...)
@@ -18464,7 +18855,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-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) +Returns a list of `Application` objects.
@@ -18480,42 +18871,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.filestorage import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.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, - ) - }, - ), - ], +client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -18532,7 +18894,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**candidate_id:** `typing.Optional[str]` — If provided, will only return applications for this candidate.
@@ -18540,131 +18902,47 @@ client.filestorage.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Filestorage DeleteAccount -
client.filestorage.delete_account.delete() -
-
- -#### 📝 Description - -
-
-Delete a linked account. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.delete_account.delete() - -``` -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### ⚙️ Parameters -
-
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**credited_to_id:** `typing.Optional[str]` — If provided, will only return applications credited to this user.
-
-
- - -
-
-
- -## Filestorage Drives -
client.filestorage.drives.list(...) -
-
- -#### 📝 Description - -
-
-Returns a list of `Drive` objects. -
-
+**current_stage_id:** `typing.Optional[str]` — If provided, will only return applications at this interview stage. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.drives.list() - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters -
-
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**expand:** `typing.Optional[ApplicationsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18672,7 +18950,7 @@ client.filestorage.drives.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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/).
@@ -18680,7 +18958,7 @@ client.filestorage.drives.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.
@@ -18688,7 +18966,7 @@ client.filestorage.drives.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_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).
@@ -18696,7 +18974,7 @@ client.filestorage.drives.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**job_id:** `typing.Optional[str]` — If provided, will only return applications for this job.
@@ -18704,7 +18982,7 @@ client.filestorage.drives.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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -18712,7 +18990,7 @@ client.filestorage.drives.list()
-**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.
@@ -18720,7 +18998,7 @@ client.filestorage.drives.list()
-**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.
@@ -18728,7 +19006,7 @@ client.filestorage.drives.list()
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**reject_reason_id:** `typing.Optional[str]` — If provided, will only return applications with this reject reason.
@@ -18736,7 +19014,7 @@ client.filestorage.drives.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.
@@ -18744,7 +19022,7 @@ client.filestorage.drives.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**source:** `typing.Optional[str]` — If provided, will only return applications with this source.
@@ -18764,7 +19042,7 @@ client.filestorage.drives.list()
-
client.filestorage.drives.retrieve(...) +
client.ats.applications.create(...)
@@ -18776,7 +19054,10 @@ client.filestorage.drives.list()
-Returns a `Drive` object with the given `id`. +Creates an `Application` object with the given values. +For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. + +See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration.
@@ -18792,13 +19073,15 @@ Returns a `Drive` object with the given `id`. ```python from merge import Merge +from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( - id="id", +client.ats.applications.create( + model=ApplicationRequest(), + remote_user_id="remote_user_id", ) ``` @@ -18815,7 +19098,7 @@ client.filestorage.drives.retrieve(
-**id:** `str` +**model:** `ApplicationRequest`
@@ -18823,7 +19106,7 @@ client.filestorage.drives.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_user_id:** `str`
@@ -18831,7 +19114,15 @@ client.filestorage.drives.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). +**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.
@@ -18851,8 +19142,7 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +
client.ats.applications.retrieve(...)
@@ -18864,7 +19154,7 @@ client.filestorage.drives.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/). +Returns an `Application` object with the given `id`.
@@ -18885,7 +19175,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve() +client.ats.applications.retrieve( + id="id", +) ``` @@ -18901,7 +19193,31 @@ client.filestorage.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. +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — 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).
@@ -18921,7 +19237,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-
client.filestorage.field_mapping.field_mappings_create(...) +
client.ats.applications.change_stage_create(...)
@@ -18933,7 +19249,7 @@ client.filestorage.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. +Updates the `current_stage` field of an `Application` object
@@ -18954,13 +19270,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - 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.ats.applications.change_stage_create( + id="id", ) ``` @@ -18977,23 +19288,7 @@ client.filestorage.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. +**id:** `str`
@@ -19001,7 +19296,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -19009,7 +19304,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -19017,7 +19312,7 @@ client.filestorage.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. +**job_interview_stage:** `typing.Optional[str]` — The interview stage to move the application to.
@@ -19025,7 +19320,7 @@ client.filestorage.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. +**remote_user_id:** `typing.Optional[str]`
@@ -19045,7 +19340,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
client.filestorage.field_mapping.field_mappings_destroy(...) +
client.ats.applications.meta_post_retrieve(...)
@@ -19057,7 +19352,7 @@ client.filestorage.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 `Application` POSTs.
@@ -19078,9 +19373,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ats.applications.meta_post_retrieve() ``` @@ -19096,7 +19389,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**application_remote_template_id:** `typing.Optional[str]` — The template ID associated with the nested application in the request.
@@ -19116,7 +19409,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +## Ats AsyncPassthrough +
client.ats.async_passthrough.create(...)
@@ -19128,7 +19422,7 @@ client.filestorage.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. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -19144,13 +19438,17 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.ats.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -19167,7 +19465,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**request:** `DataPassthroughRequest`
@@ -19175,23 +19473,70 @@ client.filestorage.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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.ats.async_passthrough.retrieve(...)
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. - +#### 📝 Description + +
+
+ +
+
+ +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**remote_url_path:** `typing.Optional[str]` — The path 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.ats.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**async_passthrough_receipt_id:** `str`
@@ -19211,7 +19556,8 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
client.filestorage.field_mapping.remote_fields_retrieve(...) +## Ats Attachments +
client.ats.attachments.list(...)
@@ -19223,7 +19569,7 @@ client.filestorage.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 a list of `Attachment` objects.
@@ -19244,7 +19590,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.remote_fields_retrieve() +client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19260,7 +19608,7 @@ client.filestorage.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. +**candidate_id:** `typing.Optional[str]` — If provided, will only return attachments for this candidate.
@@ -19268,7 +19616,7 @@ client.filestorage.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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -19276,64 +19624,99 @@ client.filestorage.field_mapping.remote_fields_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. +
+
+
+**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.filestorage.field_mapping.target_fields_retrieve()
-#### 📝 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. + +
+
+
-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/). +**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. +
-#### 🔌 Usage -
+**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 +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.target_fields_retrieve() +
+
-``` +**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins. +
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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) + +
+
+
@@ -19349,8 +19732,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +
client.ats.attachments.create(...)
@@ -19362,7 +19744,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Creates an `Attachment` object with the given values.
@@ -19378,12 +19760,16 @@ Returns a list of `File` objects. ```python from merge import Merge +from merge.resources.ats import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list() +client.ats.attachments.create( + model=AttachmentRequest(), + remote_user_id="remote_user_id", +) ``` @@ -19399,7 +19785,7 @@ client.filestorage.files.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**model:** `AttachmentRequest`
@@ -19407,7 +19793,7 @@ client.filestorage.files.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_user_id:** `str`
@@ -19415,7 +19801,7 @@ client.filestorage.files.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -19423,7 +19809,7 @@ client.filestorage.files.list()
-**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -19431,55 +19817,70 @@ client.filestorage.files.list()
-**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. -
+
+
client.ats.attachments.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). - +Returns an `Attachment` object with the given `id`. +
+
+#### 🔌 Usage +
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.attachments.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**id:** `str`
@@ -19487,7 +19888,7 @@ client.filestorage.files.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19495,7 +19896,7 @@ client.filestorage.files.list()
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19503,7 +19904,7 @@ client.filestorage.files.list()
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**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).
@@ -19511,7 +19912,7 @@ client.filestorage.files.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
@@ -19519,7 +19920,7 @@ client.filestorage.files.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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)
@@ -19539,7 +19940,7 @@ client.filestorage.files.list()
-
client.filestorage.files.create(...) +
client.ats.attachments.meta_post_retrieve()
@@ -19551,7 +19952,7 @@ client.filestorage.files.list()
-Creates a `File` object with the given values. +Returns metadata for `Attachment` POSTs.
@@ -19567,15 +19968,12 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( - model=FileRequest(), -) +client.ats.attachments.meta_post_retrieve() ``` @@ -19591,30 +19989,6 @@ client.filestorage.files.create(
-**model:** `FileRequest` - -
-
- -
-
- -**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.
@@ -19627,7 +20001,8 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +## Ats AuditTrail +
client.ats.audit_trail.list(...)
@@ -19639,7 +20014,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Gets a list of audit trail events.
@@ -19660,8 +20035,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( - id="id", +client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -19678,7 +20053,7 @@ client.filestorage.files.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19686,7 +20061,7 @@ client.filestorage.files.retrieve(
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — 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
@@ -19694,7 +20069,7 @@ client.filestorage.files.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`
@@ -19702,7 +20077,23 @@ client.filestorage.files.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.
@@ -19722,7 +20113,8 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +## Ats AvailableActions +
client.ats.available_actions.retrieve()
@@ -19734,7 +20126,7 @@ client.filestorage.files.retrieve(
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns a list of models and actions available for an account.
@@ -19755,9 +20147,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( - id="id", -) +client.ats.available_actions.retrieve() ``` @@ -19773,22 +20163,6 @@ client.filestorage.files.download_request_meta_retrieve(
-**id:** `str` - -
-
- -
-
- -**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19801,7 +20175,8 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +## Ats Candidates +
client.ats.candidates.list(...)
@@ -19813,7 +20188,7 @@ client.filestorage.files.download_request_meta_retrieve(
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a list of `Candidate` objects.
@@ -19834,7 +20209,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list() +client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19850,7 +20227,7 @@ client.filestorage.files.download_request_meta_list()
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -19858,7 +20235,7 @@ client.filestorage.files.download_request_meta_list()
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -19874,6 +20251,30 @@ client.filestorage.files.download_request_meta_list()
+**email_addresses:** `typing.Optional[str]` — If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. + +
+
+ +
+
+ +**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**first_name:** `typing.Optional[str]` — If provided, will only return candidates with this first 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/).
@@ -19882,7 +20283,7 @@ client.filestorage.files.download_request_meta_list()
-**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19890,7 +20291,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified 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).
@@ -19898,7 +20299,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +**last_name:** `typing.Optional[str]` — If provided, will only return candidates with this last name.
@@ -19906,7 +20307,15 @@ client.filestorage.files.download_request_meta_list()
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**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.
@@ -19922,6 +20331,22 @@ client.filestorage.files.download_request_meta_list()
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**tags:** `typing.Optional[str]` — If provided, will only return candidates with these tags; multiple tags can be separated by commas. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19934,7 +20359,7 @@ client.filestorage.files.download_request_meta_list()
-
client.filestorage.files.meta_post_retrieve() +
client.ats.candidates.create(...)
@@ -19946,7 +20371,7 @@ client.filestorage.files.download_request_meta_list()
-Returns metadata for `FileStorageFile` POSTs. +Creates a `Candidate` object with the given values.
@@ -19962,12 +20387,16 @@ Returns metadata for `FileStorageFile` POSTs. ```python from merge import Merge +from merge.resources.ats import CandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.ats.candidates.create( + model=CandidateRequest(), + remote_user_id="remote_user_id", +) ``` @@ -19983,6 +20412,38 @@ client.filestorage.files.meta_post_retrieve()
+**model:** `CandidateRequest` + +
+
+ +
+
+ +**remote_user_id:** `str` + +
+
+ +
+
+ +**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.
@@ -19995,8 +20456,7 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +
client.ats.candidates.retrieve(...)
@@ -20008,7 +20468,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a `Candidate` object with the given `id`.
@@ -20029,7 +20489,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list() +client.ats.candidates.retrieve( + id="id", +) ``` @@ -20045,7 +20507,7 @@ client.filestorage.folders.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -20053,7 +20515,7 @@ client.filestorage.folders.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20061,7 +20523,7 @@ client.filestorage.folders.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.
@@ -20069,7 +20531,7 @@ client.filestorage.folders.list()
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**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).
@@ -20077,47 +20539,73 @@ client.filestorage.folders.list()
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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/). -
+
+
client.ats.candidates.partial_update(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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). - +
+
+ +Updates a `Candidate` object with the given `id`. +
+
+#### 🔌 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 +from merge.resources.ats import PatchedCandidateRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.candidates.partial_update( + id="id", + model=PatchedCandidateRequest(), + remote_user_id="remote_user_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**id:** `str`
@@ -20125,7 +20613,7 @@ client.filestorage.folders.list()
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. +**model:** `PatchedCandidateRequest`
@@ -20133,7 +20621,7 @@ client.filestorage.folders.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_user_id:** `str`
@@ -20141,7 +20629,7 @@ client.filestorage.folders.list()
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -20149,7 +20637,7 @@ client.filestorage.folders.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -20169,7 +20657,7 @@ client.filestorage.folders.list()
-
client.filestorage.folders.create(...) +
client.ats.candidates.ignore_create(...)
@@ -20181,7 +20669,7 @@ client.filestorage.folders.list()
-Creates a `Folder` object with the given values. +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.
@@ -20197,14 +20685,15 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest +from merge.resources.ats import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - model=FolderRequest(), +client.ats.candidates.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, ) ``` @@ -20221,7 +20710,7 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**model_id:** `str`
@@ -20229,7 +20718,7 @@ client.filestorage.folders.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**reason:** `IgnoreCommonModelRequestReason`
@@ -20237,7 +20726,7 @@ client.filestorage.folders.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**message:** `typing.Optional[str]`
@@ -20257,7 +20746,7 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +
client.ats.candidates.meta_patch_retrieve(...)
@@ -20269,7 +20758,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns metadata for `Candidate` PATCHs.
@@ -20290,7 +20779,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( +client.ats.candidates.meta_patch_retrieve( id="id", ) @@ -20316,26 +20805,125 @@ client.filestorage.folders.retrieve(
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ats.candidates.meta_post_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Candidate` POSTs. +
+
+#### 🔌 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.ats.candidates.meta_post_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+ +## Ats Scopes +
client.ats.scopes.default_scopes_retrieve() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +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). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.scopes.default_scopes_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
@@ -20352,7 +20940,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() +
client.ats.scopes.linked_account_scopes_retrieve()
@@ -20364,7 +20952,7 @@ client.filestorage.folders.retrieve(
-Returns metadata for `FileStorageFolder` POSTs. +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).
@@ -20385,7 +20973,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.meta_post_retrieve() +client.ats.scopes.linked_account_scopes_retrieve() ``` @@ -20413,8 +21001,7 @@ client.filestorage.folders.meta_post_retrieve()
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.ats.scopes.linked_account_scopes_create(...)
@@ -20426,7 +21013,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +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)
@@ -20442,13 +21029,42 @@ Create a remote key. ```python from merge import Merge +from merge.resources.ats import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", +client.ats.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, + ) + }, + ), + ], ) ``` @@ -20465,7 +21081,7 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -20485,8 +21101,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +## Ats DeleteAccount +
client.ats.delete_account.delete()
@@ -20498,7 +21114,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Delete a linked account.
@@ -20519,7 +21135,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list() +client.ats.delete_account.delete() ``` @@ -20535,15 +21151,71 @@ client.filestorage.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.
+ +
+ + + + +
+## Ats Departments +
client.ats.departments.list(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Department` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20551,7 +21223,7 @@ client.filestorage.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.
@@ -20559,7 +21231,7 @@ client.filestorage.groups.list()
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — 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.
@@ -20635,7 +21307,7 @@ client.filestorage.groups.list()
-
client.filestorage.groups.retrieve(...) +
client.ats.departments.retrieve(...)
@@ -20647,7 +21319,7 @@ client.filestorage.groups.list()
-Returns a `Group` object with the given `id`. +Returns a `Department` object with the given `id`.
@@ -20668,7 +21340,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( +client.ats.departments.retrieve( id="id", ) @@ -20694,14 +21366,6 @@ client.filestorage.groups.retrieve(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — 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.
@@ -20730,8 +21394,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Ats Eeocs +
client.ats.eeocs.list(...)
@@ -20743,7 +21407,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `EEOC` objects.
@@ -20764,7 +21428,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list() +client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20780,7 +21446,7 @@ client.filestorage.issues.list()
-**account_token:** `typing.Optional[str]` +**candidate_id:** `typing.Optional[str]` — If provided, will only return EEOC info for this candidate.
@@ -20788,7 +21454,7 @@ client.filestorage.issues.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.
@@ -20796,7 +21462,7 @@ client.filestorage.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -20804,7 +21470,7 @@ client.filestorage.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20812,7 +21478,7 @@ client.filestorage.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20820,7 +21486,7 @@ client.filestorage.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was 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/).
@@ -20828,7 +21494,7 @@ client.filestorage.issues.list()
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20836,7 +21502,7 @@ client.filestorage.issues.list()
-**integration_name:** `typing.Optional[str]` +**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).
@@ -20844,7 +21510,7 @@ client.filestorage.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20852,7 +21518,7 @@ client.filestorage.issues.list()
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -20860,7 +21526,7 @@ client.filestorage.issues.list()
-**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.
@@ -20868,7 +21534,7 @@ client.filestorage.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -20876,7 +21542,7 @@ client.filestorage.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -20884,12 +21550,7 @@ client.filestorage.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` — 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)
@@ -20909,7 +21570,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.ats.eeocs.retrieve(...)
@@ -20921,7 +21582,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns an `EEOC` object with the given `id`.
@@ -20942,7 +21603,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( +client.ats.eeocs.retrieve( id="id", ) @@ -20968,75 +21629,31 @@ client.filestorage.issues.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - - -
- -## Filestorage LinkToken -
client.filestorage.link_token.create(...) -
-
- -#### 📝 Description
-
-
- -Creates a link token to be used when linking a new end user. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.filestorage import CategoriesEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.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], -) - -``` -
-
+**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). +
-#### ⚙️ Parameters - -
-
-
-**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. +**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -21044,7 +21661,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` — 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)
@@ -21052,99 +21669,69 @@ client.filestorage.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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. -
-
-
-**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/. -
+
+## Ats FieldMapping +
client.ats.field_mapping.field_mappings_retrieve(...)
-**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. - -
-
+#### 📝 Description
-**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. - +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/).
- -
-
- -**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. -
+#### 🔌 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. - -
-
-
-**language:** `typing.Optional[LanguageEnum]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.field_mapping.field_mappings_retrieve() -* `en` - en -* `de` - de - +``` +
+
+#### ⚙️ Parameters +
-**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. +**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.
@@ -21164,8 +21751,7 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +
client.ats.field_mapping.field_mappings_create(...)
@@ -21177,7 +21763,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +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.
@@ -21198,7 +21784,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list() +client.ats.field_mapping.field_mappings_create( + 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", +) ``` @@ -21214,17 +21807,7 @@ client.filestorage.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 +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -21232,7 +21815,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -21240,7 +21823,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. +**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.
@@ -21248,7 +21831,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. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -21256,7 +21839,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. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -21264,7 +21847,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. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -21272,7 +21855,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**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.
@@ -21280,47 +21863,70 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.ats.field_mapping.field_mappings_destroy(...)
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. - -
-
+#### 📝 Description
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. - +
+
+ +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 +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +
+
+ +**field_mapping_id:** `str`
@@ -21340,8 +21946,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.ats.field_mapping.field_mappings_partial_update(...)
@@ -21353,7 +21958,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +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.
@@ -21369,17 +21974,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ats.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -21396,7 +21997,31 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -21416,8 +22041,7 @@ client.filestorage.passthrough.create(
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...) +
client.ats.field_mapping.remote_fields_retrieve(...)
@@ -21429,7 +22053,7 @@ client.filestorage.passthrough.create(
-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/).
@@ -21450,9 +22074,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.ats.field_mapping.remote_fields_retrieve() ``` @@ -21468,7 +22090,15 @@ client.filestorage.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.
@@ -21488,8 +22118,7 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +
client.ats.field_mapping.target_fields_retrieve()
@@ -21501,7 +22130,7 @@ client.filestorage.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/).
@@ -21522,7 +22151,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list() +client.ats.field_mapping.target_fields_retrieve() ``` @@ -21538,22 +22167,6 @@ client.filestorage.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21566,8 +22179,8 @@ client.filestorage.sync_status.list()
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create() +## Ats GenerateKey +
client.ats.generate_key.create(...)
@@ -21579,7 +22192,7 @@ client.filestorage.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.
@@ -21600,7 +22213,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.force_resync.sync_status_resync_create() +client.ats.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -21616,6 +22231,14 @@ client.filestorage.force_resync.sync_status_resync_create()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21628,8 +22251,8 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +## Ats Interviews +
client.ats.interviews.list(...)
@@ -21641,7 +22264,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a list of `ScheduledInterview` objects.
@@ -21662,7 +22285,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list() +client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -21678,6 +22303,14 @@ client.filestorage.users.list()
+**application_id:** `typing.Optional[str]` — If provided, will only return interviews for this application. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21702,6 +22335,14 @@ client.filestorage.users.list()
+**expand:** `typing.Optional[InterviewsListRequestExpand]` — 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/).
@@ -21726,7 +22367,15 @@ client.filestorage.users.list()
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. +**job_id:** `typing.Optional[str]` — If provided, wll only return interviews organized for this job. + +
+
+ +
+
+ +**job_interview_stage_id:** `typing.Optional[str]` — If provided, will only return interviews at this stage.
@@ -21750,6 +22399,14 @@ client.filestorage.users.list()
+**organizer_id:** `typing.Optional[str]` — If provided, will only return interviews organized by this user. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21758,6 +22415,14 @@ client.filestorage.users.list()
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21766,6 +22431,14 @@ client.filestorage.users.list()
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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.
@@ -21778,7 +22451,7 @@ client.filestorage.users.list()
-
client.filestorage.users.retrieve(...) +
client.ats.interviews.create(...)
@@ -21790,7 +22463,7 @@ client.filestorage.users.list()
-Returns a `User` object with the given `id`. +Creates a `ScheduledInterview` object with the given values.
@@ -21806,13 +22479,15 @@ Returns a `User` object with the given `id`. ```python from merge import Merge +from merge.resources.ats import ScheduledInterviewRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( - id="id", +client.ats.interviews.create( + model=ScheduledInterviewRequest(), + remote_user_id="remote_user_id", ) ``` @@ -21829,7 +22504,7 @@ client.filestorage.users.retrieve(
-**id:** `str` +**model:** `ScheduledInterviewRequest`
@@ -21837,7 +22512,7 @@ client.filestorage.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_user_id:** `str`
@@ -21845,7 +22520,15 @@ client.filestorage.users.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). +**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.
@@ -21865,8 +22548,7 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +
client.ats.interviews.retrieve(...)
@@ -21878,7 +22560,7 @@ client.filestorage.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Returns a `ScheduledInterview` object with the given `id`.
@@ -21899,7 +22581,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.ats.interviews.retrieve( + id="id", +) ``` @@ -21915,71 +22599,31 @@ client.filestorage.webhook_receivers.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
- -
client.filestorage.webhook_receivers.create(...) -
-
- -#### 📝 Description - -
-
-Creates a `WebhookReceiver` object with the given values. -
-
+**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.webhook_receivers.create( - event="event", - is_active=True, -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters - -
-
-
-**event:** `str` +**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).
@@ -21987,7 +22631,7 @@ client.filestorage.webhook_receivers.create(
-**is_active:** `bool` +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -21995,7 +22639,7 @@ client.filestorage.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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)
@@ -22015,8 +22659,7 @@ client.filestorage.webhook_receivers.create(
-## Hris AccountDetails -
client.hris.account_details.retrieve() +
client.ats.interviews.meta_post_retrieve()
@@ -22028,7 +22671,7 @@ client.filestorage.webhook_receivers.create(
-Get details for a linked account. +Returns metadata for `ScheduledInterview` POSTs.
@@ -22049,7 +22692,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +client.ats.interviews.meta_post_retrieve() ``` @@ -22077,8 +22720,8 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +## Ats Issues +
client.ats.issues.list(...)
@@ -22090,7 +22733,7 @@ client.hris.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Gets all issues for Organization.
@@ -22111,8 +22754,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( - public_token="public_token", +client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -22129,7 +22772,7 @@ client.hris.account_token.retrieve(
-**public_token:** `str` +**account_token:** `typing.Optional[str]`
@@ -22137,75 +22780,47 @@ client.hris.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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 +
-
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...)
-#### 📝 Description - -
-
+**end_user_organization_name:** `typing.Optional[str]` + +
+
-Asynchronously pull data from an endpoint not currently supported by Merge. -
-
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +
-#### 🔌 Usage - -
-
-
-```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", - ), -) - -``` -
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +
-#### ⚙️ Parameters - -
-
-
-**request:** `DataPassthroughRequest` +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -22213,70 +22828,60 @@ client.hris.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.hris.async_passthrough.retrieve(...)
-#### 📝 Description - -
-
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. + +
+
-Retrieves data from earlier async-passthrough POST request -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +
-#### 🔌 Usage -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-```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", -) - -``` -
-
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + -#### ⚙️ Parameters -
-
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -**async_passthrough_receipt_id:** `str` +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -22296,8 +22901,7 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +
client.ats.issues.retrieve(...)
@@ -22309,7 +22913,7 @@ client.hris.async_passthrough.retrieve(
-Gets a list of audit trail events. +Get a specific issue.
@@ -22330,7 +22934,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list() +client.ats.issues.retrieve( + id="id", +) ``` @@ -22346,7 +22952,7 @@ client.hris.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -22354,31 +22960,71 @@ client.hris.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Ats JobInterviewStages +
client.ats.job_interview_stages.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` - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `JobInterviewStage` objects.
+
+
+ +#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22386,7 +23032,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -22394,65 +23040,83 @@ client.hris.audit_trail.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
+
+
+**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Hris AvailableActions -
client.hris.available_actions.retrieve()
-#### 📝 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. + +
+
+
-Returns a list of models and actions available for an account. -
-
+**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 -
+**job_id:** `typing.Optional[str]` — If provided, will only return interview stages for this job. + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.available_actions.retrieve() +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -22468,8 +23132,7 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +
client.ats.job_interview_stages.retrieve(...)
@@ -22481,7 +23144,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Returns a `JobInterviewStage` object with the given `id`.
@@ -22502,7 +23165,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list() +client.ats.job_interview_stages.retrieve( + id="id", +) ``` @@ -22518,12 +23183,15 @@ client.hris.bank_info.list()
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]` +**id:** `str` + +
+
-If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') +
+
-* `SAVINGS` - SAVINGS -* `CHECKING` - CHECKING +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22531,7 +23199,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22539,7 +23207,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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).
@@ -22547,23 +23215,71 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Ats JobPostings +
client.ats.job_postings.list(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `JobPosting` objects.
+
+
+ +#### 🔌 Usage
-**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22571,7 +23287,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -22579,7 +23295,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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22587,7 +23303,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. +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22595,7 +23311,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_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/).
@@ -22603,7 +23319,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22611,7 +23327,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. +**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).
@@ -22619,7 +23335,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -22627,7 +23343,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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -22635,7 +23351,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.
@@ -22651,7 +23367,15 @@ 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[JobPostingsListRequestStatus]` + +If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') + +* `PUBLISHED` - PUBLISHED +* `CLOSED` - CLOSED +* `DRAFT` - DRAFT +* `INTERNAL` - INTERNAL +* `PENDING` - PENDING
@@ -22671,7 +23395,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.ats.job_postings.retrieve(...)
@@ -22683,7 +23407,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Returns a `JobPosting` object with the given `id`.
@@ -22704,7 +23428,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.ats.job_postings.retrieve( id="id", ) @@ -22730,7 +23454,7 @@ 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. +**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22754,22 +23478,6 @@ client.hris.bank_info.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.
@@ -22782,8 +23490,8 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +## Ats Jobs +
client.ats.jobs.list(...)
@@ -22795,7 +23503,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Returns a list of `Job` objects.
@@ -22816,7 +23524,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list() +client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -22832,7 +23542,7 @@ client.hris.benefits.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**code:** `typing.Optional[str]` — If provided, will only return jobs with this code.
@@ -22840,7 +23550,7 @@ client.hris.benefits.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.
@@ -22848,7 +23558,7 @@ client.hris.benefits.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.
@@ -22856,7 +23566,7 @@ client.hris.benefits.list()
-**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22864,7 +23574,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. +**expand:** `typing.Optional[JobsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22912,6 +23622,14 @@ client.hris.benefits.list()
+**offices:** `typing.Optional[str]` — If provided, will only return jobs for this office; multiple offices can be separated by commas. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22920,6 +23638,14 @@ client.hris.benefits.list()
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -22928,6 +23654,30 @@ client.hris.benefits.list()
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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[JobsListRequestStatus]` + +If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') + +* `OPEN` - OPEN +* `CLOSED` - CLOSED +* `DRAFT` - DRAFT +* `ARCHIVED` - ARCHIVED +* `PENDING` - PENDING + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22940,7 +23690,7 @@ client.hris.benefits.list()
-
client.hris.benefits.retrieve(...) +
client.ats.jobs.retrieve(...)
@@ -22952,7 +23702,7 @@ client.hris.benefits.list()
-Returns a `Benefit` object with the given `id`. +Returns a `Job` object with the given `id`.
@@ -22973,7 +23723,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( +client.ats.jobs.retrieve( id="id", ) @@ -22999,7 +23749,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. +**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23023,6 +23773,22 @@ client.hris.benefits.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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.
@@ -23035,8 +23801,7 @@ client.hris.benefits.retrieve(
-## Hris Companies -
client.hris.companies.list(...) +
client.ats.jobs.screening_questions_list(...)
@@ -23048,7 +23813,7 @@ client.hris.benefits.retrieve(
-Returns a list of `Company` objects. +Returns a list of `ScreeningQuestion` objects.
@@ -23069,7 +23834,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list() +client.ats.jobs.screening_questions_list( + job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23085,7 +23853,7 @@ client.hris.companies.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**job_id:** `str`
@@ -23093,7 +23861,7 @@ client.hris.companies.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.
@@ -23101,7 +23869,7 @@ client.hris.companies.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23133,22 +23901,6 @@ client.hris.companies.list()
-**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.
@@ -23157,14 +23909,6 @@ client.hris.companies.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23177,7 +23921,8 @@ client.hris.companies.list()
-
client.hris.companies.retrieve(...) +## Ats LinkToken +
client.ats.link_token.create(...)
@@ -23189,7 +23934,7 @@ client.hris.companies.list()
-Returns a `Company` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -23205,13 +23950,17 @@ Returns a `Company` object with the given `id`. ```python from merge import Merge +from merge.resources.ats import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( - id="id", +client.ats.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], ) ``` @@ -23228,7 +23977,7 @@ client.hris.companies.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.
@@ -23236,7 +23985,7 @@ client.hris.companies.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_organization_name:** `str` — Your end user's organization.
@@ -23244,7 +23993,7 @@ client.hris.companies.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). +**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.
@@ -23252,65 +24001,95 @@ client.hris.companies.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
- -
+
+
+**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/. +
-
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve()
-#### 📝 Description +**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. + +
+
+
-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). +**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. +
-#### 🔌 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 +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.default_scopes_retrieve() +The following subset of IETF language tags can be used to configure localization. -``` +* `en` - en +* `de` - de +
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +
-#### ⚙️ Parameters -
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+
@@ -23326,7 +24105,8 @@ client.hris.scopes.default_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_retrieve() +## Ats LinkedAccounts +
client.ats.linked_accounts.list(...)
@@ -23338,7 +24118,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). +List linked accounts for your organization.
@@ -23359,7 +24139,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.linked_account_scopes_retrieve() +client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23375,99 +24157,49 @@ client.hris.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- -
+**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 + -
-
client.hris.scopes.linked_account_scopes_create(...)
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-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) -
-
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +
-#### 🔌 Usage - -
-
-
-```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, - ) - }, - ), - ], -) - -``` -
-
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +
-#### ⚙️ Parameters - -
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -23475,65 +24207,67 @@ client.hris.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
-
+
+
+**id:** `typing.Optional[str]` +
-
-## Hris DeleteAccount -
client.hris.delete_account.delete()
-#### 📝 Description +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+**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. + +
+
+
-Delete a linked account. -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + -#### 🔌 Usage -
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.delete_account.delete() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + -#### ⚙️ Parameters -
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -23549,8 +24283,8 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +## Ats Offers +
client.ats.offers.list(...)
@@ -23562,7 +24296,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `Offer` objects.
@@ -23583,7 +24317,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list() +client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23599,6 +24335,14 @@ client.hris.dependents.list()
+**application_id:** `typing.Optional[str]` — If provided, will only return offers for this application. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23615,6 +24359,14 @@ client.hris.dependents.list()
+**creator_id:** `typing.Optional[str]` — If provided, will only return offers created by this user. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23623,7 +24375,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/). +**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23631,7 +24383,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/).
@@ -23639,7 +24391,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.
@@ -23679,6 +24431,14 @@ client.hris.dependents.list()
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23687,6 +24447,14 @@ client.hris.dependents.list()
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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.
@@ -23699,7 +24467,7 @@ client.hris.dependents.list()
-
client.hris.dependents.retrieve(...) +
client.ats.offers.retrieve(...)
@@ -23711,7 +24479,7 @@ client.hris.dependents.list()
-Returns a `Dependent` object with the given `id`. +Returns an `Offer` object with the given `id`.
@@ -23732,7 +24500,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.retrieve( +client.ats.offers.retrieve( id="id", ) @@ -23758,7 +24526,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. +**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23766,7 +24534,7 @@ client.hris.dependents.retrieve(
-**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.
@@ -23782,6 +24550,22 @@ client.hris.dependents.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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.
@@ -23794,8 +24578,8 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +## Ats Offices +
client.ats.offices.list(...)
@@ -23807,7 +24591,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns a list of `Office` objects.
@@ -23828,7 +24612,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list() +client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23868,38 +24654,6 @@ client.hris.employee_payroll_runs.list()
-**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. - -
-
- -
-
- -**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. - -
-
- -
-
- **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/).
@@ -23948,14 +24702,6 @@ client.hris.employee_payroll_runs.list()
-**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23964,22 +24710,6 @@ client.hris.employee_payroll_runs.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. - -
-
- -
-
- -**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23992,7 +24722,7 @@ client.hris.employee_payroll_runs.list()
-
client.hris.employee_payroll_runs.retrieve(...) +
client.ats.offices.retrieve(...)
@@ -24004,7 +24734,7 @@ client.hris.employee_payroll_runs.list()
-Returns an `EmployeePayrollRun` object with the given `id`. +Returns an `Office` object with the given `id`.
@@ -24025,7 +24755,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( +client.ats.offices.retrieve( id="id", ) @@ -24051,14 +24781,6 @@ client.hris.employee_payroll_runs.retrieve(
-**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.
@@ -24087,8 +24809,8 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +## Ats Passthrough +
client.ats.passthrough.create(...)
@@ -24100,7 +24822,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -24116,12 +24838,18 @@ Returns a list of `Employee` objects. ```python from merge import Merge +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list() +client.ats.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -24137,7 +24865,7 @@ client.hris.employees.list()
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company. +**request:** `DataPassthroughRequest`
@@ -24145,109 +24873,71 @@ client.hris.employees.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. -
+
+## Ats RegenerateKey +
client.ats.regenerate_key.create(...)
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. - -
-
+#### 📝 Description
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` - -If provided, will only return employees with this employment status. - -* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE - -
-
-
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type. - +Exchange remote keys.
- -
-
- -**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+#### 🔌 Usage +
-**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name. - -
-
-
-**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.regenerate_key.create( + name="Remote Deployment Key 1", +) -**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. - +```
- -
-
- -**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 +
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**name:** `str` — The name of the remote key
@@ -24255,79 +24945,71 @@ If provided, will only return employees with this employment status.
-**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.
- -
-
- -**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title. -
-
-
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. -
+
+## Ats RejectReasons +
client.ats.reject_reasons.list(...)
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. - -
-
+#### 📝 Description
-**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. - +Returns a list of `RejectReason` objects. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email - -
-
-
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24335,7 +25017,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24343,7 +25025,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) +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24351,7 +25033,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. +**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/).
@@ -24359,7 +25041,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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24367,7 +25049,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_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).
@@ -24375,7 +25057,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24383,7 +25065,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_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24391,7 +25073,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 +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24399,7 +25081,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24419,7 +25101,7 @@ If provided, will only return employees with this employment status.
-
client.hris.employees.create(...) +
client.ats.reject_reasons.retrieve(...)
@@ -24431,7 +25113,7 @@ If provided, will only return employees with this employment status.
-Creates an `Employee` object with the given values. +Returns a `RejectReason` object with the given `id`.
@@ -24447,14 +25129,13 @@ Creates an `Employee` object with the given values. ```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( - model=EmployeeRequest(), +client.ats.reject_reasons.retrieve( + id="id", ) ``` @@ -24471,7 +25152,7 @@ client.hris.employees.create(
-**model:** `EmployeeRequest` +**id:** `str`
@@ -24479,7 +25160,7 @@ client.hris.employees.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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.
@@ -24487,7 +25168,7 @@ client.hris.employees.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -24507,7 +25188,8 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +## Ats Scorecards +
client.ats.scorecards.list(...)
@@ -24519,7 +25201,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +Returns a list of `Scorecard` objects.
@@ -24540,8 +25222,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", +client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -24558,7 +25240,7 @@ client.hris.employees.retrieve(
-**id:** `str` +**application_id:** `typing.Optional[str]` — If provided, will only return scorecards for this application.
@@ -24566,7 +25248,7 @@ client.hris.employees.retrieve(
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24574,7 +25256,7 @@ client.hris.employees.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24582,7 +25264,7 @@ client.hris.employees.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24590,7 +25272,7 @@ client.hris.employees.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). +**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24598,7 +25280,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**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/).
@@ -24606,7 +25288,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) +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24614,72 +25296,55 @@ client.hris.employees.retrieve(
-**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).
- -
+
+
+**interview_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interview. +
-
-
client.hris.employees.ignore_create(...)
-#### 📝 Description - -
-
+**interviewer_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interviewer. + +
+
-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. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### 🔌 Usage - -
-
-
-```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, -) - -``` -
-
+**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. + +
+
+
-**model_id:** `str` +**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
@@ -24687,7 +25352,7 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24695,7 +25360,7 @@ client.hris.employees.ignore_create(
-**message:** `typing.Optional[str]` +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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)
@@ -24715,7 +25380,7 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +
client.ats.scorecards.retrieve(...)
@@ -24727,7 +25392,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Returns a `Scorecard` object with the given `id`.
@@ -24748,7 +25413,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.ats.scorecards.retrieve( + id="id", +) ``` @@ -24764,69 +25431,31 @@ client.hris.employees.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...)
-#### 📝 Description - -
-
- -
-
- -Returns a list of `EmployerBenefit` objects. -
-
+**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employer_benefits.list() - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters -
-
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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).
@@ -24834,7 +25463,7 @@ client.hris.employer_benefits.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
@@ -24842,7 +25471,7 @@ client.hris.employer_benefits.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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)
@@ -24850,47 +25479,71 @@ client.hris.employer_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/). +**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. -
+
+## Ats SyncStatus +
client.ats.sync_status.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). - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +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 +
-**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 + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
+
+
+ +#### ⚙️ Parameters
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24898,7 +25551,7 @@ client.hris.employer_benefits.list()
-**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.
@@ -24918,7 +25571,8 @@ client.hris.employer_benefits.list()
-
client.hris.employer_benefits.retrieve(...) +## Ats ForceResync +
client.ats.force_resync.sync_status_resync_create()
@@ -24930,7 +25584,7 @@ client.hris.employer_benefits.list()
-Returns an `EmployerBenefit` 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.
@@ -24951,9 +25605,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( - id="id", -) +client.ats.force_resync.sync_status_resync_create() ``` @@ -24969,30 +25621,6 @@ client.hris.employer_benefits.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.
@@ -25005,8 +25633,8 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +## Ats Tags +
client.ats.tags.list(...)
@@ -25018,7 +25646,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Returns a list of `Tag` objects.
@@ -25039,7 +25667,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list() +client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25079,22 +25709,6 @@ client.hris.employments.list()
-**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/).
@@ -25135,14 +25749,6 @@ client.hris.employments.list()
-**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.
@@ -25151,14 +25757,6 @@ client.hris.employments.list()
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -25167,14 +25765,6 @@ 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) - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25187,7 +25777,8 @@ client.hris.employments.list()
-
client.hris.employments.retrieve(...) +## Ats Users +
client.ats.users.list(...)
@@ -25199,7 +25790,7 @@ client.hris.employments.list()
-Returns an `Employment` object with the given `id`. +Returns a list of `RemoteUser` objects.
@@ -25220,8 +25811,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.retrieve( - id="id", +client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -25238,7 +25829,7 @@ client.hris.employments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25246,7 +25837,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25254,7 +25845,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25262,7 +25853,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). +**email:** `typing.Optional[str]` — If provided, will only return remote users with the given email address
@@ -25270,7 +25861,7 @@ client.hris.employments.retrieve(
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**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/).
@@ -25278,7 +25869,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) +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25286,69 +25877,55 @@ client.hris.employments.retrieve(
-**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).
- -
+
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...)
-#### 📝 Description - -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
-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/). -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.field_mappings_retrieve() - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**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. +**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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)
@@ -25368,7 +25945,7 @@ client.hris.field_mapping.field_mappings_retrieve()
-
client.hris.field_mapping.field_mappings_create(...) +
client.ats.users.retrieve(...)
@@ -25380,7 +25957,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 `RemoteUser` object with the given `id`.
@@ -25401,13 +25978,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_create( - 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.ats.users.retrieve( + id="id", ) ``` @@ -25424,23 +25996,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. +**id:** `str`
@@ -25448,7 +26004,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25456,7 +26012,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**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).
@@ -25464,7 +26020,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. +**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins.
@@ -25472,7 +26028,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. +**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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)
@@ -25492,7 +26048,8 @@ client.hris.field_mapping.field_mappings_create(
-
client.hris.field_mapping.field_mappings_destroy(...) +## Ats WebhookReceivers +
client.ats.webhook_receivers.list()
@@ -25504,7 +26061,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 a list of `WebhookReceiver` objects.
@@ -25525,9 +26082,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.ats.webhook_receivers.list() ``` @@ -25543,14 +26098,6 @@ client.hris.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25563,7 +26110,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +
client.ats.webhook_receivers.create(...)
@@ -25575,7 +26122,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. +Creates a `WebhookReceiver` object with the given values.
@@ -25596,8 +26143,9 @@ 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.ats.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -25614,100 +26162,15 @@ 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. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**event:** `str`
- -
- - - - -
- -
client.hris.field_mapping.remote_fields_retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -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/). -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.remote_fields_retrieve() - -``` -
-
-
-
- -#### ⚙️ Parameters
-
-
- -**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**is_active:** `bool`
@@ -25715,7 +26178,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]`
@@ -25735,7 +26198,8 @@ client.hris.field_mapping.remote_fields_retrieve()
-
client.hris.field_mapping.target_fields_retrieve() +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -25747,7 +26211,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.
@@ -25768,7 +26232,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.target_fields_retrieve() +client.crm.account_details.retrieve() ``` @@ -25796,8 +26260,8 @@ client.hris.field_mapping.target_fields_retrieve()
-## Hris GenerateKey -
client.hris.generate_key.create(...) +## Crm AccountToken +
client.crm.account_token.retrieve(...)
@@ -25809,7 +26273,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.
@@ -25830,8 +26294,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.generate_key.create( - name="Remote Deployment Key 1", +client.crm.account_token.retrieve( + public_token="public_token", ) ``` @@ -25848,7 +26312,7 @@ client.hris.generate_key.create(
-**name:** `str` — The name of the remote key +**public_token:** `str`
@@ -25868,8 +26332,8 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -25881,7 +26345,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `Account` objects.
@@ -25902,7 +26366,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list() +client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25942,6 +26408,14 @@ client.hris.groups.list()
+**expand:** `typing.Optional[typing.Literal["owner"]]` — 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/).
@@ -25958,7 +26432,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_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25966,7 +26440,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).
@@ -25990,7 +26464,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. +**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
@@ -25998,7 +26472,7 @@ client.hris.groups.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
@@ -26006,7 +26480,7 @@ client.hris.groups.list()
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26022,22 +26496,6 @@ 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) - -
-
- -
-
- -**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26050,7 +26508,7 @@ client.hris.groups.list()
-
client.hris.groups.retrieve(...) +
client.crm.accounts.create(...)
@@ -26062,7 +26520,7 @@ client.hris.groups.list()
-Returns a `Group` object with the given `id`. +Creates an `Account` object with the given values.
@@ -26078,13 +26536,14 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( - id="id", +client.crm.accounts.create( + model=AccountRequest(), ) ``` @@ -26101,23 +26560,7 @@ client.hris.groups.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). +**model:** `AccountRequest`
@@ -26125,7 +26568,7 @@ client.hris.groups.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -26133,7 +26576,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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26153,8 +26596,7 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +
client.crm.accounts.retrieve(...)
@@ -26166,7 +26608,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Returns an `Account` object with the given `id`.
@@ -26187,7 +26629,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list() +client.crm.accounts.retrieve( + id="id", +) ``` @@ -26203,7 +26647,7 @@ client.hris.issues.list()
-**account_token:** `typing.Optional[str]` +**id:** `str`
@@ -26211,7 +26655,7 @@ client.hris.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26219,7 +26663,7 @@ client.hris.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26227,7 +26671,7 @@ client.hris.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26235,7 +26679,7 @@ client.hris.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was 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).
@@ -26243,47 +26687,72 @@ client.hris.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues -
+
+
client.crm.accounts.partial_update(...)
-**integration_name:** `typing.Optional[str]` - -
-
+#### 📝 Description
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - +
+
+ +Updates an `Account` object with the given `id`.
+
+
+ +#### 🔌 Usage
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import PatchedAccountRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.accounts.partial_update( + id="id", + model=PatchedAccountRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +
+
+ +**id:** `str`
@@ -26291,7 +26760,7 @@ client.hris.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model:** `PatchedAccountRequest`
@@ -26299,7 +26768,7 @@ client.hris.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -26307,12 +26776,7 @@ client.hris.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26332,7 +26796,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.crm.accounts.meta_patch_retrieve(...)
@@ -26344,7 +26808,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `CRMAccount` PATCHs.
@@ -26365,7 +26829,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( +client.crm.accounts.meta_patch_retrieve( id="id", ) @@ -26403,8 +26867,7 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +
client.crm.accounts.meta_post_retrieve()
@@ -26416,7 +26879,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns metadata for `CRMAccount` POSTs.
@@ -26432,18 +26895,12 @@ Creates a link token to be used when linking a new end user. ```python 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.crm.accounts.meta_post_retrieve() ``` @@ -26459,47 +26916,70 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_organization_name:** `str` — Your end user's organization. -
+
+
client.crm.accounts.remote_field_classes_list(...)
-**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. - -
-
+#### 📝 Description
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - +
+
+ +Returns a list of `RemoteFieldClass` objects.
+
+
+ +#### 🔌 Usage
-**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/. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26507,7 +26987,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. +**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/).
@@ -26515,7 +26995,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26523,7 +27003,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. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26531,14 +27011,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. +**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).
@@ -26546,12 +27019,7 @@ client.hris.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -26559,7 +27027,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. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -26567,7 +27035,7 @@ 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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26587,8 +27055,8 @@ The following subset of IETF language tags can be used to configure localization
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -26600,7 +27068,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -26616,12 +27084,18 @@ List linked accounts for your organization. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list() +client.crm.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -26637,113 +27111,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. - -
-
- -
-
- -**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. - -
-
- -
-
- -**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - -
-
- -
-
- -**id:** `typing.Optional[str]` - -
-
- -
-
- -**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - -
-
- -
-
- -**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. - -
-
- -
-
- -**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. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**request:** `DataPassthroughRequest`
@@ -26763,8 +27131,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +
client.crm.async_passthrough.retrieve(...)
@@ -26776,7 +27143,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Retrieves data from earlier async-passthrough POST request
@@ -26797,7 +27164,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list() +client.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -26813,7 +27182,7 @@ client.hris.locations.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**async_passthrough_receipt_id:** `str`
@@ -26821,60 +27190,71 @@ client.hris.locations.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. -
+
+## Crm AuditTrail +
client.crm.audit_trail.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/). - -
-
+#### 📝 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). - +Gets a list of audit trail events. +
+
+#### 🔌 Usage +
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` +
+
-If provided, will only return locations with this location_type +```python +from merge import Merge -* `HOME` - HOME -* `WORK` - WORK - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
+
+
+ +#### ⚙️ Parameters
-**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.
@@ -26882,7 +27262,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. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -26890,7 +27270,7 @@ If provided, will only return locations with this location_type
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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`
@@ -26898,7 +27278,7 @@ If provided, will only return locations with this location_type
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26906,7 +27286,7 @@ If provided, will only return locations with this location_type
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -26914,7 +27294,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) +**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.
@@ -26934,7 +27314,8 @@ If provided, will only return locations with this location_type
-
client.hris.locations.retrieve(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -26946,7 +27327,7 @@ If provided, will only return locations with this location_type
-Returns a `Location` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -26967,9 +27348,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( - id="id", -) +client.crm.available_actions.retrieve() ``` @@ -26985,46 +27364,6 @@ client.hris.locations.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[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.
@@ -27037,8 +27376,8 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -27050,7 +27389,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns a list of `Contact` objects.
@@ -27066,17 +27405,13 @@ 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.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -27093,7 +27428,7 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` +**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -27101,69 +27436,31 @@ client.hris.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Hris PayGroups -
client.hris.pay_groups.list(...) -
-
- -#### 📝 Description
-
-
- -Returns a list of `PayGroup` objects. -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.pay_groups.list() - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters - -
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -27171,7 +27468,7 @@ client.hris.pay_groups.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27179,7 +27476,7 @@ client.hris.pay_groups.list()
-**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/).
@@ -27187,7 +27484,7 @@ client.hris.pay_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/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27195,7 +27492,7 @@ client.hris.pay_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_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -27235,6 +27532,14 @@ client.hris.pay_groups.list()
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27255,7 +27560,7 @@ client.hris.pay_groups.list()
-
client.hris.pay_groups.retrieve(...) +
client.crm.contacts.create(...)
@@ -27267,7 +27572,7 @@ client.hris.pay_groups.list()
-Returns a `PayGroup` object with the given `id`. +Creates a `Contact` object with the given values.
@@ -27283,13 +27588,14 @@ Returns a `PayGroup` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( - id="id", +client.crm.contacts.create( + model=ContactRequest(), ) ``` @@ -27306,7 +27612,7 @@ client.hris.pay_groups.retrieve(
-**id:** `str` +**model:** `ContactRequest`
@@ -27314,7 +27620,7 @@ client.hris.pay_groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -27322,7 +27628,7 @@ client.hris.pay_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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27342,8 +27648,7 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +
client.crm.contacts.retrieve(...)
@@ -27355,7 +27660,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Returns a `Contact` object with the given `id`.
@@ -27376,7 +27681,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list() +client.crm.contacts.retrieve( + id="id", +) ``` @@ -27392,7 +27699,7 @@ client.hris.payroll_runs.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -27400,7 +27707,7 @@ client.hris.payroll_runs.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27408,7 +27715,7 @@ client.hris.payroll_runs.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.
@@ -27416,7 +27723,7 @@ client.hris.payroll_runs.list()
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -27424,7 +27731,7 @@ client.hris.payroll_runs.list()
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before 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).
@@ -27432,79 +27739,72 @@ 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/). +**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). -
+
+
client.crm.contacts.partial_update(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-**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. - +Updates a `Contact` object with the given `id`. +
+
+#### 🔌 Usage +
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +```python +from merge import Merge +from merge.resources.crm import PatchedContactRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.partial_update( + id="id", + model=PatchedContactRequest(), +) + +``` +
+
+#### ⚙️ 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') +
+
-* `REGULAR` - REGULAR -* `OFF_CYCLE` - OFF_CYCLE -* `CORRECTION` - CORRECTION -* `TERMINATION` - TERMINATION -* `SIGN_ON_BONUS` - SIGN_ON_BONUS +**id:** `str`
@@ -27512,7 +27812,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**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) +**model:** `PatchedContactRequest`
@@ -27520,7 +27820,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -27528,7 +27828,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27548,7 +27848,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +
client.crm.contacts.ignore_create(...)
@@ -27560,7 +27860,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` object with the given `id`. +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.
@@ -27576,13 +27876,17 @@ Returns a `PayrollRun` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( - id="id", +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -27599,7 +27903,7 @@ client.hris.payroll_runs.retrieve(
-**id:** `str` +**model_id:** `str`
@@ -27607,7 +27911,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. +**request:** `IgnoreCommonModelRequest`
@@ -27615,23 +27919,70 @@ 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). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.crm.contacts.meta_patch_retrieve(...)
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `CRMContact` PATCHs. +
+
+#### 🔌 Usage +
-**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) +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.meta_patch_retrieve( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -27651,8 +28002,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.crm.contacts.meta_post_retrieve()
@@ -27664,7 +28014,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +Returns metadata for `CRMContact` POSTs.
@@ -27685,9 +28035,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.crm.contacts.meta_post_retrieve() ``` @@ -27703,14 +28051,6 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27723,8 +28063,7 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +
client.crm.contacts.remote_field_classes_list(...)
@@ -27736,7 +28075,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). +Returns a list of `RemoteFieldClass` objects.
@@ -27757,7 +28096,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list() +client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27781,7 +28122,7 @@ client.hris.sync_status.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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/).
@@ -27789,65 +28130,51 @@ client.hris.sync_status.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_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create()
-#### 📝 Description - -
-
+**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). + +
+
-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. -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.force_resync.sync_status_resync_create() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -27863,8 +28190,8 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -27876,7 +28203,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns a list of `CustomObjectClass` objects.
@@ -27897,7 +28224,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list() +client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27937,7 +28266,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[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27993,14 +28322,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.
@@ -28021,7 +28342,7 @@ client.hris.teams.list()
-
client.hris.teams.retrieve(...) +
client.crm.custom_object_classes.retrieve(...)
@@ -28033,7 +28354,7 @@ client.hris.teams.list()
-Returns a `Team` object with the given `id`. +Returns a `CustomObjectClass` object with the given `id`.
@@ -28054,7 +28375,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( +client.crm.custom_object_classes.retrieve( id="id", ) @@ -28080,7 +28401,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[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28116,8 +28437,8 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -28129,7 +28450,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Returns a list of `AssociationType` objects.
@@ -28150,7 +28471,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list() +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28166,7 +28490,7 @@ client.hris.time_off.list()
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. +**custom_object_class_id:** `str`
@@ -28198,31 +28522,7 @@ client.hris.time_off.list()
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. - -
-
- -
-
- -**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. - -
-
- -
-
- -**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. - -
-
- -
-
- -**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28278,14 +28578,6 @@ 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.
@@ -28294,63 +28586,6 @@ client.hris.time_off.list()
-**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. - -
-
- -
-
- -**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 - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28363,7 +28598,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -28375,7 +28610,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +Creates an `AssociationType` object with the given values.
@@ -28391,14 +28626,31 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - model=TimeOffRequest(), +client.crm.association_types.custom_object_classes_association_types_create( + custom_object_class_id="custom_object_class_id", + model=AssociationTypeRequestRequest( + source_object_class=ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ), + target_object_classes=[ + ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ) + ], + remote_key_name="remote_key_name", + ), ) ``` @@ -28415,7 +28667,15 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `AssociationTypeRequestRequest`
@@ -28451,7 +28711,7 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -28463,7 +28723,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Returns an `AssociationType` object with the given `id`.
@@ -28484,7 +28744,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", id="id", ) @@ -28502,15 +28763,7 @@ client.hris.time_off.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**custom_object_class_id:** `str`
@@ -28518,7 +28771,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. +**id:** `str`
@@ -28526,7 +28779,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). +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28534,7 +28787,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — 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.
@@ -28542,7 +28795,7 @@ 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) +**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).
@@ -28562,7 +28815,7 @@ client.hris.time_off.retrieve(
-
client.hris.time_off.meta_post_retrieve() +
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
@@ -28574,7 +28827,7 @@ client.hris.time_off.retrieve(
-Returns metadata for `TimeOff` POSTs. +Returns metadata for `CRMAssociationType` POSTs.
@@ -28595,7 +28848,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.meta_post_retrieve() +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -28611,6 +28866,14 @@ client.hris.time_off.meta_post_retrieve()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28623,8 +28886,8 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -28636,7 +28899,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +Returns a list of `CustomObject` objects.
@@ -28657,7 +28920,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list() +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28673,6 +28939,14 @@ client.hris.time_off_balances.list()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28697,7 +28971,7 @@ client.hris.time_off_balances.list()
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. +**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/).
@@ -28705,7 +28979,7 @@ client.hris.time_off_balances.list()
-**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.
@@ -28713,7 +28987,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/). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -28721,7 +28995,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. +**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).
@@ -28729,7 +29003,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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -28737,7 +29011,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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -28745,7 +29019,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28753,7 +29027,7 @@ client.hris.time_off_balances.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.
@@ -28761,16 +29035,74 @@ client.hris.time_off_balances.list()
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
-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 + +
+
+ +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a `CustomObject` object with the given values. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import CustomObjectRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**custom_object_class_id:** `str`
@@ -28778,7 +29110,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. +**model:** `CustomObjectRequest`
@@ -28786,7 +29118,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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -28794,7 +29126,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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -28814,7 +29146,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -28826,7 +29158,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Returns a `CustomObject` object with the given `id`.
@@ -28847,7 +29179,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", id="id", ) @@ -28865,7 +29198,7 @@ client.hris.time_off_balances.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -28873,7 +29206,7 @@ client.hris.time_off_balances.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -28889,15 +29222,7 @@ client.hris.time_off_balances.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_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -28905,7 +29230,7 @@ client.hris.time_off_balances.retrieve(
-**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) +**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).
@@ -28925,8 +29250,7 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -28938,7 +29262,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Returns metadata for `CRMCustomObject` POSTs.
@@ -28959,7 +29283,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list() +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -28975,7 +29301,7 @@ client.hris.timesheet_entries.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**custom_object_class_id:** `str`
@@ -28983,71 +29309,70 @@ 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. -
+
+
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. - -
-
+#### 📝 Description
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. - -
-
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. - +Returns a list of `RemoteFieldClass` objects. +
+
+#### 🔌 Usage +
-**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/). - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
+ + + +#### ⚙️ 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.
@@ -29055,7 +29380,7 @@ client.hris.timesheet_entries.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after 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/).
@@ -29063,7 +29388,7 @@ client.hris.timesheet_entries.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29071,7 +29396,7 @@ client.hris.timesheet_entries.list()
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -29079,7 +29404,7 @@ client.hris.timesheet_entries.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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).
@@ -29087,7 +29412,7 @@ client.hris.timesheet_entries.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -29095,7 +29420,7 @@ client.hris.timesheet_entries.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -29103,7 +29428,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.
@@ -29123,7 +29448,8 @@ client.hris.timesheet_entries.list()
-
client.hris.timesheet_entries.create(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -29135,7 +29461,7 @@ client.hris.timesheet_entries.list()
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `Association` objects.
@@ -29151,14 +29477,15 @@ 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( - model=TimesheetEntryRequest(), +client.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29175,7 +29502,7 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**custom_object_class_id:** `str`
@@ -29183,7 +29510,7 @@ client.hris.timesheet_entries.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**object_id:** `str`
@@ -29191,7 +29518,95 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["association_type"]]` — 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). + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29211,7 +29626,7 @@ client.hris.timesheet_entries.create(
-
client.hris.timesheet_entries.retrieve(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -29223,7 +29638,7 @@ client.hris.timesheet_entries.create(
-Returns a `TimesheetEntry` object with the given `id`. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -29244,8 +29659,12 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.retrieve( - id="id", +client.crm.associations.custom_object_classes_custom_objects_associations_update( + association_type_id="association_type_id", + source_class_id="source_class_id", + source_object_id="source_object_id", + target_class_id="target_class_id", + target_object_id="target_object_id", ) ``` @@ -29262,7 +29681,7 @@ client.hris.timesheet_entries.retrieve(
-**id:** `str` +**association_type_id:** `str`
@@ -29270,7 +29689,7 @@ 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. +**source_class_id:** `str`
@@ -29278,7 +29697,7 @@ client.hris.timesheet_entries.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**source_object_id:** `str`
@@ -29286,7 +29705,31 @@ client.hris.timesheet_entries.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). +**target_class_id:** `str` + +
+
+ +
+
+ +**target_object_id:** `str` + +
+
+ +
+
+ +**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.
@@ -29306,7 +29749,8 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -29318,7 +29762,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +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).
@@ -29339,7 +29783,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.crm.scopes.default_scopes_retrieve() ``` @@ -29367,8 +29811,7 @@ client.hris.timesheet_entries.meta_post_retrieve()
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list() +
client.crm.scopes.linked_account_scopes_retrieve()
@@ -29380,7 +29823,7 @@ client.hris.timesheet_entries.meta_post_retrieve()
-Returns a list of `WebhookReceiver` 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).
@@ -29401,7 +29844,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.list() +client.crm.scopes.linked_account_scopes_retrieve() ``` @@ -29429,7 +29872,7 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -29441,7 +29884,7 @@ client.hris.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +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)
@@ -29457,14 +29900,42 @@ Creates a `WebhookReceiver` object with the given values. ```python from merge import Merge +from merge.resources.crm import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( - event="event", - is_active=True, +client.crm.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, + ) + }, + ), + ], ) ``` @@ -29481,23 +29952,7 @@ client.hris.webhook_receivers.create(
-**event:** `str` - -
-
- -
-
- -**is_active:** `bool` - -
-
- -
-
- -**key:** `typing.Optional[str]` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -29517,8 +29972,8 @@ client.hris.webhook_receivers.create(
-## Ticketing AccountDetails -
client.ticketing.account_details.retrieve() +## Crm DeleteAccount +
client.crm.delete_account.delete()
@@ -29530,7 +29985,7 @@ client.hris.webhook_receivers.create(
-Get details for a linked account. +Delete a linked account.
@@ -29551,7 +30006,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_details.retrieve() +client.crm.delete_account.delete() ``` @@ -29579,8 +30034,8 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...) +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -29592,7 +30047,7 @@ client.ticketing.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a list of `EngagementType` objects.
@@ -29613,8 +30068,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_token.retrieve( - public_token="public_token", +client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29631,77 +30086,15 @@ client.ticketing.account_token.retrieve(
-**public_token:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Ticketing Accounts -
client.ticketing.accounts.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Account` objects. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.accounts.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.
@@ -29709,7 +30102,7 @@ client.ticketing.accounts.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.
@@ -29717,7 +30110,7 @@ client.ticketing.accounts.list()
-**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/).
@@ -29725,7 +30118,7 @@ client.ticketing.accounts.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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29733,7 +30126,7 @@ client.ticketing.accounts.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -29793,7 +30186,7 @@ client.ticketing.accounts.list()
-
client.ticketing.accounts.retrieve(...) +
client.crm.engagement_types.retrieve(...)
@@ -29805,7 +30198,7 @@ client.ticketing.accounts.list()
-Returns an `Account` object with the given `id`. +Returns an `EngagementType` object with the given `id`.
@@ -29826,7 +30219,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( +client.crm.engagement_types.retrieve( id="id", ) @@ -29860,6 +30253,14 @@ client.ticketing.accounts.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -29880,8 +30281,7 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...) +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -29893,7 +30293,7 @@ client.ticketing.accounts.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `RemoteFieldClass` objects.
@@ -29909,17 +30309,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29936,7 +30332,7 @@ client.ticketing.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29944,70 +30340,55 @@ client.ticketing.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.ticketing.async_passthrough.retrieve(...)
-#### 📝 Description - -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-Retrieves data from earlier async-passthrough POST request -
-
+**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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +
-#### ⚙️ Parameters -
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+
-**async_passthrough_receipt_id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30027,8 +30408,8 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +## Crm Engagements +
client.crm.engagements.list(...)
@@ -30040,7 +30421,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Returns a list of `Engagement` objects.
@@ -30061,7 +30442,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list() +client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30101,7 +30484,7 @@ client.ticketing.attachments.list()
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30125,6 +30508,14 @@ client.ticketing.attachments.list()
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -30157,7 +30548,7 @@ client.ticketing.attachments.list()
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30165,7 +30556,7 @@ client.ticketing.attachments.list()
-**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 engagements started after this datetime.
@@ -30173,7 +30564,7 @@ client.ticketing.attachments.list()
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -30193,7 +30584,7 @@ client.ticketing.attachments.list()
-
client.ticketing.attachments.create(...) +
client.crm.engagements.create(...)
@@ -30205,7 +30596,7 @@ client.ticketing.attachments.list()
-Creates an `Attachment` object with the given values. +Creates an `Engagement` object with the given values.
@@ -30221,14 +30612,14 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import AttachmentRequest +from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.create( - model=AttachmentRequest(), +client.crm.engagements.create( + model=EngagementRequest(), ) ``` @@ -30245,7 +30636,7 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` +**model:** `EngagementRequest`
@@ -30281,7 +30672,7 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +
client.crm.engagements.retrieve(...)
@@ -30293,7 +30684,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns an `Engagement` object with the given `id`.
@@ -30314,7 +30705,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( +client.crm.engagements.retrieve( id="id", ) @@ -30340,7 +30731,7 @@ client.ticketing.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30356,6 +30747,14 @@ client.ticketing.attachments.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -30376,7 +30775,7 @@ client.ticketing.attachments.retrieve(
-
client.ticketing.attachments.meta_post_retrieve() +
client.crm.engagements.partial_update(...)
@@ -30388,7 +30787,7 @@ client.ticketing.attachments.retrieve(
-Returns metadata for `TicketingAttachment` POSTs. +Updates an `Engagement` object with the given `id`.
@@ -30404,12 +30803,16 @@ Returns metadata for `TicketingAttachment` POSTs. ```python from merge import Merge +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.meta_post_retrieve() +client.crm.engagements.partial_update( + id="id", + model=PatchedEngagementRequest(), +) ``` @@ -30425,6 +30828,38 @@ client.ticketing.attachments.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedEngagementRequest` + +
+
+ +
+
+ +**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.
@@ -30437,8 +30872,7 @@ client.ticketing.attachments.meta_post_retrieve()
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...) +
client.crm.engagements.meta_patch_retrieve(...)
@@ -30450,7 +30884,7 @@ client.ticketing.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +Returns metadata for `Engagement` PATCHs.
@@ -30471,7 +30905,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.audit_trail.list() +client.crm.engagements.meta_patch_retrieve( + id="id", +) ``` @@ -30487,47 +30923,7 @@ client.ticketing.audit_trail.list()
-**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 - -
-
- -
-
- -**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` - -
-
- -
-
- -**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. +**id:** `str`
@@ -30547,8 +30943,7 @@ client.ticketing.audit_trail.list()
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve() +
client.crm.engagements.meta_post_retrieve()
@@ -30560,7 +30955,7 @@ client.ticketing.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns metadata for `Engagement` POSTs.
@@ -30581,7 +30976,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.available_actions.retrieve() +client.crm.engagements.meta_post_retrieve() ``` @@ -30609,8 +31004,7 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections -
client.ticketing.collections.list(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -30622,7 +31016,7 @@ client.ticketing.available_actions.retrieve()
-Returns a list of `Collection` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -30643,7 +31037,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list() +client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30659,7 +31055,7 @@ client.ticketing.collections.list()
-**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30667,7 +31063,7 @@ client.ticketing.collections.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after 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/).
@@ -30675,7 +31071,7 @@ client.ticketing.collections.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.
@@ -30683,7 +31079,7 @@ client.ticketing.collections.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -30691,7 +31087,7 @@ client.ticketing.collections.list()
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — 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).
@@ -30699,7 +31095,7 @@ client.ticketing.collections.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/). +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -30707,7 +31103,7 @@ client.ticketing.collections.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -30715,7 +31111,7 @@ client.ticketing.collections.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). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30723,55 +31119,69 @@ client.ticketing.collections.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. -
+
+## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+#### 📝 Description
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. - -
-
-
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. - +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
-**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.crm.field_mapping.field_mappings_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_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) +
+
+ +**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.
@@ -30791,7 +31201,7 @@ client.ticketing.collections.list()
-
client.ticketing.collections.viewers_list(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -30803,7 +31213,7 @@ client.ticketing.collections.list()
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +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.
@@ -30824,8 +31234,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.viewers_list( - collection_id="collection_id", +client.crm.field_mapping.field_mappings_create( + 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", ) ``` @@ -30842,7 +31257,7 @@ client.ticketing.collections.viewers_list(
-**collection_id:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -30850,7 +31265,7 @@ client.ticketing.collections.viewers_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -30858,7 +31273,7 @@ client.ticketing.collections.viewers_list(
-**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -30866,7 +31281,7 @@ client.ticketing.collections.viewers_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/). +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -30874,7 +31289,7 @@ client.ticketing.collections.viewers_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -30882,7 +31297,7 @@ client.ticketing.collections.viewers_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). +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -30890,7 +31305,7 @@ client.ticketing.collections.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -30910,7 +31325,7 @@ client.ticketing.collections.viewers_list(
-
client.ticketing.collections.retrieve(...) +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -30922,7 +31337,7 @@ client.ticketing.collections.viewers_list(
-Returns a `Collection` 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.
@@ -30943,8 +31358,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -30961,7 +31376,7 @@ client.ticketing.collections.retrieve(
-**id:** `str` +**field_mapping_id:** `str`
@@ -30969,15 +31384,70 @@ client.ticketing.collections.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.crm.field_mapping.field_mappings_partial_update(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +#### 📝 Description + +
+
+ +
+
+ +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. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**field_mapping_id:** `str`
@@ -30985,7 +31455,7 @@ client.ticketing.collections.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_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.
@@ -30993,7 +31463,7 @@ client.ticketing.collections.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -31001,7 +31471,7 @@ client.ticketing.collections.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_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) +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -31021,8 +31491,7 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments -
client.ticketing.comments.list(...) +
client.crm.field_mapping.remote_fields_retrieve(...)
@@ -31034,7 +31503,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `Comment` objects. +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/).
@@ -31055,7 +31524,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list() +client.crm.field_mapping.remote_fields_retrieve() ``` @@ -31071,7 +31540,7 @@ client.ticketing.comments.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -31079,7 +31548,7 @@ client.ticketing.comments.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**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.
@@ -31087,87 +31556,132 @@ client.ticketing.comments.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.crm.field_mapping.target_fields_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. - +
+
+ +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/). +
+
+#### 🔌 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.crm.field_mapping.target_fields_retrieve() + +```
+
+
+ +#### ⚙️ Parameters
-**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. -
+
+## Crm GenerateKey +
client.crm.generate_key.create(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+#### 📝 Description
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime. - +
+
+ +Create a remote key.
+
+
+ +#### 🔌 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.crm.generate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### ⚙️ Parameters +
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +
+
+ +**name:** `str` — The name of the remote key
@@ -31187,7 +31701,8 @@ client.ticketing.comments.list()
-
client.ticketing.comments.create(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -31199,7 +31714,7 @@ client.ticketing.comments.list()
-Creates a `Comment` object with the given values. +Gets all issues for Organization.
@@ -31215,14 +31730,13 @@ Creates a `Comment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.create( - model=CommentRequest(), +client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -31239,7 +31753,7 @@ client.ticketing.comments.create(
-**model:** `CommentRequest` +**account_token:** `typing.Optional[str]`
@@ -31247,7 +31761,7 @@ client.ticketing.comments.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -31255,7 +31769,7 @@ client.ticketing.comments.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -31263,70 +31777,63 @@ client.ticketing.comments.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.ticketing.comments.retrieve(...)
-#### 📝 Description - -
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. + +
+
-Returns a `Comment` object with the given `id`. -
-
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues +
-#### 🔌 Usage -
+**integration_name:** `typing.Optional[str]` + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.comments.retrieve( - id="id", -) - -``` -
-
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. + -#### ⚙️ Parameters -
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. + +
+
+
-**id:** `str` +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -31334,7 +31841,7 @@ client.ticketing.comments.retrieve(
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — 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.
@@ -31342,7 +31849,7 @@ client.ticketing.comments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -31350,7 +31857,12 @@ client.ticketing.comments.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[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -31370,7 +31882,7 @@ client.ticketing.comments.retrieve(
-
client.ticketing.comments.meta_post_retrieve() +
client.crm.issues.retrieve(...)
@@ -31382,7 +31894,7 @@ client.ticketing.comments.retrieve(
-Returns metadata for `Comment` POSTs. +Get a specific issue.
@@ -31403,7 +31915,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.meta_post_retrieve() +client.crm.issues.retrieve( + id="id", +) ``` @@ -31419,6 +31933,14 @@ client.ticketing.comments.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31431,8 +31953,8 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts -
client.ticketing.contacts.list(...) +## Crm Leads +
client.crm.leads.list(...)
@@ -31444,7 +31966,7 @@ client.ticketing.comments.meta_post_retrieve()
-Returns a list of `Contact` objects. +Returns a list of `Lead` objects.
@@ -31465,7 +31987,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list() +client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -31481,7 +32005,7 @@ client.ticketing.contacts.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -31489,7 +32013,7 @@ client.ticketing.contacts.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -31497,7 +32021,7 @@ client.ticketing.contacts.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.
@@ -31505,7 +32029,7 @@ client.ticketing.contacts.list()
-**expand:** `typing.Optional[typing.Literal["account"]]` — 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.
@@ -31513,7 +32037,7 @@ client.ticketing.contacts.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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -31521,7 +32045,7 @@ client.ticketing.contacts.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -31529,7 +32053,7 @@ client.ticketing.contacts.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). +**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31537,7 +32061,7 @@ client.ticketing.contacts.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after 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/).
@@ -31545,7 +32069,7 @@ client.ticketing.contacts.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31553,7 +32077,7 @@ client.ticketing.contacts.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -31561,7 +32085,7 @@ client.ticketing.contacts.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**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).
@@ -31569,71 +32093,31 @@ client.ticketing.contacts.list()
-**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.
- -
- - - - -
- -
client.ticketing.contacts.create(...) -
-
- -#### 📝 Description - -
-
-Creates a `Contact` object with the given values. -
-
+**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 -from merge.resources.ticketing import ContactRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.contacts.create( - model=ContactRequest(), -) - -``` -
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +
-#### ⚙️ Parameters - -
-
-
-**model:** `ContactRequest` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -31641,7 +32125,7 @@ client.ticketing.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -31649,7 +32133,7 @@ client.ticketing.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -31669,7 +32153,7 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +
client.crm.leads.create(...)
@@ -31681,7 +32165,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +Creates a `Lead` object with the given values.
@@ -31697,13 +32181,14 @@ Returns a `Contact` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( - id="id", +client.crm.leads.create( + model=LeadRequest(), ) ``` @@ -31720,15 +32205,7 @@ client.ticketing.contacts.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `LeadRequest`
@@ -31736,7 +32213,7 @@ client.ticketing.contacts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31744,7 +32221,7 @@ client.ticketing.contacts.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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31764,7 +32241,7 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +
client.crm.leads.retrieve(...)
@@ -31776,7 +32253,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +Returns a `Lead` object with the given `id`.
@@ -31797,7 +32274,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.crm.leads.retrieve( + id="id", +) ``` @@ -31813,65 +32292,43 @@ client.ticketing.contacts.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_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 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). -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.scopes.default_scopes_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). +
-#### ⚙️ Parameters - -
-
-
@@ -31887,7 +32344,7 @@ client.ticketing.scopes.default_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_retrieve() +
client.crm.leads.meta_post_retrieve()
@@ -31899,7 +32356,7 @@ client.ticketing.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 metadata for `Lead` POSTs.
@@ -31920,7 +32377,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.linked_account_scopes_retrieve() +client.crm.leads.meta_post_retrieve() ``` @@ -31948,7 +32405,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +
client.crm.leads.remote_field_classes_list(...)
@@ -31960,7 +32417,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-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) +Returns a list of `RemoteFieldClass` objects.
@@ -31976,42 +32433,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ticketing import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.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, - ) - }, - ), - ], +client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -32028,7 +32456,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32036,65 +32464,59 @@ client.ticketing.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete()
-#### 📝 Description - -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-Delete a linked account. -
-
+**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_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.delete_account.delete() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -32110,8 +32532,8 @@ client.ticketing.delete_account.delete()
-## Ticketing FieldMapping -
client.ticketing.field_mapping.field_mappings_retrieve(...) +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -32123,7 +32545,7 @@ client.ticketing.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/). +Creates a link token to be used when linking a new end user.
@@ -32139,12 +32561,18 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_retrieve() +client.crm.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], +) ``` @@ -32160,7 +32588,7 @@ client.ticketing.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. +**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.
@@ -32168,75 +32596,47 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_organization_name:** `str` — Your end user's organization.
- -
+
+
+**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. +
-
-
client.ticketing.field_mapping.field_mappings_create(...)
-#### 📝 Description - -
-
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. + +
+
-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. -
-
+**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/. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.field_mappings_create( - 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", -) - -``` -
-
+**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. +
-#### ⚙️ Parameters - -
-
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**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.
@@ -32244,7 +32644,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**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.
@@ -32252,7 +32652,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**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. +**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.
@@ -32260,7 +32660,14 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**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.
@@ -32268,7 +32675,12 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -32276,7 +32688,7 @@ client.ticketing.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. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -32284,7 +32696,7 @@ client.ticketing.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. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -32304,7 +32716,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -32316,7 +32729,7 @@ client.ticketing.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. +List linked accounts for your organization.
@@ -32337,8 +32750,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -32355,7 +32768,17 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**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
@@ -32363,70 +32786,71 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.ticketing.field_mapping.field_mappings_partial_update(...)
-#### 📝 Description +**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. + +
+
+
-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. -
-
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + -#### 🔌 Usage -
+**id:** `typing.Optional[str]` + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**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. + +
+
+
-**field_mapping_id:** `str` +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -32434,7 +32858,7 @@ client.ticketing.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. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -32442,7 +32866,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32450,7 +32874,7 @@ client.ticketing.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. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -32470,7 +32894,8 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
client.ticketing.field_mapping.remote_fields_retrieve(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -32482,7 +32907,7 @@ client.ticketing.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 a list of `Note` objects.
@@ -32503,7 +32928,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.remote_fields_retrieve() +client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -32519,7 +32946,7 @@ client.ticketing.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. +**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -32527,7 +32954,7 @@ client.ticketing.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. +**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
@@ -32535,132 +32962,111 @@ client.ticketing.field_mapping.remote_fields_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.ticketing.field_mapping.target_fields_retrieve()
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-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/). -
-
+**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.target_fields_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/). +
-#### ⚙️ Parameters - -
-
-
-**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_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-
-## Ticketing GenerateKey -
client.ticketing.generate_key.create(...)
-#### 📝 Description +**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. + +
+
+
-Create a remote key. -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**name:** `str` — The name of the remote key +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -32680,8 +33086,7 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +
client.crm.notes.create(...)
@@ -32693,7 +33098,7 @@ client.ticketing.generate_key.create(
-Gets all issues for Organization. +Creates a `Note` object with the given values.
@@ -32709,12 +33114,15 @@ Gets all issues for Organization. ```python from merge import Merge +from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list() +client.crm.notes.create( + model=NoteRequest(), +) ``` @@ -32730,7 +33138,7 @@ client.ticketing.issues.list()
-**account_token:** `typing.Optional[str]` +**model:** `NoteRequest`
@@ -32738,7 +33146,7 @@ client.ticketing.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -32746,7 +33154,7 @@ client.ticketing.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -32754,55 +33162,70 @@ client.ticketing.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. -
+
+
client.crm.notes.retrieve(...)
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
+#### 📝 Description
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
-
-**integration_name:** `typing.Optional[str]` - +Returns a `Note` object with the given `id`. +
+
+#### 🔌 Usage +
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.notes.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +
+
+ +**id:** `str`
@@ -32810,7 +33233,7 @@ client.ticketing.issues.list()
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -32818,7 +33241,7 @@ client.ticketing.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32826,7 +33249,7 @@ client.ticketing.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -32834,12 +33257,7 @@ client.ticketing.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**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).
@@ -32859,7 +33277,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +
client.crm.notes.meta_post_retrieve()
@@ -32871,7 +33289,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `Note` POSTs.
@@ -32892,9 +33310,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( - id="id", -) +client.crm.notes.meta_post_retrieve() ``` @@ -32910,14 +33326,6 @@ client.ticketing.issues.retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32930,8 +33338,7 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken -
client.ticketing.link_token.create(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -32943,7 +33350,7 @@ client.ticketing.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `RemoteFieldClass` objects.
@@ -32959,17 +33366,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.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.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -32986,47 +33389,7 @@ client.ticketing.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. - -
-
- -
-
- -**end_user_organization_name:** `str` — Your end user's organization. - -
-
- -
-
- -**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. - -
-
- -
-
- -**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - -
-
- -
-
- -**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/. - -
-
- -
-
- -**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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33034,7 +33397,7 @@ client.ticketing.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. +**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/).
@@ -33042,7 +33405,7 @@ client.ticketing.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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33050,7 +33413,7 @@ client.ticketing.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. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33058,14 +33421,7 @@ client.ticketing.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. +**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).
@@ -33073,12 +33429,7 @@ client.ticketing.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -33086,7 +33437,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. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -33094,7 +33445,7 @@ 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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -33114,8 +33465,8 @@ The following subset of IETF language tags can be used to configure localization
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -33127,7 +33478,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Opportunity` objects.
@@ -33148,7 +33499,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list() +client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33164,17 +33517,15 @@ client.ticketing.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -33182,7 +33533,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -33190,7 +33541,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33198,7 +33549,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. +**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33206,7 +33557,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. +**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/).
@@ -33214,7 +33565,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33222,7 +33573,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33230,7 +33581,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**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).
@@ -33238,7 +33589,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33246,7 +33597,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33254,7 +33605,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
@@ -33270,7 +33621,53 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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) + +
+
+ +
+
+ +**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. + +
+
+ +
+
+ +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +* `OPEN` - OPEN +* `WON` - WON +* `LOST` - LOST
@@ -33290,8 +33687,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) +
client.crm.opportunities.create(...)
@@ -33303,7 +33699,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Creates an `Opportunity` object with the given values.
@@ -33319,17 +33715,14 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.opportunities.create( + model=OpportunityRequest(), ) ``` @@ -33346,7 +33739,23 @@ client.ticketing.passthrough.create(
-**request:** `DataPassthroughRequest` +**model:** `OpportunityRequest` + +
+
+ +
+
+ +**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.
@@ -33366,8 +33775,7 @@ client.ticketing.passthrough.create(
-## Ticketing Projects -
client.ticketing.projects.list(...) +
client.crm.opportunities.retrieve(...)
@@ -33379,7 +33787,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns an `Opportunity` object with the given `id`.
@@ -33400,7 +33808,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list() +client.crm.opportunities.retrieve( + id="id", +) ``` @@ -33416,23 +33826,7 @@ client.ticketing.projects.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. +**id:** `str`
@@ -33440,7 +33834,7 @@ client.ticketing.projects.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[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33456,15 +33850,7 @@ client.ticketing.projects.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). - -
-
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33472,7 +33858,7 @@ client.ticketing.projects.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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).
@@ -33480,7 +33866,7 @@ client.ticketing.projects.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -33488,7 +33874,7 @@ client.ticketing.projects.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — 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)
@@ -33508,7 +33894,7 @@ client.ticketing.projects.list()
-
client.ticketing.projects.retrieve(...) +
client.crm.opportunities.partial_update(...)
@@ -33520,7 +33906,7 @@ client.ticketing.projects.list()
-Returns a `Project` object with the given `id`. +Updates an `Opportunity` object with the given `id`.
@@ -33536,13 +33922,15 @@ Returns a `Project` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.retrieve( +client.crm.opportunities.partial_update( id="id", + model=PatchedOpportunityRequest(), ) ``` @@ -33567,7 +33955,7 @@ client.ticketing.projects.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**model:** `PatchedOpportunityRequest`
@@ -33575,7 +33963,15 @@ client.ticketing.projects.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). +**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.
@@ -33595,7 +33991,7 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +
client.crm.opportunities.meta_patch_retrieve(...)
@@ -33607,7 +34003,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Returns metadata for `Opportunity` PATCHs.
@@ -33628,8 +34024,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", +client.crm.opportunities.meta_patch_retrieve( + id="id", ) ``` @@ -33646,55 +34042,7 @@ client.ticketing.projects.users_list(
-**parent_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — 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). - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `str`
@@ -33714,8 +34062,7 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +
client.crm.opportunities.meta_post_retrieve()
@@ -33727,7 +34074,7 @@ client.ticketing.projects.users_list(
-Exchange remote keys. +Returns metadata for `Opportunity` POSTs.
@@ -33748,9 +34095,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.crm.opportunities.meta_post_retrieve() ``` @@ -33766,14 +34111,6 @@ client.ticketing.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -33786,8 +34123,7 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +
client.crm.opportunities.remote_field_classes_list(...)
@@ -33799,7 +34135,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -33820,7 +34156,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list() +client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33836,22 +34174,6 @@ client.ticketing.roles.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.
@@ -33876,7 +34198,7 @@ client.ticketing.roles.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_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33884,7 +34206,7 @@ client.ticketing.roles.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**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).
@@ -33892,7 +34214,7 @@ client.ticketing.roles.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -33900,7 +34222,7 @@ client.ticketing.roles.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -33908,7 +34230,7 @@ client.ticketing.roles.list()
-**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.
@@ -33928,7 +34250,8 @@ client.ticketing.roles.list()
-
client.ticketing.roles.retrieve(...) +## Crm Passthrough +
client.crm.passthrough.create(...)
@@ -33940,7 +34263,7 @@ client.ticketing.roles.list()
-Returns a `Role` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -33956,13 +34279,17 @@ Returns a `Role` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.retrieve( - id="id", +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -33979,23 +34306,7 @@ client.ticketing.roles.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:** `DataPassthroughRequest`
@@ -34015,8 +34326,8 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -34028,7 +34339,7 @@ client.ticketing.roles.retrieve(
-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). +Exchange remote keys.
@@ -34049,7 +34360,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list() +client.crm.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -34065,15 +34378,7 @@ client.ticketing.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**name:** `str` — The name of the remote key
@@ -34093,8 +34398,8 @@ client.ticketing.sync_status.list()
-## Ticketing ForceResync -
client.ticketing.force_resync.sync_status_resync_create() +## Crm Stages +
client.crm.stages.list(...)
@@ -34106,7 +34411,7 @@ client.ticketing.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. +Returns a list of `Stage` objects.
@@ -34127,7 +34432,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.force_resync.sync_status_resync_create() +client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34143,69 +34450,15 @@ client.ticketing.force_resync.sync_status_resync_create()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Ticketing Tags -
client.ticketing.tags.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Tag` objects. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tags.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.
@@ -34213,7 +34466,7 @@ client.ticketing.tags.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.
@@ -34221,7 +34474,7 @@ client.ticketing.tags.list()
-**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/).
@@ -34229,7 +34482,7 @@ client.ticketing.tags.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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34237,7 +34490,7 @@ client.ticketing.tags.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -34297,7 +34550,7 @@ client.ticketing.tags.list()
-
client.ticketing.tags.retrieve(...) +
client.crm.stages.retrieve(...)
@@ -34309,7 +34562,7 @@ client.ticketing.tags.list()
-Returns a `Tag` object with the given `id`. +Returns a `Stage` object with the given `id`.
@@ -34330,7 +34583,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( +client.crm.stages.retrieve( id="id", ) @@ -34364,6 +34617,14 @@ client.ticketing.tags.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -34384,8 +34645,7 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -34397,7 +34657,7 @@ client.ticketing.tags.retrieve(
-Returns a list of `Team` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -34418,7 +34678,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list() +client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34434,22 +34696,6 @@ client.ticketing.teams.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.
@@ -34474,7 +34720,7 @@ client.ticketing.teams.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_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -34482,7 +34728,7 @@ client.ticketing.teams.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**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).
@@ -34490,7 +34736,7 @@ client.ticketing.teams.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -34498,7 +34744,7 @@ client.ticketing.teams.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -34506,7 +34752,7 @@ client.ticketing.teams.list()
-**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.
@@ -34526,7 +34772,8 @@ client.ticketing.teams.list()
-
client.ticketing.teams.retrieve(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -34538,7 +34785,7 @@ client.ticketing.teams.list()
-Returns a `Team` object with the given `id`. +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).
@@ -34559,8 +34806,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.retrieve( - id="id", +client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -34577,15 +34824,7 @@ client.ticketing.teams.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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34593,7 +34832,7 @@ client.ticketing.teams.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.
@@ -34613,8 +34852,8 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create()
@@ -34626,7 +34865,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +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.
@@ -34647,7 +34886,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list() +client.crm.force_resync.sync_status_resync_create() ``` @@ -34663,71 +34902,71 @@ client.ticketing.tickets.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. -
+
+## Crm Tasks +
client.crm.tasks.list(...)
-**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. - -
-
+#### 📝 Description
-**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. - -
-
-
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. - +Returns a list of `Task` objects. +
+
+#### 🔌 Usage +
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. - -
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
+ + + +#### ⚙️ Parameters
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34735,7 +34974,7 @@ client.ticketing.tickets.list()
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34743,7 +34982,7 @@ client.ticketing.tickets.list()
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34751,7 +34990,7 @@ client.ticketing.tickets.list()
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34815,53 +35054,6 @@ client.ticketing.tickets.list()
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. - -
-
- -
-
- -**priority:** `typing.Optional[TicketsListRequestPriority]` - -If provided, will only return tickets of this priority. - -* `URGENT` - URGENT -* `HIGH` - HIGH -* `NORMAL` - NORMAL -* `LOW` - LOW - -
-
- -
-
- -**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. - -
-
- -
-
- -**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. - -
-
- -
-
- -**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34870,62 +35062,6 @@ If provided, will only return tickets of this priority.
-**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. - -
-
- -
-
- -**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` — 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]` — If provided, will only return tickets of this status. - -
-
- -
-
- -**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. - -
-
- -
-
- -**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. - -
-
- -
-
- -**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34938,7 +35074,7 @@ If provided, will only return tickets of this priority.
-
client.ticketing.tickets.create(...) +
client.crm.tasks.create(...)
@@ -34950,7 +35086,7 @@ If provided, will only return tickets of this priority.
-Creates a `Ticket` object with the given values. +Creates a `Task` object with the given values.
@@ -34966,14 +35102,14 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest +from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - model=TicketRequest(), +client.crm.tasks.create( + model=TaskRequest(), ) ``` @@ -34990,7 +35126,7 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` +**model:** `TaskRequest`
@@ -35026,7 +35162,7 @@ client.ticketing.tickets.create(
-
client.ticketing.tickets.retrieve(...) +
client.crm.tasks.retrieve(...)
@@ -35038,7 +35174,7 @@ client.ticketing.tickets.create(
-Returns a `Ticket` object with the given `id`. +Returns a `Task` object with the given `id`.
@@ -35059,7 +35195,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.retrieve( +client.crm.tasks.retrieve( id="id", ) @@ -35085,7 +35221,7 @@ client.ticketing.tickets.retrieve(
-**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35117,22 +35253,6 @@ client.ticketing.tickets.retrieve(
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` — 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.
@@ -35145,7 +35265,7 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +
client.crm.tasks.partial_update(...)
@@ -35157,7 +35277,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +Updates a `Task` object with the given `id`.
@@ -35173,15 +35293,15 @@ Updates a `Ticket` object with the given `id`. ```python from merge import Merge -from merge.resources.ticketing import PatchedTicketRequest +from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.partial_update( +client.crm.tasks.partial_update( id="id", - model=PatchedTicketRequest(), + model=PatchedTaskRequest(), ) ``` @@ -35206,7 +35326,7 @@ client.ticketing.tickets.partial_update(
-**model:** `PatchedTicketRequest` +**model:** `PatchedTaskRequest`
@@ -35242,126 +35362,7 @@ client.ticketing.tickets.partial_update(
-
client.ticketing.tickets.viewers_list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.viewers_list( - ticket_id="ticket_id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**ticket_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — 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). - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.ticketing.tickets.meta_patch_retrieve(...) +
client.crm.tasks.meta_patch_retrieve(...)
@@ -35373,7 +35374,7 @@ client.ticketing.tickets.viewers_list(
-Returns metadata for `Ticket` PATCHs. +Returns metadata for `Task` PATCHs.
@@ -35394,7 +35395,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_patch_retrieve( +client.crm.tasks.meta_patch_retrieve( id="id", ) @@ -35432,7 +35433,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve(...) +
client.crm.tasks.meta_post_retrieve()
@@ -35444,7 +35445,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Returns metadata for `Task` POSTs.
@@ -35465,7 +35466,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve() +client.crm.tasks.meta_post_retrieve() ``` @@ -35481,22 +35482,6 @@ client.ticketing.tickets.meta_post_retrieve()
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. - -
-
- -
-
- -**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35509,7 +35494,7 @@ client.ticketing.tickets.meta_post_retrieve()
-
client.ticketing.tickets.remote_field_classes_list(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -35542,7 +35527,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.remote_field_classes_list() +client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -35566,7 +35553,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this 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/).
@@ -35574,7 +35561,7 @@ client.ticketing.tickets.remote_field_classes_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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35582,7 +35569,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -35634,8 +35621,8 @@ client.ticketing.tickets.remote_field_classes_list()
-## Ticketing Users -
client.ticketing.users.list(...) +## Crm Users +
client.crm.users.list(...)
@@ -35668,7 +35655,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list() +client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -35708,7 +35697,7 @@ client.ticketing.users.list()
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive). +**email:** `typing.Optional[str]` — If provided, will only return users with this email.
@@ -35716,7 +35705,7 @@ client.ticketing.users.list()
-**expand:** `typing.Optional[UsersListRequestExpand]` — 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/).
@@ -35724,7 +35713,7 @@ client.ticketing.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/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35732,7 +35721,7 @@ client.ticketing.users.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -35780,14 +35769,6 @@ client.ticketing.users.list()
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35800,7 +35781,7 @@ client.ticketing.users.list()
-
client.ticketing.users.retrieve(...) +
client.crm.users.retrieve(...)
@@ -35833,7 +35814,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( +client.crm.users.retrieve( id="id", ) @@ -35859,7 +35840,185 @@ client.ticketing.users.retrieve(
-**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — 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_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**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. + +
+
+
+
+ + + + +
+ +
client.crm.users.ignore_create(...) +
+
+ +#### 📝 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 + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model_id:** `str` + +
+
+ +
+
+ +**request:** `IgnoreCommonModelRequest` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.crm.users.remote_field_classes_list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `RemoteFieldClass` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**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/).
@@ -35875,6 +36034,14 @@ client.ticketing.users.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -35883,6 +36050,30 @@ client.ticketing.users.retrieve(
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35895,8 +36086,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -35929,7 +36120,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.crm.webhook_receivers.list() ```
@@ -35957,7 +36148,7 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +
client.crm.webhook_receivers.create(...)
@@ -35990,7 +36181,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( +client.crm.webhook_receivers.create( event="event", is_active=True, ) @@ -36213,7 +36404,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounting_periods.list() +client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -36402,7 +36595,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounts.list() +client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37191,7 +37386,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.attachments.list() +client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37577,7 +37774,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.audit_trail.list() +client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37749,7 +37948,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.balance_sheets.list() +client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38002,7 +38203,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_accounts.list() +client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38340,7 +38543,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_transactions.list() +client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38742,7 +38947,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.cash_flow_statements.list() +client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38995,7 +39202,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.company_info.list() +client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39240,7 +39449,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.list() +client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39729,7 +39940,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.remote_field_classes_list() +client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39847,7 +40060,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.credit_notes.list() +client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40582,7 +40797,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.employees.list() +client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40835,7 +41052,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.list() +client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41095,6 +41314,7 @@ client = Merge( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -41323,7 +41543,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.lines_remote_field_classes_list() +client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41501,7 +41723,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.remote_field_classes_list() +client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41619,7 +41843,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.list() +client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41991,7 +42217,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.lines_remote_field_classes_list() +client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42169,7 +42397,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.remote_field_classes_list() +client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42785,7 +43015,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.general_ledger_transactions.list() +client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43126,7 +43358,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.income_statements.list() +client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43379,7 +43613,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.list() +client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43928,7 +44164,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.line_items_remote_field_classes_list() +client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44177,7 +44415,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.remote_field_classes_list() +client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44295,7 +44535,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.issues.list() +client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44545,7 +44787,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.items.list() +client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45147,7 +45391,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.list() +client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45519,7 +45765,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.lines_remote_field_classes_list() +client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45697,7 +45945,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.remote_field_classes_list() +client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45999,7 +46249,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.linked_accounts.list() +client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46251,7 +46503,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_methods.list() +client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46440,7 +46694,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_terms.list() +client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46645,7 +46901,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.list() +client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47130,7 +47388,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.line_items_remote_field_classes_list() +client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47379,7 +47639,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.remote_field_classes_list() +client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47585,7 +47847,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.projects.list() +client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47838,7 +48102,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.list() +client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48242,7 +48508,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.line_items_remote_field_classes_list() +client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48420,7 +48688,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.remote_field_classes_list() +client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48610,7 +48880,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.sync_status.list() +client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48750,7 +49022,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tax_rates.list() +client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49011,7 +49285,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tracking_categories.list() +client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49320,7 +49596,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.transactions.list() +client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49589,7 +49867,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.vendor_credits.list() +client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` diff --git a/src/merge/client.py b/src/merge/client.py index c55e9a2a..037095bc 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -82,11 +82,11 @@ def __init__( else httpx.Client(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.ats = AtsClient(client_wrapper=self._client_wrapper) - self.crm = CrmClient(client_wrapper=self._client_wrapper) self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) self.hris = HrisClient(client_wrapper=self._client_wrapper) self.ticketing = TicketingClient(client_wrapper=self._client_wrapper) + self.ats = AtsClient(client_wrapper=self._client_wrapper) + self.crm = CrmClient(client_wrapper=self._client_wrapper) self.accounting = AccountingClient(client_wrapper=self._client_wrapper) @@ -159,11 +159,11 @@ def __init__( else httpx.AsyncClient(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) - self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper) self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper) self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) + self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) + self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper) self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper) diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 955b5565..671b0562 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.1.1", + "User-Agent": "MergePythonClient/2.2.1", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.1.1", + "X-Fern-SDK-Version": "2.2.1", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/core/force_multipart.py b/src/merge/core/force_multipart.py index ae24ccff..5440913f 100644 --- a/src/merge/core/force_multipart.py +++ b/src/merge/core/force_multipart.py @@ -1,7 +1,9 @@ # This file was auto-generated by Fern from our API Definition. +from typing import Any, Dict -class ForceMultipartDict(dict): + +class ForceMultipartDict(Dict[str, Any]): """ A dictionary subclass that always evaluates to True in boolean contexts. @@ -9,7 +11,7 @@ class ForceMultipartDict(dict): the dictionary is empty, which would normally evaluate to False. """ - def __bool__(self): + def __bool__(self) -> bool: return True diff --git a/src/merge/core/http_response.py b/src/merge/core/http_response.py index 48a1798a..2479747e 100644 --- a/src/merge/core/http_response.py +++ b/src/merge/core/http_response.py @@ -4,8 +4,8 @@ import httpx +# Generic to represent the underlying type of the data wrapped by the HTTP response. T = TypeVar("T") -"""Generic to represent the underlying type of the data wrapped by the HTTP response.""" class BaseHttpResponse: diff --git a/src/merge/core/unchecked_base_model.py b/src/merge/core/unchecked_base_model.py index e04a6f81..ae59845f 100644 --- a/src/merge/core/unchecked_base_model.py +++ b/src/merge/core/unchecked_base_model.py @@ -186,7 +186,7 @@ def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], obj def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: base_type = get_origin(type_) or type_ union_type = type_ - if base_type == typing_extensions.Annotated: + if base_type == typing_extensions.Annotated: # type: ignore[comparison-overlap] union_type = get_args(type_)[0] annotated_metadata = get_args(type_)[1:] for metadata in annotated_metadata: @@ -217,11 +217,11 @@ def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> ty return None base_type = get_origin(type_) or type_ - is_annotated = base_type == typing_extensions.Annotated + is_annotated = base_type == typing_extensions.Annotated # type: ignore[comparison-overlap] maybe_annotation_members = get_args(type_) is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0])) - if base_type == typing.Any: + if base_type == typing.Any: # type: ignore[comparison-overlap] return object_ if base_type == dict: diff --git a/src/merge/resources/accounting/resources/accounting_periods/client.py b/src/merge/resources/accounting/resources/accounting_periods/client.py index 4008dfb9..ea3dd2a4 100644 --- a/src/merge/resources/accounting/resources/accounting_periods/client.py +++ b/src/merge/resources/accounting/resources/accounting_periods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounting_periods.list() + client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.accounting_periods.list() + await client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/accounts/client.py b/src/merge/resources/accounting/resources/accounts/client.py index 66260f6f..2cd1cb34 100644 --- a/src/merge/resources/accounting/resources/accounts/client.py +++ b/src/merge/resources/accounting/resources/accounts/client.py @@ -133,7 +133,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounts.list() + client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -415,7 +417,9 @@ async def list( async def main() -> None: - await client.accounting.accounts.list() + await client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/attachments/client.py b/src/merge/resources/accounting/resources/attachments/client.py index 4cd8b43c..ca9a16a7 100644 --- a/src/merge/resources/accounting/resources/attachments/client.py +++ b/src/merge/resources/accounting/resources/attachments/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.attachments.list() + client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -333,7 +335,9 @@ async def list( async def main() -> None: - await client.accounting.attachments.list() + await client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/audit_trail/client.py b/src/merge/resources/accounting/resources/audit_trail/client.py index 6d0d1886..be175372 100644 --- a/src/merge/resources/accounting/resources/audit_trail/client.py +++ b/src/merge/resources/accounting/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.audit_trail.list() + client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.accounting.audit_trail.list() + await client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/balance_sheets/client.py b/src/merge/resources/accounting/resources/balance_sheets/client.py index 3f90d213..9f18736a 100644 --- a/src/merge/resources/accounting/resources/balance_sheets/client.py +++ b/src/merge/resources/accounting/resources/balance_sheets/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.balance_sheets.list() + client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.balance_sheets.list() + await client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py index b1368bdf..0063c805 100644 --- a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py @@ -76,7 +76,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_accounts.list() + client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_accounts.list() + await client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py index e8408b1d..5def8262 100644 --- a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_transactions.list() + client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -347,7 +349,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_transactions.list() + await client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/cash_flow_statements/client.py b/src/merge/resources/accounting/resources/cash_flow_statements/client.py index 59b2a40e..632235a4 100644 --- a/src/merge/resources/accounting/resources/cash_flow_statements/client.py +++ b/src/merge/resources/accounting/resources/cash_flow_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.cash_flow_statements.list() + client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.cash_flow_statements.list() + await client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/company_info/client.py b/src/merge/resources/accounting/resources/company_info/client.py index 342b4fbc..a4a4fbc6 100644 --- a/src/merge/resources/accounting/resources/company_info/client.py +++ b/src/merge/resources/accounting/resources/company_info/client.py @@ -97,7 +97,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.company_info.list() + client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -260,7 +262,9 @@ async def list( async def main() -> None: - await client.accounting.company_info.list() + await client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/contacts/client.py b/src/merge/resources/accounting/resources/contacts/client.py index 6a425b25..66345884 100644 --- a/src/merge/resources/accounting/resources/contacts/client.py +++ b/src/merge/resources/accounting/resources/contacts/client.py @@ -140,7 +140,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.list() + client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -364,7 +366,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.remote_field_classes_list() + client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -505,7 +509,9 @@ async def list( async def main() -> None: - await client.accounting.contacts.list() + await client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -761,7 +767,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.contacts.remote_field_classes_list() + await client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/credit_notes/client.py b/src/merge/resources/accounting/resources/credit_notes/client.py index 91989aab..8b535864 100644 --- a/src/merge/resources/accounting/resources/credit_notes/client.py +++ b/src/merge/resources/accounting/resources/credit_notes/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.credit_notes.list() + client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -399,7 +401,9 @@ async def list( async def main() -> None: - await client.accounting.credit_notes.list() + await client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/employees/client.py b/src/merge/resources/accounting/resources/employees/client.py index eef0756f..73f4af0b 100644 --- a/src/merge/resources/accounting/resources/employees/client.py +++ b/src/merge/resources/accounting/resources/employees/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.employees.list() + client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.employees.list() + await client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expense_reports/client.py b/src/merge/resources/accounting/resources/expense_reports/client.py index 2a30eb5f..0b2585d5 100644 --- a/src/merge/resources/accounting/resources/expense_reports/client.py +++ b/src/merge/resources/accounting/resources/expense_reports/client.py @@ -114,7 +114,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.list() + client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -245,6 +247,7 @@ def lines_list( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.lines_list( @@ -373,7 +376,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.lines_remote_field_classes_list() + client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -468,7 +473,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.remote_field_classes_list() + client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +588,9 @@ async def list( async def main() -> None: - await client.accounting.expense_reports.list() + await client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -728,6 +737,7 @@ async def lines_list( async def main() -> None: await client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -872,7 +882,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.lines_remote_field_classes_list() + await client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -983,7 +995,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.remote_field_classes_list() + await client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expenses/client.py b/src/merge/resources/accounting/resources/expenses/client.py index af655c88..c268fc18 100644 --- a/src/merge/resources/accounting/resources/expenses/client.py +++ b/src/merge/resources/accounting/resources/expenses/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.list() + client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.lines_remote_field_classes_list() + client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.remote_field_classes_list() + client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.expenses.list() + await client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.lines_remote_field_classes_list() + await client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.remote_field_classes_list() + await client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py index a4f2eff3..77139d04 100644 --- a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py +++ b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.general_ledger_transactions.list() + client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.general_ledger_transactions.list() + await client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/income_statements/client.py b/src/merge/resources/accounting/resources/income_statements/client.py index 83d098da..79cd108f 100644 --- a/src/merge/resources/accounting/resources/income_statements/client.py +++ b/src/merge/resources/accounting/resources/income_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.income_statements.list() + client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.income_statements.list() + await client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/invoices/client.py b/src/merge/resources/accounting/resources/invoices/client.py index d7cdb07f..f5a51718 100644 --- a/src/merge/resources/accounting/resources/invoices/client.py +++ b/src/merge/resources/accounting/resources/invoices/client.py @@ -156,7 +156,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.list() + client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -407,7 +409,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.line_items_remote_field_classes_list() + client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -533,7 +537,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.remote_field_classes_list() + client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -688,7 +694,9 @@ async def list( async def main() -> None: - await client.accounting.invoices.list() + await client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -971,7 +979,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.line_items_remote_field_classes_list() + await client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1123,7 +1133,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.remote_field_classes_list() + await client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/issues/client.py b/src/merge/resources/accounting/resources/issues/client.py index 68e0cc48..18eec115 100644 --- a/src/merge/resources/accounting/resources/issues/client.py +++ b/src/merge/resources/accounting/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.issues.list() + client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.accounting.issues.list() + await client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/items/client.py b/src/merge/resources/accounting/resources/items/client.py index 395dd3e7..e66fe427 100644 --- a/src/merge/resources/accounting/resources/items/client.py +++ b/src/merge/resources/accounting/resources/items/client.py @@ -116,7 +116,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.items.list() + client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -460,7 +462,9 @@ async def list( async def main() -> None: - await client.accounting.items.list() + await client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/journal_entries/client.py b/src/merge/resources/accounting/resources/journal_entries/client.py index f35ff8eb..1a7d47ed 100644 --- a/src/merge/resources/accounting/resources/journal_entries/client.py +++ b/src/merge/resources/accounting/resources/journal_entries/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.list() + client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.lines_remote_field_classes_list() + client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.remote_field_classes_list() + client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.journal_entries.list() + await client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.lines_remote_field_classes_list() + await client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.remote_field_classes_list() + await client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/linked_accounts/client.py b/src/merge/resources/accounting/resources/linked_accounts/client.py index df102c2b..2a5024cd 100644 --- a/src/merge/resources/accounting/resources/linked_accounts/client.py +++ b/src/merge/resources/accounting/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.linked_accounts.list() + client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.accounting.linked_accounts.list() + await client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_methods/client.py b/src/merge/resources/accounting/resources/payment_methods/client.py index ee070e4f..2b8226d6 100644 --- a/src/merge/resources/accounting/resources/payment_methods/client.py +++ b/src/merge/resources/accounting/resources/payment_methods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_methods.list() + client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.payment_methods.list() + await client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_terms/client.py b/src/merge/resources/accounting/resources/payment_terms/client.py index 7de8f6a7..7f0e7f70 100644 --- a/src/merge/resources/accounting/resources/payment_terms/client.py +++ b/src/merge/resources/accounting/resources/payment_terms/client.py @@ -74,7 +74,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_terms.list() + client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -212,7 +214,9 @@ async def list( async def main() -> None: - await client.accounting.payment_terms.list() + await client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payments/client.py b/src/merge/resources/accounting/resources/payments/client.py index 473acf56..c6fdbb43 100644 --- a/src/merge/resources/accounting/resources/payments/client.py +++ b/src/merge/resources/accounting/resources/payments/client.py @@ -129,7 +129,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.list() + client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -364,7 +366,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.line_items_remote_field_classes_list() + client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -490,7 +494,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.remote_field_classes_list() + client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -619,7 +625,9 @@ async def list( async def main() -> None: - await client.accounting.payments.list() + await client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -886,7 +894,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.payments.line_items_remote_field_classes_list() + await client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1038,7 +1048,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.payments.remote_field_classes_list() + await client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/projects/client.py b/src/merge/resources/accounting/resources/projects/client.py index 4afffa7e..a7335b20 100644 --- a/src/merge/resources/accounting/resources/projects/client.py +++ b/src/merge/resources/accounting/resources/projects/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.projects.list() + client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -269,7 +271,9 @@ async def list( async def main() -> None: - await client.accounting.projects.list() + await client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/purchase_orders/client.py b/src/merge/resources/accounting/resources/purchase_orders/client.py index 4b7a1931..5b6a4ab6 100644 --- a/src/merge/resources/accounting/resources/purchase_orders/client.py +++ b/src/merge/resources/accounting/resources/purchase_orders/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.list() + client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -322,7 +324,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.line_items_remote_field_classes_list() + client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -417,7 +421,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.remote_field_classes_list() + client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -546,7 +552,9 @@ async def list( async def main() -> None: - await client.accounting.purchase_orders.list() + await client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -764,7 +772,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.line_items_remote_field_classes_list() + await client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -875,7 +885,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.remote_field_classes_list() + await client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/sync_status/client.py b/src/merge/resources/accounting/resources/sync_status/client.py index b1158fdd..3c1b31e8 100644 --- a/src/merge/resources/accounting/resources/sync_status/client.py +++ b/src/merge/resources/accounting/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.sync_status.list() + client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.accounting.sync_status.list() + await client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tax_rates/client.py b/src/merge/resources/accounting/resources/tax_rates/client.py index fa872829..29f1ca42 100644 --- a/src/merge/resources/accounting/resources/tax_rates/client.py +++ b/src/merge/resources/accounting/resources/tax_rates/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tax_rates.list() + client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -276,7 +278,9 @@ async def list( async def main() -> None: - await client.accounting.tax_rates.list() + await client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tracking_categories/client.py b/src/merge/resources/accounting/resources/tracking_categories/client.py index 61b7c215..bdd73f97 100644 --- a/src/merge/resources/accounting/resources/tracking_categories/client.py +++ b/src/merge/resources/accounting/resources/tracking_categories/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tracking_categories.list() + client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category_type=category_type, @@ -322,7 +324,9 @@ async def list( async def main() -> None: - await client.accounting.tracking_categories.list() + await client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/transactions/client.py b/src/merge/resources/accounting/resources/transactions/client.py index 68b26ccd..0dd5c1d1 100644 --- a/src/merge/resources/accounting/resources/transactions/client.py +++ b/src/merge/resources/accounting/resources/transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.transactions.list() + client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.transactions.list() + await client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/vendor_credits/client.py b/src/merge/resources/accounting/resources/vendor_credits/client.py index 077ae72f..35f220c2 100644 --- a/src/merge/resources/accounting/resources/vendor_credits/client.py +++ b/src/merge/resources/accounting/resources/vendor_credits/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.vendor_credits.list() + client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.accounting.vendor_credits.list() + await client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/types/remote_field_class.py b/src/merge/resources/accounting/types/remote_field_class.py index e5672719..4126b4e7 100644 --- a/src/merge/resources/accounting/types/remote_field_class.py +++ b/src/merge/resources/accounting/types/remote_field_class.py @@ -16,6 +16,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[FieldTypeEnum] = None field_format: typing.Optional[FieldFormatEnum] = None diff --git a/src/merge/resources/ats/resources/activities/client.py b/src/merge/resources/ats/resources/activities/client.py index 4ce5438b..b3070acf 100644 --- a/src/merge/resources/ats/resources/activities/client.py +++ b/src/merge/resources/ats/resources/activities/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.activities.list() + client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -387,7 +389,9 @@ async def list( async def main() -> None: - await client.ats.activities.list() + await client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/applications/client.py b/src/merge/resources/ats/resources/applications/client.py index 36f211ba..e4f5f142 100644 --- a/src/merge/resources/ats/resources/applications/client.py +++ b/src/merge/resources/ats/resources/applications/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.applications.list() + client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -473,7 +475,9 @@ async def list( async def main() -> None: - await client.ats.applications.list() + await client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/attachments/client.py b/src/merge/resources/ats/resources/attachments/client.py index 02e1d145..ba606803 100644 --- a/src/merge/resources/ats/resources/attachments/client.py +++ b/src/merge/resources/ats/resources/attachments/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.attachments.list() + client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -383,7 +385,9 @@ async def list( async def main() -> None: - await client.ats.attachments.list() + await client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/audit_trail/client.py b/src/merge/resources/ats/resources/audit_trail/client.py index 51f2e0df..a9942a91 100644 --- a/src/merge/resources/ats/resources/audit_trail/client.py +++ b/src/merge/resources/ats/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.audit_trail.list() + client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ats.audit_trail.list() + await client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/candidates/client.py b/src/merge/resources/ats/resources/candidates/client.py index 418b1d66..434b18a1 100644 --- a/src/merge/resources/ats/resources/candidates/client.py +++ b/src/merge/resources/ats/resources/candidates/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.candidates.list() + client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -522,7 +524,9 @@ async def list( async def main() -> None: - await client.ats.candidates.list() + await client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/departments/client.py b/src/merge/resources/ats/resources/departments/client.py index 549ad189..d543959c 100644 --- a/src/merge/resources/ats/resources/departments/client.py +++ b/src/merge/resources/ats/resources/departments/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.departments.list() + client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.departments.list() + await client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/eeocs/client.py b/src/merge/resources/ats/resources/eeocs/client.py index 7c83afcb..4a848651 100644 --- a/src/merge/resources/ats/resources/eeocs/client.py +++ b/src/merge/resources/ats/resources/eeocs/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.eeocs.list() + client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.ats.eeocs.list() + await client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/interviews/client.py b/src/merge/resources/ats/resources/interviews/client.py index 9330c06e..9acbef5c 100644 --- a/src/merge/resources/ats/resources/interviews/client.py +++ b/src/merge/resources/ats/resources/interviews/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.interviews.list() + client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -412,7 +414,9 @@ async def list( async def main() -> None: - await client.ats.interviews.list() + await client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/issues/client.py b/src/merge/resources/ats/resources/issues/client.py index 07cdb53b..c429339f 100644 --- a/src/merge/resources/ats/resources/issues/client.py +++ b/src/merge/resources/ats/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.issues.list() + client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ats.issues.list() + await client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_interview_stages/client.py b/src/merge/resources/ats/resources/job_interview_stages/client.py index 1133af8e..9dbb31c6 100644 --- a/src/merge/resources/ats/resources/job_interview_stages/client.py +++ b/src/merge/resources/ats/resources/job_interview_stages/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_interview_stages.list() + client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.ats.job_interview_stages.list() + await client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_postings/client.py b/src/merge/resources/ats/resources/job_postings/client.py index eec24b7e..7187c098 100644 --- a/src/merge/resources/ats/resources/job_postings/client.py +++ b/src/merge/resources/ats/resources/job_postings/client.py @@ -106,7 +106,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_postings.list() + client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -280,7 +282,9 @@ async def list( async def main() -> None: - await client.ats.job_postings.list() + await client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/jobs/client.py b/src/merge/resources/ats/resources/jobs/client.py index 73d353e0..1dc28a48 100644 --- a/src/merge/resources/ats/resources/jobs/client.py +++ b/src/merge/resources/ats/resources/jobs/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.jobs.list() + client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( code=code, @@ -268,6 +270,7 @@ def screening_questions_list( ) client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.screening_questions_list( @@ -399,7 +402,9 @@ async def list( async def main() -> None: - await client.ats.jobs.list() + await client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -557,6 +562,7 @@ async def screening_questions_list( async def main() -> None: await client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ats/resources/linked_accounts/client.py b/src/merge/resources/ats/resources/linked_accounts/client.py index cd72d270..d11c05c4 100644 --- a/src/merge/resources/ats/resources/linked_accounts/client.py +++ b/src/merge/resources/ats/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.linked_accounts.list() + client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ats.linked_accounts.list() + await client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offers/client.py b/src/merge/resources/ats/resources/offers/client.py index 910b32ad..4737bf2e 100644 --- a/src/merge/resources/ats/resources/offers/client.py +++ b/src/merge/resources/ats/resources/offers/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offers.list() + client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -306,7 +308,9 @@ async def list( async def main() -> None: - await client.ats.offers.list() + await client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offices/client.py b/src/merge/resources/ats/resources/offices/client.py index 323998d6..173aa017 100644 --- a/src/merge/resources/ats/resources/offices/client.py +++ b/src/merge/resources/ats/resources/offices/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offices.list() + client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.offices.list() + await client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/reject_reasons/client.py b/src/merge/resources/ats/resources/reject_reasons/client.py index 36cf953e..107fb931 100644 --- a/src/merge/resources/ats/resources/reject_reasons/client.py +++ b/src/merge/resources/ats/resources/reject_reasons/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.reject_reasons.list() + client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.reject_reasons.list() + await client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/scorecards/client.py b/src/merge/resources/ats/resources/scorecards/client.py index 0df3750e..d24fa3cf 100644 --- a/src/merge/resources/ats/resources/scorecards/client.py +++ b/src/merge/resources/ats/resources/scorecards/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.scorecards.list() + client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -315,7 +317,9 @@ async def list( async def main() -> None: - await client.ats.scorecards.list() + await client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/sync_status/client.py b/src/merge/resources/ats/resources/sync_status/client.py index c87a7fcd..7eebd768 100644 --- a/src/merge/resources/ats/resources/sync_status/client.py +++ b/src/merge/resources/ats/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.sync_status.list() + client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ats.sync_status.list() + await client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/tags/client.py b/src/merge/resources/ats/resources/tags/client.py index 8e447a7d..9aa39684 100644 --- a/src/merge/resources/ats/resources/tags/client.py +++ b/src/merge/resources/ats/resources/tags/client.py @@ -90,7 +90,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.tags.list() + client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -194,7 +196,9 @@ async def list( async def main() -> None: - await client.ats.tags.list() + await client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/users/client.py b/src/merge/resources/ats/resources/users/client.py index b09b7e5b..0046a79f 100644 --- a/src/merge/resources/ats/resources/users/client.py +++ b/src/merge/resources/ats/resources/users/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.users.list() + client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -281,7 +283,9 @@ async def list( async def main() -> None: - await client.ats.users.list() + await client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/accounts/client.py b/src/merge/resources/crm/resources/accounts/client.py index b8b90549..88508090 100644 --- a/src/merge/resources/crm/resources/accounts/client.py +++ b/src/merge/resources/crm/resources/accounts/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.list() + client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -409,7 +411,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.remote_field_classes_list() + client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -527,7 +531,9 @@ async def list( async def main() -> None: - await client.crm.accounts.list() + await client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -871,7 +877,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.accounts.remote_field_classes_list() + await client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/association_types/client.py b/src/merge/resources/crm/resources/association_types/client.py index b58c597e..cb747530 100644 --- a/src/merge/resources/crm/resources/association_types/client.py +++ b/src/merge/resources/crm/resources/association_types/client.py @@ -106,6 +106,7 @@ def custom_object_classes_association_types_list( ) client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_association_types_list( @@ -386,6 +387,7 @@ async def custom_object_classes_association_types_list( async def main() -> None: await client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/associations/client.py b/src/merge/resources/crm/resources/associations/client.py index 7591b917..e2d95ae8 100644 --- a/src/merge/resources/crm/resources/associations/client.py +++ b/src/merge/resources/crm/resources/associations/client.py @@ -108,6 +108,7 @@ def custom_object_classes_custom_objects_associations_list( client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_associations_list( @@ -302,6 +303,7 @@ async def main() -> None: await client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/audit_trail/client.py b/src/merge/resources/crm/resources/audit_trail/client.py index ec2a114a..71e19cdb 100644 --- a/src/merge/resources/crm/resources/audit_trail/client.py +++ b/src/merge/resources/crm/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.audit_trail.list() + client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.crm.audit_trail.list() + await client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/contacts/client.py b/src/merge/resources/crm/resources/contacts/client.py index 6359a159..a51b2f47 100644 --- a/src/merge/resources/crm/resources/contacts/client.py +++ b/src/merge/resources/crm/resources/contacts/client.py @@ -122,7 +122,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.list() + client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -459,7 +461,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.remote_field_classes_list() + client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +585,9 @@ async def list( async def main() -> None: - await client.crm.contacts.list() + await client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -976,7 +982,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.contacts.remote_field_classes_list() + await client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_object_classes/client.py b/src/merge/resources/crm/resources/custom_object_classes/client.py index eedd7490..9289295c 100644 --- a/src/merge/resources/crm/resources/custom_object_classes/client.py +++ b/src/merge/resources/crm/resources/custom_object_classes/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_object_classes.list() + client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.crm.custom_object_classes.list() + await client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_objects/client.py b/src/merge/resources/crm/resources/custom_objects/client.py index aeb76cc5..41354143 100644 --- a/src/merge/resources/crm/resources/custom_objects/client.py +++ b/src/merge/resources/crm/resources/custom_objects/client.py @@ -107,6 +107,7 @@ def custom_object_classes_custom_objects_list( ) client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_list( @@ -335,7 +336,9 @@ def custom_object_classes_custom_objects_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.custom_object_classes_custom_objects_remote_field_classes_list( cursor=cursor, @@ -446,6 +449,7 @@ async def custom_object_classes_custom_objects_list( async def main() -> None: await client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -706,7 +710,9 @@ async def custom_object_classes_custom_objects_remote_field_classes_list( async def main() -> None: - await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagement_types/client.py b/src/merge/resources/crm/resources/engagement_types/client.py index 2535a49e..df7faa0f 100644 --- a/src/merge/resources/crm/resources/engagement_types/client.py +++ b/src/merge/resources/crm/resources/engagement_types/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.list() + client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.remote_field_classes_list() + client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.engagement_types.list() + await client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagement_types.remote_field_classes_list() + await client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagements/client.py b/src/merge/resources/crm/resources/engagements/client.py index 0bc28fd7..42174adf 100644 --- a/src/merge/resources/crm/resources/engagements/client.py +++ b/src/merge/resources/crm/resources/engagements/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.list() + client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -411,7 +413,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.remote_field_classes_list() + client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -529,7 +533,9 @@ async def list( async def main() -> None: - await client.crm.engagements.list() + await client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -873,7 +879,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagements.remote_field_classes_list() + await client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/issues/client.py b/src/merge/resources/crm/resources/issues/client.py index e967f73c..a9237e53 100644 --- a/src/merge/resources/crm/resources/issues/client.py +++ b/src/merge/resources/crm/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.issues.list() + client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.crm.issues.list() + await client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/leads/client.py b/src/merge/resources/crm/resources/leads/client.py index ba711e50..793ea73b 100644 --- a/src/merge/resources/crm/resources/leads/client.py +++ b/src/merge/resources/crm/resources/leads/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.list() + client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( converted_account_id=converted_account_id, @@ -343,7 +345,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.remote_field_classes_list() + client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -473,7 +477,9 @@ async def list( async def main() -> None: - await client.crm.leads.list() + await client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -720,7 +726,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.leads.remote_field_classes_list() + await client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/linked_accounts/client.py b/src/merge/resources/crm/resources/linked_accounts/client.py index 479471b9..80b19ced 100644 --- a/src/merge/resources/crm/resources/linked_accounts/client.py +++ b/src/merge/resources/crm/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.linked_accounts.list() + client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.crm.linked_accounts.list() + await client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/notes/client.py b/src/merge/resources/crm/resources/notes/client.py index 5ed1e428..f7fbd530 100644 --- a/src/merge/resources/crm/resources/notes/client.py +++ b/src/merge/resources/crm/resources/notes/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.list() + client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -338,7 +340,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.remote_field_classes_list() + client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -464,7 +468,9 @@ async def list( async def main() -> None: - await client.crm.notes.list() + await client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -710,7 +716,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.notes.remote_field_classes_list() + await client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/opportunities/client.py b/src/merge/resources/crm/resources/opportunities/client.py index c11ecf96..9e0e15e0 100644 --- a/src/merge/resources/crm/resources/opportunities/client.py +++ b/src/merge/resources/crm/resources/opportunities/client.py @@ -142,7 +142,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.list() + client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -451,7 +453,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.remote_field_classes_list() + client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -593,7 +597,9 @@ async def list( async def main() -> None: - await client.crm.opportunities.list() + await client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -952,7 +958,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.opportunities.remote_field_classes_list() + await client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/stages/client.py b/src/merge/resources/crm/resources/stages/client.py index fd69a8ba..efe35689 100644 --- a/src/merge/resources/crm/resources/stages/client.py +++ b/src/merge/resources/crm/resources/stages/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.list() + client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.remote_field_classes_list() + client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.stages.list() + await client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.stages.remote_field_classes_list() + await client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/sync_status/client.py b/src/merge/resources/crm/resources/sync_status/client.py index 8f210d28..9a72c5cc 100644 --- a/src/merge/resources/crm/resources/sync_status/client.py +++ b/src/merge/resources/crm/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.sync_status.list() + client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.crm.sync_status.list() + await client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/tasks/client.py b/src/merge/resources/crm/resources/tasks/client.py index 4e61ae97..15a16cee 100644 --- a/src/merge/resources/crm/resources/tasks/client.py +++ b/src/merge/resources/crm/resources/tasks/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.list() + client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -401,7 +403,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.remote_field_classes_list() + client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -511,7 +515,9 @@ async def list( async def main() -> None: - await client.crm.tasks.list() + await client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -853,7 +859,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.tasks.remote_field_classes_list() + await client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/users/client.py b/src/merge/resources/crm/resources/users/client.py index 1fd91cdb..d5671794 100644 --- a/src/merge/resources/crm/resources/users/client.py +++ b/src/merge/resources/crm/resources/users/client.py @@ -104,7 +104,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.list() + client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -277,7 +279,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.remote_field_classes_list() + client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -387,7 +391,9 @@ async def list( async def main() -> None: - await client.crm.users.list() + await client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -584,7 +590,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.users.remote_field_classes_list() + await client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/types/remote_field_class.py b/src/merge/resources/crm/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/crm/types/remote_field_class.py +++ b/src/merge/resources/crm/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None diff --git a/src/merge/resources/filestorage/resources/audit_trail/client.py b/src/merge/resources/filestorage/resources/audit_trail/client.py index aef09b3e..05d30b6f 100644 --- a/src/merge/resources/filestorage/resources/audit_trail/client.py +++ b/src/merge/resources/filestorage/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.audit_trail.list() + client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.filestorage.audit_trail.list() + await client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/drives/client.py b/src/merge/resources/filestorage/resources/drives/client.py index 580b2c96..655ed370 100644 --- a/src/merge/resources/filestorage/resources/drives/client.py +++ b/src/merge/resources/filestorage/resources/drives/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.drives.list() + client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.drives.list() + await client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/files/client.py b/src/merge/resources/filestorage/resources/files/client.py index b18ef7d9..5910bfb6 100644 --- a/src/merge/resources/filestorage/resources/files/client.py +++ b/src/merge/resources/filestorage/resources/files/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.list() + client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -389,7 +391,9 @@ def download_request_meta_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.download_request_meta_list() + client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.download_request_meta_list( created_after=created_after, @@ -543,7 +547,9 @@ async def list( async def main() -> None: - await client.filestorage.files.list() + await client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -838,7 +844,9 @@ async def download_request_meta_list( async def main() -> None: - await client.filestorage.files.download_request_meta_list() + await client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/folders/client.py b/src/merge/resources/filestorage/resources/folders/client.py index c2a45b1f..85276beb 100644 --- a/src/merge/resources/filestorage/resources/folders/client.py +++ b/src/merge/resources/filestorage/resources/folders/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.folders.list() + client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.filestorage.folders.list() + await client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/groups/client.py b/src/merge/resources/filestorage/resources/groups/client.py index 5e112f27..9db5bbc6 100644 --- a/src/merge/resources/filestorage/resources/groups/client.py +++ b/src/merge/resources/filestorage/resources/groups/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.groups.list() + client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.filestorage.groups.list() + await client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/issues/client.py b/src/merge/resources/filestorage/resources/issues/client.py index c99f2054..888a1f8e 100644 --- a/src/merge/resources/filestorage/resources/issues/client.py +++ b/src/merge/resources/filestorage/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.issues.list() + client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.filestorage.issues.list() + await client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/linked_accounts/client.py b/src/merge/resources/filestorage/resources/linked_accounts/client.py index fc7fe947..8ab62895 100644 --- a/src/merge/resources/filestorage/resources/linked_accounts/client.py +++ b/src/merge/resources/filestorage/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.linked_accounts.list() + client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.filestorage.linked_accounts.list() + await client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/sync_status/client.py b/src/merge/resources/filestorage/resources/sync_status/client.py index 34d83f4d..4611a846 100644 --- a/src/merge/resources/filestorage/resources/sync_status/client.py +++ b/src/merge/resources/filestorage/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.sync_status.list() + client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.filestorage.sync_status.list() + await client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/users/client.py b/src/merge/resources/filestorage/resources/users/client.py index 4616da59..dc0d037e 100644 --- a/src/merge/resources/filestorage/resources/users/client.py +++ b/src/merge/resources/filestorage/resources/users/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.users.list() + client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.users.list() + await client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/audit_trail/client.py b/src/merge/resources/hris/resources/audit_trail/client.py index 7f5d6791..4f8aa7d3 100644 --- a/src/merge/resources/hris/resources/audit_trail/client.py +++ b/src/merge/resources/hris/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.audit_trail.list() + client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.hris.audit_trail.list() + await client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/bank_info/client.py b/src/merge/resources/hris/resources/bank_info/client.py index baa4ff18..8923a387 100644 --- a/src/merge/resources/hris/resources/bank_info/client.py +++ b/src/merge/resources/hris/resources/bank_info/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.bank_info.list() + client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -330,7 +332,9 @@ async def list( async def main() -> None: - await client.hris.bank_info.list() + await client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/benefits/client.py b/src/merge/resources/hris/resources/benefits/client.py index 76ed436e..a6f19dad 100644 --- a/src/merge/resources/hris/resources/benefits/client.py +++ b/src/merge/resources/hris/resources/benefits/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.benefits.list() + client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.benefits.list() + await client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/companies/client.py b/src/merge/resources/hris/resources/companies/client.py index 3c5355ea..5b756b5f 100644 --- a/src/merge/resources/hris/resources/companies/client.py +++ b/src/merge/resources/hris/resources/companies/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.companies.list() + client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.companies.list() + await client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/dependents/client.py b/src/merge/resources/hris/resources/dependents/client.py index 7f2f7710..bfd225ff 100644 --- a/src/merge/resources/hris/resources/dependents/client.py +++ b/src/merge/resources/hris/resources/dependents/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.dependents.list() + client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.hris.dependents.list() + await client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employee_payroll_runs/client.py b/src/merge/resources/hris/resources/employee_payroll_runs/client.py index 93dd56df..0ab87bf7 100644 --- a/src/merge/resources/hris/resources/employee_payroll_runs/client.py +++ b/src/merge/resources/hris/resources/employee_payroll_runs/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employee_payroll_runs.list() + client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -314,7 +316,9 @@ async def list( async def main() -> None: - await client.hris.employee_payroll_runs.list() + await client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employees/client.py b/src/merge/resources/hris/resources/employees/client.py index 7c0498de..f1f60ae1 100644 --- a/src/merge/resources/hris/resources/employees/client.py +++ b/src/merge/resources/hris/resources/employees/client.py @@ -201,7 +201,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employees.list() + client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -612,7 +614,9 @@ async def list( async def main() -> None: - await client.hris.employees.list() + await client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employer_benefits/client.py b/src/merge/resources/hris/resources/employer_benefits/client.py index 3201e062..11737216 100644 --- a/src/merge/resources/hris/resources/employer_benefits/client.py +++ b/src/merge/resources/hris/resources/employer_benefits/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employer_benefits.list() + client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.employer_benefits.list() + await client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employments/client.py b/src/merge/resources/hris/resources/employments/client.py index 22371621..581e1875 100644 --- a/src/merge/resources/hris/resources/employments/client.py +++ b/src/merge/resources/hris/resources/employments/client.py @@ -118,7 +118,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employments.list() + client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -311,7 +313,9 @@ async def list( async def main() -> None: - await client.hris.employments.list() + await client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/groups/client.py b/src/merge/resources/hris/resources/groups/client.py index 454392ad..60d862f2 100644 --- a/src/merge/resources/hris/resources/groups/client.py +++ b/src/merge/resources/hris/resources/groups/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.groups.list() + client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.hris.groups.list() + await client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/issues/client.py b/src/merge/resources/hris/resources/issues/client.py index 3839055e..02a8ddc3 100644 --- a/src/merge/resources/hris/resources/issues/client.py +++ b/src/merge/resources/hris/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.issues.list() + client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.hris.issues.list() + await client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/linked_accounts/client.py b/src/merge/resources/hris/resources/linked_accounts/client.py index fb325a41..464827a7 100644 --- a/src/merge/resources/hris/resources/linked_accounts/client.py +++ b/src/merge/resources/hris/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.linked_accounts.list() + client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.hris.linked_accounts.list() + await client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/locations/client.py b/src/merge/resources/hris/resources/locations/client.py index b8b18833..12fa7031 100644 --- a/src/merge/resources/hris/resources/locations/client.py +++ b/src/merge/resources/hris/resources/locations/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.locations.list() + client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -292,7 +294,9 @@ async def list( async def main() -> None: - await client.hris.locations.list() + await client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/pay_groups/client.py b/src/merge/resources/hris/resources/pay_groups/client.py index be59663a..abccf33a 100644 --- a/src/merge/resources/hris/resources/pay_groups/client.py +++ b/src/merge/resources/hris/resources/pay_groups/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.pay_groups.list() + client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.pay_groups.list() + await client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/payroll_runs/client.py b/src/merge/resources/hris/resources/payroll_runs/client.py index 9de9d3c2..5638f7df 100644 --- a/src/merge/resources/hris/resources/payroll_runs/client.py +++ b/src/merge/resources/hris/resources/payroll_runs/client.py @@ -130,7 +130,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.payroll_runs.list() + client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -334,7 +336,9 @@ async def list( async def main() -> None: - await client.hris.payroll_runs.list() + await client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/sync_status/client.py b/src/merge/resources/hris/resources/sync_status/client.py index fb1b6a50..aa845f9e 100644 --- a/src/merge/resources/hris/resources/sync_status/client.py +++ b/src/merge/resources/hris/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.sync_status.list() + client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.hris.sync_status.list() + await client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/teams/client.py b/src/merge/resources/hris/resources/teams/client.py index f0ba24da..f17a9a47 100644 --- a/src/merge/resources/hris/resources/teams/client.py +++ b/src/merge/resources/hris/resources/teams/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.teams.list() + client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.teams.list() + await client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off/client.py b/src/merge/resources/hris/resources/time_off/client.py index ff2cbfb7..5d3d3239 100644 --- a/src/merge/resources/hris/resources/time_off/client.py +++ b/src/merge/resources/hris/resources/time_off/client.py @@ -162,7 +162,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off.list() + client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( approver_id=approver_id, @@ -472,7 +474,9 @@ async def list( async def main() -> None: - await client.hris.time_off.list() + await client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off_balances/client.py b/src/merge/resources/hris/resources/time_off_balances/client.py index 9b32ead7..6f272e00 100644 --- a/src/merge/resources/hris/resources/time_off_balances/client.py +++ b/src/merge/resources/hris/resources/time_off_balances/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off_balances.list() + client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -319,7 +321,9 @@ async def list( async def main() -> None: - await client.hris.time_off_balances.list() + await client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/timesheet_entries/client.py b/src/merge/resources/hris/resources/timesheet_entries/client.py index 5162fa48..5689a64a 100644 --- a/src/merge/resources/hris/resources/timesheet_entries/client.py +++ b/src/merge/resources/hris/resources/timesheet_entries/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.timesheet_entries.list() + client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -393,7 +395,9 @@ async def list( async def main() -> None: - await client.hris.timesheet_entries.list() + await client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/accounts/client.py b/src/merge/resources/ticketing/resources/accounts/client.py index 1ecd7ee2..0eb93e75 100644 --- a/src/merge/resources/ticketing/resources/accounts/client.py +++ b/src/merge/resources/ticketing/resources/accounts/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.accounts.list() + client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.accounts.list() + await client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/attachments/client.py b/src/merge/resources/ticketing/resources/attachments/client.py index 8d8155a7..ff82e3cf 100644 --- a/src/merge/resources/ticketing/resources/attachments/client.py +++ b/src/merge/resources/ticketing/resources/attachments/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.attachments.list() + client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -390,7 +392,9 @@ async def list( async def main() -> None: - await client.ticketing.attachments.list() + await client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/audit_trail/client.py b/src/merge/resources/ticketing/resources/audit_trail/client.py index 59fe3392..40225482 100644 --- a/src/merge/resources/ticketing/resources/audit_trail/client.py +++ b/src/merge/resources/ticketing/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.audit_trail.list() + client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ticketing.audit_trail.list() + await client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/collections/client.py b/src/merge/resources/ticketing/resources/collections/client.py index 16675970..74184c4e 100644 --- a/src/merge/resources/ticketing/resources/collections/client.py +++ b/src/merge/resources/ticketing/resources/collections/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.collections.list() + client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( collection_type=collection_type, @@ -190,6 +192,7 @@ def viewers_list( ) client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -375,7 +378,9 @@ async def list( async def main() -> None: - await client.ticketing.collections.list() + await client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -460,6 +465,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/comments/client.py b/src/merge/resources/ticketing/resources/comments/client.py index 06b7d2d6..179ad2a1 100644 --- a/src/merge/resources/ticketing/resources/comments/client.py +++ b/src/merge/resources/ticketing/resources/comments/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.comments.list() + client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -358,7 +360,9 @@ async def list( async def main() -> None: - await client.ticketing.comments.list() + await client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/contacts/client.py b/src/merge/resources/ticketing/resources/contacts/client.py index aa5fe595..d36d28fc 100644 --- a/src/merge/resources/ticketing/resources/contacts/client.py +++ b/src/merge/resources/ticketing/resources/contacts/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.contacts.list() + client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -338,7 +340,9 @@ async def list( async def main() -> None: - await client.ticketing.contacts.list() + await client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/issues/client.py b/src/merge/resources/ticketing/resources/issues/client.py index ea663780..24550de7 100644 --- a/src/merge/resources/ticketing/resources/issues/client.py +++ b/src/merge/resources/ticketing/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.issues.list() + client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ticketing.issues.list() + await client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/linked_accounts/client.py b/src/merge/resources/ticketing/resources/linked_accounts/client.py index afaca7a3..31a9f3db 100644 --- a/src/merge/resources/ticketing/resources/linked_accounts/client.py +++ b/src/merge/resources/ticketing/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.linked_accounts.list() + client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ticketing.linked_accounts.list() + await client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/projects/client.py b/src/merge/resources/ticketing/resources/projects/client.py index be9c4fb2..edb34c7f 100644 --- a/src/merge/resources/ticketing/resources/projects/client.py +++ b/src/merge/resources/ticketing/resources/projects/client.py @@ -93,7 +93,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.projects.list() + client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -214,6 +216,7 @@ def users_list( ) client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.users_list( @@ -315,7 +318,9 @@ async def list( async def main() -> None: - await client.ticketing.projects.list() + await client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -452,6 +457,7 @@ async def users_list( async def main() -> None: await client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/roles/client.py b/src/merge/resources/ticketing/resources/roles/client.py index d026ac37..d4c63c42 100644 --- a/src/merge/resources/ticketing/resources/roles/client.py +++ b/src/merge/resources/ticketing/resources/roles/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.roles.list() + client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.roles.list() + await client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/sync_status/client.py b/src/merge/resources/ticketing/resources/sync_status/client.py index 91bbdd7e..4e7f6d88 100644 --- a/src/merge/resources/ticketing/resources/sync_status/client.py +++ b/src/merge/resources/ticketing/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.sync_status.list() + client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ticketing.sync_status.list() + await client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tags/client.py b/src/merge/resources/ticketing/resources/tags/client.py index 34dbb860..74abf54f 100644 --- a/src/merge/resources/ticketing/resources/tags/client.py +++ b/src/merge/resources/ticketing/resources/tags/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tags.list() + client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.tags.list() + await client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/teams/client.py b/src/merge/resources/ticketing/resources/teams/client.py index 0bf2170e..625edb78 100644 --- a/src/merge/resources/ticketing/resources/teams/client.py +++ b/src/merge/resources/ticketing/resources/teams/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.teams.list() + client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.teams.list() + await client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tickets/client.py b/src/merge/resources/ticketing/resources/tickets/client.py index 6862ebf3..1d03e8e4 100644 --- a/src/merge/resources/ticketing/resources/tickets/client.py +++ b/src/merge/resources/ticketing/resources/tickets/client.py @@ -201,7 +201,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.list() + client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -462,6 +464,7 @@ def viewers_list( ) client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -606,7 +609,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.remote_field_classes_list() + client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -801,7 +806,9 @@ async def list( async def main() -> None: - await client.ticketing.tickets.list() + await client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1094,6 +1101,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -1264,7 +1272,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.ticketing.tickets.remote_field_classes_list() + await client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/users/client.py b/src/merge/resources/ticketing/resources/users/client.py index 4acf3693..d770ab9e 100644 --- a/src/merge/resources/ticketing/resources/users/client.py +++ b/src/merge/resources/ticketing/resources/users/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.users.list() + client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.ticketing.users.list() + await client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/types/remote_field_class.py b/src/merge/resources/ticketing/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/ticketing/types/remote_field_class.py +++ b/src/merge/resources/ticketing/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None