mergepythonclient 2.3.2__py3-none-any.whl → 2.5.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- merge/__init__.py +5 -1
- merge/client.py +56 -18
- merge/core/client_wrapper.py +2 -2
- merge/resources/__init__.py +4 -2
- merge/resources/accounting/__init__.py +15 -0
- merge/resources/accounting/resources/__init__.py +14 -1
- merge/resources/accounting/resources/accounting_periods/client.py +12 -0
- merge/resources/accounting/resources/accounts/__init__.py +6 -0
- merge/resources/accounting/resources/accounts/client.py +93 -8
- merge/resources/accounting/resources/accounts/raw_client.py +10 -8
- merge/resources/accounting/resources/accounts/types/__init__.py +6 -0
- merge/resources/accounting/resources/accounts/types/accounts_list_request_classification.py +37 -0
- merge/resources/accounting/resources/accounts/types/accounts_list_request_status.py +29 -0
- merge/resources/accounting/resources/addresses/client.py +4 -0
- merge/resources/accounting/resources/attachments/client.py +47 -0
- merge/resources/accounting/resources/audit_trail/client.py +10 -0
- merge/resources/accounting/resources/balance_sheets/client.py +43 -0
- merge/resources/accounting/resources/bank_feed_accounts/client.py +16 -0
- merge/resources/accounting/resources/bank_feed_transactions/client.py +47 -0
- merge/resources/accounting/resources/cash_flow_statements/client.py +43 -0
- merge/resources/accounting/resources/company_info/client.py +57 -0
- merge/resources/accounting/resources/contacts/__init__.py +3 -2
- merge/resources/accounting/resources/contacts/client.py +100 -4
- merge/resources/accounting/resources/contacts/raw_client.py +5 -4
- merge/resources/accounting/resources/contacts/types/__init__.py +3 -1
- merge/resources/accounting/resources/contacts/types/contacts_list_request_status.py +25 -0
- merge/resources/accounting/resources/credit_notes/client.py +91 -0
- merge/resources/accounting/resources/employees/client.py +43 -0
- merge/resources/accounting/resources/expense_reports/client.py +109 -0
- merge/resources/accounting/resources/expenses/client.py +103 -0
- merge/resources/accounting/resources/field_mapping/client.py +16 -4
- merge/resources/accounting/resources/general_ledger_transactions/client.py +71 -0
- merge/resources/accounting/resources/income_statements/client.py +43 -0
- merge/resources/accounting/resources/invoices/client.py +119 -0
- merge/resources/accounting/resources/issues/client.py +47 -0
- merge/resources/accounting/resources/items/client.py +63 -0
- merge/resources/accounting/resources/journal_entries/client.py +103 -0
- merge/resources/accounting/resources/linked_accounts/client.py +30 -0
- merge/resources/accounting/resources/payment_methods/client.py +12 -0
- merge/resources/accounting/resources/payment_terms/client.py +12 -0
- merge/resources/accounting/resources/payments/client.py +111 -0
- merge/resources/accounting/resources/phone_numbers/client.py +4 -0
- merge/resources/accounting/resources/projects/client.py +59 -0
- merge/resources/accounting/resources/purchase_orders/client.py +103 -0
- merge/resources/accounting/resources/sync_status/client.py +2 -0
- merge/resources/accounting/resources/tax_rates/client.py +45 -0
- merge/resources/accounting/resources/tracking_categories/__init__.py +31 -0
- merge/resources/accounting/resources/tracking_categories/client.py +67 -8
- merge/resources/accounting/resources/tracking_categories/raw_client.py +10 -8
- merge/resources/accounting/resources/tracking_categories/types/__init__.py +36 -0
- merge/resources/accounting/resources/tracking_categories/types/tracking_categories_list_request_category_type.py +25 -0
- merge/resources/accounting/resources/tracking_categories/types/tracking_categories_list_request_status.py +25 -0
- merge/resources/accounting/resources/transactions/client.py +71 -0
- merge/resources/accounting/resources/vendor_credits/client.py +75 -0
- merge/resources/ats/resources/activities/client.py +71 -0
- merge/resources/ats/resources/applications/client.py +83 -2
- merge/resources/ats/resources/attachments/client.py +47 -0
- merge/resources/ats/resources/audit_trail/client.py +10 -0
- merge/resources/ats/resources/candidates/client.py +69 -0
- merge/resources/ats/resources/departments/client.py +41 -0
- merge/resources/ats/resources/eeocs/client.py +67 -0
- merge/resources/ats/resources/field_mapping/client.py +16 -4
- merge/resources/ats/resources/interviews/client.py +65 -0
- merge/resources/ats/resources/issues/client.py +47 -0
- merge/resources/ats/resources/job_interview_stages/client.py +43 -0
- merge/resources/ats/resources/job_postings/client.py +49 -0
- merge/resources/ats/resources/jobs/client.py +77 -0
- merge/resources/ats/resources/linked_accounts/client.py +30 -0
- merge/resources/ats/resources/offers/client.py +53 -0
- merge/resources/ats/resources/offices/client.py +41 -0
- merge/resources/ats/resources/reject_reasons/client.py +41 -0
- merge/resources/ats/resources/scorecards/client.py +59 -0
- merge/resources/ats/resources/sync_status/client.py +2 -0
- merge/resources/ats/resources/tags/client.py +37 -0
- merge/resources/ats/resources/users/client.py +43 -0
- merge/resources/chat/__init__.py +385 -0
- merge/resources/chat/client.py +459 -0
- merge/resources/chat/raw_client.py +13 -0
- merge/resources/chat/resources/__init__.py +115 -0
- merge/resources/chat/resources/account_details/__init__.py +4 -0
- merge/resources/chat/resources/account_details/client.py +102 -0
- merge/resources/chat/resources/account_details/raw_client.py +91 -0
- merge/resources/chat/resources/account_token/__init__.py +4 -0
- merge/resources/chat/resources/account_token/client.py +112 -0
- merge/resources/chat/resources/account_token/raw_client.py +98 -0
- merge/resources/chat/resources/async_passthrough/__init__.py +32 -0
- merge/resources/chat/resources/async_passthrough/client.py +201 -0
- merge/resources/chat/resources/async_passthrough/raw_client.py +189 -0
- merge/resources/chat/resources/async_passthrough/types/__init__.py +32 -0
- merge/resources/chat/resources/async_passthrough/types/async_passthrough_retrieve_response.py +7 -0
- merge/resources/chat/resources/audit_trail/__init__.py +4 -0
- merge/resources/chat/resources/audit_trail/client.py +188 -0
- merge/resources/chat/resources/audit_trail/raw_client.py +161 -0
- merge/resources/chat/resources/available_actions/__init__.py +4 -0
- merge/resources/chat/resources/available_actions/client.py +102 -0
- merge/resources/chat/resources/available_actions/raw_client.py +91 -0
- merge/resources/chat/resources/conversations/__init__.py +32 -0
- merge/resources/chat/resources/conversations/client.py +553 -0
- merge/resources/chat/resources/conversations/raw_client.py +479 -0
- merge/resources/chat/resources/conversations/types/__init__.py +34 -0
- merge/resources/chat/resources/conversations/types/conversations_members_list_request_expand.py +25 -0
- merge/resources/chat/resources/delete_account/__init__.py +4 -0
- merge/resources/chat/resources/delete_account/client.py +99 -0
- merge/resources/chat/resources/delete_account/raw_client.py +71 -0
- merge/resources/chat/resources/field_mapping/__init__.py +4 -0
- merge/resources/chat/resources/field_mapping/client.py +664 -0
- merge/resources/chat/resources/field_mapping/raw_client.py +672 -0
- merge/resources/chat/resources/force_resync/__init__.py +4 -0
- merge/resources/chat/resources/force_resync/client.py +106 -0
- merge/resources/chat/resources/force_resync/raw_client.py +93 -0
- merge/resources/chat/resources/generate_key/__init__.py +4 -0
- merge/resources/chat/resources/generate_key/client.py +115 -0
- merge/resources/chat/resources/generate_key/raw_client.py +114 -0
- merge/resources/chat/resources/groups/__init__.py +4 -0
- merge/resources/chat/resources/groups/client.py +367 -0
- merge/resources/chat/resources/groups/raw_client.py +311 -0
- merge/resources/chat/resources/issues/__init__.py +32 -0
- merge/resources/chat/resources/issues/client.py +378 -0
- merge/resources/chat/resources/issues/raw_client.py +336 -0
- merge/resources/chat/resources/issues/types/__init__.py +32 -0
- merge/resources/chat/resources/issues/types/issues_list_request_status.py +17 -0
- merge/resources/chat/resources/link_token/__init__.py +35 -0
- merge/resources/chat/resources/link_token/client.py +290 -0
- merge/resources/chat/resources/link_token/raw_client.py +273 -0
- merge/resources/chat/resources/link_token/types/__init__.py +38 -0
- merge/resources/chat/resources/link_token/types/end_user_details_request_completed_account_initial_screen.py +7 -0
- merge/resources/chat/resources/link_token/types/end_user_details_request_language.py +7 -0
- merge/resources/chat/resources/linked_accounts/__init__.py +32 -0
- merge/resources/chat/resources/linked_accounts/client.py +297 -0
- merge/resources/chat/resources/linked_accounts/raw_client.py +250 -0
- merge/resources/chat/resources/linked_accounts/types/__init__.py +34 -0
- merge/resources/chat/resources/linked_accounts/types/linked_accounts_list_request_category.py +49 -0
- merge/resources/chat/resources/messages/__init__.py +4 -0
- merge/resources/chat/resources/messages/client.py +513 -0
- merge/resources/chat/resources/messages/raw_client.py +447 -0
- merge/resources/chat/resources/passthrough/__init__.py +4 -0
- merge/resources/chat/resources/passthrough/client.py +126 -0
- merge/resources/chat/resources/passthrough/raw_client.py +111 -0
- merge/resources/chat/resources/regenerate_key/__init__.py +4 -0
- merge/resources/chat/resources/regenerate_key/client.py +115 -0
- merge/resources/chat/resources/regenerate_key/raw_client.py +114 -0
- merge/resources/chat/resources/scopes/__init__.py +4 -0
- merge/resources/chat/resources/scopes/client.py +320 -0
- merge/resources/chat/resources/scopes/raw_client.py +267 -0
- merge/resources/chat/resources/sync_status/__init__.py +4 -0
- merge/resources/chat/resources/sync_status/client.py +132 -0
- merge/resources/chat/resources/sync_status/raw_client.py +121 -0
- merge/resources/chat/resources/users/__init__.py +4 -0
- merge/resources/chat/resources/users/client.py +387 -0
- merge/resources/chat/resources/users/raw_client.py +331 -0
- merge/resources/chat/resources/webhook_receivers/__init__.py +4 -0
- merge/resources/chat/resources/webhook_receivers/client.py +201 -0
- merge/resources/chat/resources/webhook_receivers/raw_client.py +208 -0
- merge/resources/chat/types/__init__.py +302 -0
- merge/resources/chat/types/account_details.py +40 -0
- merge/resources/chat/types/account_details_and_actions.py +54 -0
- merge/resources/chat/types/account_details_and_actions_category.py +7 -0
- merge/resources/chat/types/account_details_and_actions_integration.py +29 -0
- merge/resources/chat/types/account_details_and_actions_status.py +7 -0
- merge/resources/chat/types/account_details_and_actions_status_enum.py +36 -0
- merge/resources/chat/types/account_details_category.py +7 -0
- merge/resources/chat/types/account_integration.py +67 -0
- merge/resources/chat/types/account_token.py +23 -0
- merge/resources/chat/types/advanced_metadata.py +25 -0
- merge/resources/chat/types/async_passthrough_reciept.py +20 -0
- merge/resources/chat/types/audit_log_event.py +97 -0
- merge/resources/chat/types/audit_log_event_event_type.py +7 -0
- merge/resources/chat/types/audit_log_event_role.py +7 -0
- merge/resources/chat/types/available_actions.py +33 -0
- merge/resources/chat/types/categories_enum.py +56 -0
- merge/resources/chat/types/category_enum.py +56 -0
- merge/resources/chat/types/common_model_scope_api.py +24 -0
- merge/resources/chat/types/common_model_scopes_body_request.py +23 -0
- merge/resources/chat/types/completed_account_initial_screen_enum.py +5 -0
- merge/resources/chat/types/conversation.py +80 -0
- merge/resources/chat/types/conversation_type.py +7 -0
- merge/resources/chat/types/data_passthrough_request.py +62 -0
- merge/resources/chat/types/data_passthrough_request_method.py +7 -0
- merge/resources/chat/types/data_passthrough_request_request_format.py +7 -0
- merge/resources/chat/types/debug_mode_log.py +23 -0
- merge/resources/chat/types/debug_model_log_summary.py +22 -0
- merge/resources/chat/types/enabled_actions_enum.py +22 -0
- merge/resources/chat/types/encoding_enum.py +31 -0
- merge/resources/chat/types/error_validation_problem.py +25 -0
- merge/resources/chat/types/event_type_enum.py +231 -0
- merge/resources/chat/types/external_target_field_api.py +22 -0
- merge/resources/chat/types/external_target_field_api_response.py +26 -0
- merge/resources/chat/types/field_mapping_api_instance.py +26 -0
- merge/resources/chat/types/field_mapping_api_instance_remote_field.py +27 -0
- merge/resources/chat/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +22 -0
- merge/resources/chat/types/field_mapping_api_instance_response.py +26 -0
- merge/resources/chat/types/field_mapping_api_instance_target_field.py +22 -0
- merge/resources/chat/types/field_mapping_instance_response.py +27 -0
- merge/resources/chat/types/field_permission_deserializer.py +21 -0
- merge/resources/chat/types/field_permission_deserializer_request.py +21 -0
- merge/resources/chat/types/group.py +57 -0
- merge/resources/chat/types/individual_common_model_scope_deserializer.py +24 -0
- merge/resources/chat/types/individual_common_model_scope_deserializer_request.py +24 -0
- merge/resources/chat/types/issue.py +36 -0
- merge/resources/chat/types/issue_status.py +7 -0
- merge/resources/chat/types/issue_status_enum.py +22 -0
- merge/resources/chat/types/language_enum.py +22 -0
- merge/resources/chat/types/last_sync_result_enum.py +46 -0
- merge/resources/chat/types/link_token.py +22 -0
- merge/resources/chat/types/member.py +63 -0
- merge/resources/chat/types/message.py +78 -0
- merge/resources/chat/types/method_enum.py +51 -0
- merge/resources/chat/types/model_operation.py +32 -0
- merge/resources/chat/types/model_permission_deserializer.py +20 -0
- merge/resources/chat/types/model_permission_deserializer_request.py +20 -0
- merge/resources/chat/types/multipart_form_field_request.py +57 -0
- merge/resources/chat/types/multipart_form_field_request_encoding.py +7 -0
- merge/resources/chat/types/paginated_account_details_and_actions_list.py +23 -0
- merge/resources/chat/types/paginated_audit_log_event_list.py +23 -0
- merge/resources/chat/types/paginated_conversation_list.py +23 -0
- merge/resources/chat/types/paginated_group_list.py +23 -0
- merge/resources/chat/types/paginated_issue_list.py +23 -0
- merge/resources/chat/types/paginated_member_list.py +23 -0
- merge/resources/chat/types/paginated_message_list.py +23 -0
- merge/resources/chat/types/paginated_sync_status_list.py +23 -0
- merge/resources/chat/types/paginated_user_list.py +23 -0
- merge/resources/chat/types/remote_data.py +34 -0
- merge/resources/chat/types/remote_endpoint_info.py +22 -0
- merge/resources/chat/types/remote_field_api.py +28 -0
- merge/resources/chat/types/remote_field_api_advanced_metadata.py +7 -0
- merge/resources/chat/types/remote_field_api_coverage.py +5 -0
- merge/resources/chat/types/remote_field_api_response.py +24 -0
- merge/resources/chat/types/remote_key.py +30 -0
- merge/resources/chat/types/remote_response.py +36 -0
- merge/resources/chat/types/remote_response_response_type.py +7 -0
- merge/resources/chat/types/request_format_enum.py +31 -0
- merge/resources/chat/types/response_type_enum.py +22 -0
- merge/resources/chat/types/role_enum.py +46 -0
- merge/resources/chat/types/selective_sync_configurations_usage_enum.py +24 -0
- merge/resources/chat/types/status_fd_5_enum.py +46 -0
- merge/resources/chat/types/sync_status.py +41 -0
- merge/resources/chat/types/sync_status_last_sync_result.py +7 -0
- merge/resources/chat/types/sync_status_status.py +7 -0
- merge/resources/chat/types/type_enum.py +36 -0
- merge/resources/chat/types/user.py +84 -0
- merge/resources/chat/types/validation_problem_source.py +20 -0
- merge/resources/chat/types/warning_validation_problem.py +25 -0
- merge/resources/chat/types/webhook_receiver.py +22 -0
- merge/resources/crm/resources/accounts/client.py +71 -0
- merge/resources/crm/resources/association_types/client.py +45 -0
- merge/resources/crm/resources/associations/client.py +53 -10
- merge/resources/crm/resources/associations/raw_client.py +6 -6
- merge/resources/crm/resources/audit_trail/client.py +10 -0
- merge/resources/crm/resources/contacts/client.py +81 -0
- merge/resources/crm/resources/custom_object_classes/client.py +41 -0
- merge/resources/crm/resources/custom_objects/client.py +63 -0
- merge/resources/crm/resources/engagement_types/client.py +59 -0
- merge/resources/crm/resources/engagements/client.py +95 -0
- merge/resources/crm/resources/field_mapping/client.py +16 -4
- merge/resources/crm/resources/issues/client.py +47 -0
- merge/resources/crm/resources/leads/client.py +81 -0
- merge/resources/crm/resources/linked_accounts/client.py +30 -0
- merge/resources/crm/resources/notes/client.py +79 -0
- merge/resources/crm/resources/opportunities/client.py +99 -0
- merge/resources/crm/resources/stages/client.py +59 -0
- merge/resources/crm/resources/sync_status/client.py +2 -0
- merge/resources/crm/resources/tasks/client.py +75 -0
- merge/resources/crm/resources/users/client.py +61 -0
- merge/resources/filestorage/resources/audit_trail/client.py +10 -0
- merge/resources/filestorage/resources/drives/client.py +43 -0
- merge/resources/filestorage/resources/field_mapping/client.py +16 -4
- merge/resources/filestorage/resources/files/client.py +109 -0
- merge/resources/filestorage/resources/folders/client.py +67 -0
- merge/resources/filestorage/resources/groups/client.py +41 -0
- merge/resources/filestorage/resources/issues/client.py +47 -0
- merge/resources/filestorage/resources/linked_accounts/client.py +30 -0
- merge/resources/filestorage/resources/sync_status/client.py +2 -0
- merge/resources/filestorage/resources/users/client.py +43 -0
- merge/resources/hris/__init__.py +9 -0
- merge/resources/hris/resources/__init__.py +3 -1
- merge/resources/hris/resources/audit_trail/client.py +10 -0
- merge/resources/hris/resources/bank_info/client.py +59 -2
- merge/resources/hris/resources/bank_info/raw_client.py +2 -2
- merge/resources/hris/resources/benefits/client.py +45 -2
- merge/resources/hris/resources/benefits/raw_client.py +2 -2
- merge/resources/hris/resources/companies/client.py +43 -2
- merge/resources/hris/resources/companies/raw_client.py +2 -2
- merge/resources/hris/resources/dependents/client.py +49 -2
- merge/resources/hris/resources/dependents/raw_client.py +2 -2
- merge/resources/hris/resources/employee_payroll_runs/client.py +87 -2
- merge/resources/hris/resources/employee_payroll_runs/raw_client.py +2 -2
- merge/resources/hris/resources/employees/client.py +143 -4
- merge/resources/hris/resources/employees/raw_client.py +4 -4
- merge/resources/hris/resources/employer_benefits/client.py +43 -2
- merge/resources/hris/resources/employer_benefits/raw_client.py +2 -2
- merge/resources/hris/resources/employments/client.py +81 -2
- merge/resources/hris/resources/employments/raw_client.py +2 -2
- merge/resources/hris/resources/field_mapping/client.py +36 -4
- merge/resources/hris/resources/field_mapping/raw_client.py +20 -0
- merge/resources/hris/resources/groups/client.py +49 -2
- merge/resources/hris/resources/groups/raw_client.py +2 -2
- merge/resources/hris/resources/issues/client.py +49 -2
- merge/resources/hris/resources/issues/raw_client.py +2 -2
- merge/resources/hris/resources/link_token/__init__.py +6 -3
- merge/resources/hris/resources/link_token/client.py +17 -0
- merge/resources/hris/resources/link_token/raw_client.py +17 -0
- merge/resources/hris/resources/link_token/types/__init__.py +8 -2
- merge/resources/hris/resources/link_token/types/end_user_details_request_completed_account_initial_screen.py +7 -0
- merge/resources/hris/resources/linked_accounts/client.py +32 -2
- merge/resources/hris/resources/linked_accounts/raw_client.py +2 -2
- merge/resources/hris/resources/locations/client.py +73 -4
- merge/resources/hris/resources/locations/raw_client.py +4 -4
- merge/resources/hris/resources/pay_groups/client.py +43 -2
- merge/resources/hris/resources/pay_groups/raw_client.py +2 -2
- merge/resources/hris/resources/payroll_runs/client.py +95 -2
- merge/resources/hris/resources/payroll_runs/raw_client.py +2 -2
- merge/resources/hris/resources/sync_status/client.py +4 -2
- merge/resources/hris/resources/sync_status/raw_client.py +2 -2
- merge/resources/hris/resources/teams/client.py +45 -2
- merge/resources/hris/resources/teams/raw_client.py +2 -2
- merge/resources/hris/resources/time_off/client.py +115 -2
- merge/resources/hris/resources/time_off/raw_client.py +2 -2
- merge/resources/hris/resources/time_off_balances/client.py +53 -2
- merge/resources/hris/resources/time_off_balances/raw_client.py +2 -2
- merge/resources/hris/resources/timesheet_entries/client.py +81 -2
- merge/resources/hris/resources/timesheet_entries/raw_client.py +2 -2
- merge/resources/hris/types/__init__.py +6 -0
- merge/resources/hris/types/account_details_and_actions.py +2 -2
- merge/resources/hris/types/account_details_and_actions_status.py +7 -0
- merge/resources/hris/types/completed_account_initial_screen_enum.py +5 -0
- merge/resources/hris/types/field_mapping_api_instance.py +1 -0
- merge/resources/knowledgebase/__init__.py +481 -0
- merge/resources/knowledgebase/client.py +480 -0
- merge/resources/knowledgebase/raw_client.py +13 -0
- merge/resources/knowledgebase/resources/__init__.py +134 -0
- merge/resources/knowledgebase/resources/account_details/__init__.py +4 -0
- merge/resources/knowledgebase/resources/account_details/client.py +102 -0
- merge/resources/knowledgebase/resources/account_details/raw_client.py +91 -0
- merge/resources/knowledgebase/resources/account_token/__init__.py +4 -0
- merge/resources/knowledgebase/resources/account_token/client.py +112 -0
- merge/resources/knowledgebase/resources/account_token/raw_client.py +98 -0
- merge/resources/knowledgebase/resources/articles/__init__.py +36 -0
- merge/resources/knowledgebase/resources/articles/client.py +468 -0
- merge/resources/knowledgebase/resources/articles/raw_client.py +384 -0
- merge/resources/knowledgebase/resources/articles/types/__init__.py +38 -0
- merge/resources/knowledgebase/resources/articles/types/articles_list_request_expand.py +625 -0
- merge/resources/knowledgebase/resources/articles/types/articles_list_request_type.py +29 -0
- merge/resources/knowledgebase/resources/articles/types/articles_retrieve_request_expand.py +631 -0
- merge/resources/knowledgebase/resources/async_passthrough/__init__.py +32 -0
- merge/resources/knowledgebase/resources/async_passthrough/client.py +201 -0
- merge/resources/knowledgebase/resources/async_passthrough/raw_client.py +189 -0
- merge/resources/knowledgebase/resources/async_passthrough/types/__init__.py +32 -0
- merge/resources/knowledgebase/resources/async_passthrough/types/async_passthrough_retrieve_response.py +7 -0
- merge/resources/knowledgebase/resources/attachments/__init__.py +4 -0
- merge/resources/knowledgebase/resources/attachments/client.py +367 -0
- merge/resources/knowledgebase/resources/attachments/raw_client.py +311 -0
- merge/resources/knowledgebase/resources/audit_trail/__init__.py +4 -0
- merge/resources/knowledgebase/resources/audit_trail/client.py +188 -0
- merge/resources/knowledgebase/resources/audit_trail/raw_client.py +161 -0
- merge/resources/knowledgebase/resources/available_actions/__init__.py +4 -0
- merge/resources/knowledgebase/resources/available_actions/client.py +102 -0
- merge/resources/knowledgebase/resources/available_actions/raw_client.py +91 -0
- merge/resources/knowledgebase/resources/containers/__init__.py +36 -0
- merge/resources/knowledgebase/resources/containers/client.py +444 -0
- merge/resources/knowledgebase/resources/containers/raw_client.py +364 -0
- merge/resources/knowledgebase/resources/containers/types/__init__.py +38 -0
- merge/resources/knowledgebase/resources/containers/types/containers_list_request_expand.py +41 -0
- merge/resources/knowledgebase/resources/containers/types/containers_list_request_type.py +41 -0
- merge/resources/knowledgebase/resources/containers/types/containers_retrieve_request_expand.py +41 -0
- merge/resources/knowledgebase/resources/delete_account/__init__.py +4 -0
- merge/resources/knowledgebase/resources/delete_account/client.py +99 -0
- merge/resources/knowledgebase/resources/delete_account/raw_client.py +71 -0
- merge/resources/knowledgebase/resources/field_mapping/__init__.py +4 -0
- merge/resources/knowledgebase/resources/field_mapping/client.py +664 -0
- merge/resources/knowledgebase/resources/field_mapping/raw_client.py +672 -0
- merge/resources/knowledgebase/resources/force_resync/__init__.py +4 -0
- merge/resources/knowledgebase/resources/force_resync/client.py +106 -0
- merge/resources/knowledgebase/resources/force_resync/raw_client.py +93 -0
- merge/resources/knowledgebase/resources/generate_key/__init__.py +4 -0
- merge/resources/knowledgebase/resources/generate_key/client.py +115 -0
- merge/resources/knowledgebase/resources/generate_key/raw_client.py +114 -0
- merge/resources/knowledgebase/resources/groups/__init__.py +32 -0
- merge/resources/knowledgebase/resources/groups/client.py +405 -0
- merge/resources/knowledgebase/resources/groups/raw_client.py +333 -0
- merge/resources/knowledgebase/resources/groups/types/__init__.py +36 -0
- merge/resources/knowledgebase/resources/groups/types/groups_list_request_expand.py +25 -0
- merge/resources/knowledgebase/resources/groups/types/groups_retrieve_request_expand.py +25 -0
- merge/resources/knowledgebase/resources/issues/__init__.py +32 -0
- merge/resources/knowledgebase/resources/issues/client.py +382 -0
- merge/resources/knowledgebase/resources/issues/raw_client.py +336 -0
- merge/resources/knowledgebase/resources/issues/types/__init__.py +32 -0
- merge/resources/knowledgebase/resources/issues/types/issues_list_request_status.py +17 -0
- merge/resources/knowledgebase/resources/link_token/__init__.py +35 -0
- merge/resources/knowledgebase/resources/link_token/client.py +290 -0
- merge/resources/knowledgebase/resources/link_token/raw_client.py +273 -0
- merge/resources/knowledgebase/resources/link_token/types/__init__.py +38 -0
- merge/resources/knowledgebase/resources/link_token/types/end_user_details_request_completed_account_initial_screen.py +7 -0
- merge/resources/knowledgebase/resources/link_token/types/end_user_details_request_language.py +7 -0
- merge/resources/knowledgebase/resources/linked_accounts/__init__.py +32 -0
- merge/resources/knowledgebase/resources/linked_accounts/client.py +295 -0
- merge/resources/knowledgebase/resources/linked_accounts/raw_client.py +248 -0
- merge/resources/knowledgebase/resources/linked_accounts/types/__init__.py +34 -0
- merge/resources/knowledgebase/resources/linked_accounts/types/linked_accounts_list_request_category.py +45 -0
- merge/resources/knowledgebase/resources/passthrough/__init__.py +4 -0
- merge/resources/knowledgebase/resources/passthrough/client.py +126 -0
- merge/resources/knowledgebase/resources/passthrough/raw_client.py +111 -0
- merge/resources/knowledgebase/resources/regenerate_key/__init__.py +4 -0
- merge/resources/knowledgebase/resources/regenerate_key/client.py +115 -0
- merge/resources/knowledgebase/resources/regenerate_key/raw_client.py +114 -0
- merge/resources/knowledgebase/resources/scopes/__init__.py +4 -0
- merge/resources/knowledgebase/resources/scopes/client.py +320 -0
- merge/resources/knowledgebase/resources/scopes/raw_client.py +267 -0
- merge/resources/knowledgebase/resources/sync_status/__init__.py +4 -0
- merge/resources/knowledgebase/resources/sync_status/client.py +132 -0
- merge/resources/knowledgebase/resources/sync_status/raw_client.py +121 -0
- merge/resources/knowledgebase/resources/users/__init__.py +4 -0
- merge/resources/knowledgebase/resources/users/client.py +367 -0
- merge/resources/knowledgebase/resources/users/raw_client.py +311 -0
- merge/resources/knowledgebase/resources/webhook_receivers/__init__.py +4 -0
- merge/resources/knowledgebase/resources/webhook_receivers/client.py +201 -0
- merge/resources/knowledgebase/resources/webhook_receivers/raw_client.py +208 -0
- merge/resources/knowledgebase/types/__init__.py +374 -0
- merge/resources/knowledgebase/types/account_details.py +40 -0
- merge/resources/knowledgebase/types/account_details_and_actions.py +54 -0
- merge/resources/knowledgebase/types/account_details_and_actions_category.py +7 -0
- merge/resources/knowledgebase/types/account_details_and_actions_integration.py +29 -0
- merge/resources/knowledgebase/types/account_details_and_actions_status.py +7 -0
- merge/resources/knowledgebase/types/account_details_and_actions_status_enum.py +36 -0
- merge/resources/knowledgebase/types/account_details_category.py +7 -0
- merge/resources/knowledgebase/types/account_integration.py +67 -0
- merge/resources/knowledgebase/types/account_token.py +23 -0
- merge/resources/knowledgebase/types/advanced_metadata.py +25 -0
- merge/resources/knowledgebase/types/article.py +159 -0
- merge/resources/knowledgebase/types/article_attachments_item.py +7 -0
- merge/resources/knowledgebase/types/article_author.py +7 -0
- merge/resources/knowledgebase/types/article_last_edited_by.py +7 -0
- merge/resources/knowledgebase/types/article_parent_article.py +9 -0
- merge/resources/knowledgebase/types/article_parent_container.py +7 -0
- merge/resources/knowledgebase/types/article_permissions_item.py +7 -0
- merge/resources/knowledgebase/types/article_root_container.py +7 -0
- merge/resources/knowledgebase/types/article_status.py +7 -0
- merge/resources/knowledgebase/types/article_type.py +7 -0
- merge/resources/knowledgebase/types/article_type_enum.py +31 -0
- merge/resources/knowledgebase/types/article_visibility.py +7 -0
- merge/resources/knowledgebase/types/async_passthrough_reciept.py +20 -0
- merge/resources/knowledgebase/types/attachment.py +67 -0
- merge/resources/knowledgebase/types/audit_log_event.py +97 -0
- merge/resources/knowledgebase/types/audit_log_event_event_type.py +7 -0
- merge/resources/knowledgebase/types/audit_log_event_role.py +7 -0
- merge/resources/knowledgebase/types/available_actions.py +33 -0
- merge/resources/knowledgebase/types/categories_enum.py +56 -0
- merge/resources/knowledgebase/types/category_enum.py +56 -0
- merge/resources/knowledgebase/types/common_model_scope_api.py +24 -0
- merge/resources/knowledgebase/types/common_model_scopes_body_request.py +23 -0
- merge/resources/knowledgebase/types/completed_account_initial_screen_enum.py +5 -0
- merge/resources/knowledgebase/types/container.py +130 -0
- merge/resources/knowledgebase/types/container_permissions_item.py +7 -0
- merge/resources/knowledgebase/types/container_status.py +7 -0
- merge/resources/knowledgebase/types/container_type.py +7 -0
- merge/resources/knowledgebase/types/container_type_enum.py +46 -0
- merge/resources/knowledgebase/types/container_visibility.py +7 -0
- merge/resources/knowledgebase/types/data_passthrough_request.py +62 -0
- merge/resources/knowledgebase/types/data_passthrough_request_method.py +7 -0
- merge/resources/knowledgebase/types/data_passthrough_request_request_format.py +7 -0
- merge/resources/knowledgebase/types/debug_mode_log.py +23 -0
- merge/resources/knowledgebase/types/debug_model_log_summary.py +22 -0
- merge/resources/knowledgebase/types/enabled_actions_enum.py +22 -0
- merge/resources/knowledgebase/types/encoding_enum.py +31 -0
- merge/resources/knowledgebase/types/error_validation_problem.py +24 -0
- merge/resources/knowledgebase/types/event_type_enum.py +231 -0
- merge/resources/knowledgebase/types/external_target_field_api.py +22 -0
- merge/resources/knowledgebase/types/external_target_field_api_response.py +25 -0
- merge/resources/knowledgebase/types/field_mapping_api_instance.py +26 -0
- merge/resources/knowledgebase/types/field_mapping_api_instance_remote_field.py +27 -0
- merge/resources/knowledgebase/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +22 -0
- merge/resources/knowledgebase/types/field_mapping_api_instance_response.py +25 -0
- merge/resources/knowledgebase/types/field_mapping_api_instance_target_field.py +22 -0
- merge/resources/knowledgebase/types/field_mapping_instance_response.py +27 -0
- merge/resources/knowledgebase/types/field_permission_deserializer.py +21 -0
- merge/resources/knowledgebase/types/field_permission_deserializer_request.py +21 -0
- merge/resources/knowledgebase/types/group.py +71 -0
- merge/resources/knowledgebase/types/group_parent_group.py +9 -0
- merge/resources/knowledgebase/types/group_users_item.py +7 -0
- merge/resources/knowledgebase/types/individual_common_model_scope_deserializer.py +24 -0
- merge/resources/knowledgebase/types/individual_common_model_scope_deserializer_request.py +24 -0
- merge/resources/knowledgebase/types/issue.py +36 -0
- merge/resources/knowledgebase/types/issue_status.py +7 -0
- merge/resources/knowledgebase/types/issue_status_enum.py +22 -0
- merge/resources/knowledgebase/types/language_enum.py +22 -0
- merge/resources/knowledgebase/types/last_sync_result_enum.py +46 -0
- merge/resources/knowledgebase/types/link_token.py +22 -0
- merge/resources/knowledgebase/types/method_enum.py +51 -0
- merge/resources/knowledgebase/types/model_operation.py +32 -0
- merge/resources/knowledgebase/types/model_permission_deserializer.py +20 -0
- merge/resources/knowledgebase/types/model_permission_deserializer_request.py +20 -0
- merge/resources/knowledgebase/types/multipart_form_field_request.py +57 -0
- merge/resources/knowledgebase/types/multipart_form_field_request_encoding.py +7 -0
- merge/resources/knowledgebase/types/paginated_account_details_and_actions_list.py +23 -0
- merge/resources/knowledgebase/types/paginated_article_list.py +30 -0
- merge/resources/knowledgebase/types/paginated_attachment_list.py +23 -0
- merge/resources/knowledgebase/types/paginated_audit_log_event_list.py +23 -0
- merge/resources/knowledgebase/types/paginated_container_list.py +30 -0
- merge/resources/knowledgebase/types/paginated_group_list.py +29 -0
- merge/resources/knowledgebase/types/paginated_issue_list.py +23 -0
- merge/resources/knowledgebase/types/paginated_sync_status_list.py +23 -0
- merge/resources/knowledgebase/types/paginated_user_list.py +23 -0
- merge/resources/knowledgebase/types/permission.py +77 -0
- merge/resources/knowledgebase/types/permission_group.py +7 -0
- merge/resources/knowledgebase/types/permission_type.py +7 -0
- merge/resources/knowledgebase/types/permission_type_enum.py +36 -0
- merge/resources/knowledgebase/types/permission_user.py +7 -0
- merge/resources/knowledgebase/types/remote_data.py +34 -0
- merge/resources/knowledgebase/types/remote_endpoint_info.py +22 -0
- merge/resources/knowledgebase/types/remote_field_api.py +28 -0
- merge/resources/knowledgebase/types/remote_field_api_advanced_metadata.py +7 -0
- merge/resources/knowledgebase/types/remote_field_api_coverage.py +5 -0
- merge/resources/knowledgebase/types/remote_field_api_response.py +25 -0
- merge/resources/knowledgebase/types/remote_key.py +30 -0
- merge/resources/knowledgebase/types/remote_response.py +36 -0
- merge/resources/knowledgebase/types/remote_response_response_type.py +7 -0
- merge/resources/knowledgebase/types/request_format_enum.py +31 -0
- merge/resources/knowledgebase/types/response_type_enum.py +22 -0
- merge/resources/knowledgebase/types/role_enum.py +46 -0
- merge/resources/knowledgebase/types/roles_enum.py +31 -0
- merge/resources/knowledgebase/types/selective_sync_configurations_usage_enum.py +24 -0
- merge/resources/knowledgebase/types/status_3_c_6_enum.py +36 -0
- merge/resources/knowledgebase/types/status_fd_5_enum.py +46 -0
- merge/resources/knowledgebase/types/sync_status.py +41 -0
- merge/resources/knowledgebase/types/sync_status_last_sync_result.py +7 -0
- merge/resources/knowledgebase/types/sync_status_status.py +7 -0
- merge/resources/knowledgebase/types/user.py +60 -0
- merge/resources/knowledgebase/types/validation_problem_source.py +20 -0
- merge/resources/knowledgebase/types/visibility_enum.py +31 -0
- merge/resources/knowledgebase/types/warning_validation_problem.py +24 -0
- merge/resources/knowledgebase/types/webhook_receiver.py +22 -0
- merge/resources/ticketing/__init__.py +12 -0
- merge/resources/ticketing/resources/__init__.py +9 -2
- merge/resources/ticketing/resources/accounts/client.py +41 -0
- merge/resources/ticketing/resources/attachments/client.py +55 -2
- merge/resources/ticketing/resources/attachments/raw_client.py +2 -2
- merge/resources/ticketing/resources/audit_trail/client.py +12 -2
- merge/resources/ticketing/resources/audit_trail/raw_client.py +2 -2
- merge/resources/ticketing/resources/collections/__init__.py +6 -3
- merge/resources/ticketing/resources/collections/client.py +76 -6
- merge/resources/ticketing/resources/collections/raw_client.py +7 -6
- merge/resources/ticketing/resources/collections/types/__init__.py +4 -2
- merge/resources/ticketing/resources/collections/types/collections_list_request_collection_type.py +25 -0
- merge/resources/ticketing/resources/comments/client.py +71 -2
- merge/resources/ticketing/resources/comments/raw_client.py +2 -2
- merge/resources/ticketing/resources/contacts/client.py +49 -2
- merge/resources/ticketing/resources/contacts/raw_client.py +2 -2
- merge/resources/ticketing/resources/field_mapping/client.py +36 -4
- merge/resources/ticketing/resources/field_mapping/raw_client.py +20 -0
- merge/resources/ticketing/resources/issues/client.py +49 -2
- merge/resources/ticketing/resources/issues/raw_client.py +2 -2
- merge/resources/ticketing/resources/link_token/__init__.py +6 -3
- merge/resources/ticketing/resources/link_token/client.py +17 -0
- merge/resources/ticketing/resources/link_token/raw_client.py +17 -0
- merge/resources/ticketing/resources/link_token/types/__init__.py +8 -2
- merge/resources/ticketing/resources/link_token/types/end_user_details_request_completed_account_initial_screen.py +7 -0
- merge/resources/ticketing/resources/linked_accounts/client.py +32 -2
- merge/resources/ticketing/resources/linked_accounts/raw_client.py +2 -2
- merge/resources/ticketing/resources/projects/client.py +61 -4
- merge/resources/ticketing/resources/projects/raw_client.py +4 -4
- merge/resources/ticketing/resources/roles/client.py +43 -2
- merge/resources/ticketing/resources/roles/raw_client.py +2 -2
- merge/resources/ticketing/resources/sync_status/client.py +4 -2
- merge/resources/ticketing/resources/sync_status/raw_client.py +2 -2
- merge/resources/ticketing/resources/tags/client.py +43 -2
- merge/resources/ticketing/resources/tags/raw_client.py +2 -2
- merge/resources/ticketing/resources/teams/client.py +43 -2
- merge/resources/ticketing/resources/teams/raw_client.py +2 -2
- merge/resources/ticketing/resources/tickets/__init__.py +3 -0
- merge/resources/ticketing/resources/tickets/client.py +222 -12
- merge/resources/ticketing/resources/tickets/raw_client.py +21 -10
- merge/resources/ticketing/resources/tickets/types/__init__.py +3 -0
- merge/resources/ticketing/resources/tickets/types/tickets_list_request_status.py +33 -0
- merge/resources/ticketing/resources/users/client.py +55 -2
- merge/resources/ticketing/resources/users/raw_client.py +2 -2
- merge/resources/ticketing/types/__init__.py +3 -0
- merge/resources/ticketing/types/categories_enum.py +5 -0
- merge/resources/ticketing/types/category_enum.py +5 -0
- merge/resources/ticketing/types/completed_account_initial_screen_enum.py +5 -0
- merge/resources/ticketing/types/field_mapping_api_instance.py +1 -0
- {mergepythonclient-2.3.2.dist-info → mergepythonclient-2.5.0.dist-info}/METADATA +7 -1
- {mergepythonclient-2.3.2.dist-info → mergepythonclient-2.5.0.dist-info}/RECORD +583 -198
- {mergepythonclient-2.3.2.dist-info → mergepythonclient-2.5.0.dist-info}/LICENSE.md +0 -0
- {mergepythonclient-2.3.2.dist-info → mergepythonclient-2.5.0.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,672 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
import typing
|
|
4
|
+
from json.decoder import JSONDecodeError
|
|
5
|
+
|
|
6
|
+
from .....core.api_error import ApiError
|
|
7
|
+
from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
|
|
8
|
+
from .....core.http_response import AsyncHttpResponse, HttpResponse
|
|
9
|
+
from .....core.jsonable_encoder import jsonable_encoder
|
|
10
|
+
from .....core.request_options import RequestOptions
|
|
11
|
+
from .....core.unchecked_base_model import construct_type
|
|
12
|
+
from ...types.external_target_field_api_response import ExternalTargetFieldApiResponse
|
|
13
|
+
from ...types.field_mapping_api_instance_response import FieldMappingApiInstanceResponse
|
|
14
|
+
from ...types.field_mapping_instance_response import FieldMappingInstanceResponse
|
|
15
|
+
from ...types.remote_field_api_response import RemoteFieldApiResponse
|
|
16
|
+
|
|
17
|
+
# this is used as the default value for optional parameters
|
|
18
|
+
OMIT = typing.cast(typing.Any, ...)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class RawFieldMappingClient:
|
|
22
|
+
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
|
23
|
+
self._client_wrapper = client_wrapper
|
|
24
|
+
|
|
25
|
+
def field_mappings_retrieve(
|
|
26
|
+
self,
|
|
27
|
+
*,
|
|
28
|
+
exclude_remote_field_metadata: typing.Optional[bool] = None,
|
|
29
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
30
|
+
) -> HttpResponse[FieldMappingApiInstanceResponse]:
|
|
31
|
+
"""
|
|
32
|
+
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/).
|
|
33
|
+
|
|
34
|
+
Parameters
|
|
35
|
+
----------
|
|
36
|
+
exclude_remote_field_metadata : typing.Optional[bool]
|
|
37
|
+
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.
|
|
38
|
+
|
|
39
|
+
request_options : typing.Optional[RequestOptions]
|
|
40
|
+
Request-specific configuration.
|
|
41
|
+
|
|
42
|
+
Returns
|
|
43
|
+
-------
|
|
44
|
+
HttpResponse[FieldMappingApiInstanceResponse]
|
|
45
|
+
|
|
46
|
+
"""
|
|
47
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
48
|
+
"knowledgebase/v1/field-mappings",
|
|
49
|
+
method="GET",
|
|
50
|
+
params={
|
|
51
|
+
"exclude_remote_field_metadata": exclude_remote_field_metadata,
|
|
52
|
+
},
|
|
53
|
+
request_options=request_options,
|
|
54
|
+
)
|
|
55
|
+
try:
|
|
56
|
+
if 200 <= _response.status_code < 300:
|
|
57
|
+
_data = typing.cast(
|
|
58
|
+
FieldMappingApiInstanceResponse,
|
|
59
|
+
construct_type(
|
|
60
|
+
type_=FieldMappingApiInstanceResponse, # type: ignore
|
|
61
|
+
object_=_response.json(),
|
|
62
|
+
),
|
|
63
|
+
)
|
|
64
|
+
return HttpResponse(response=_response, data=_data)
|
|
65
|
+
_response_json = _response.json()
|
|
66
|
+
except JSONDecodeError:
|
|
67
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
68
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
69
|
+
|
|
70
|
+
def field_mappings_create(
|
|
71
|
+
self,
|
|
72
|
+
*,
|
|
73
|
+
target_field_name: str,
|
|
74
|
+
target_field_description: str,
|
|
75
|
+
remote_field_traversal_path: typing.Sequence[typing.Optional[typing.Any]],
|
|
76
|
+
remote_method: str,
|
|
77
|
+
remote_url_path: str,
|
|
78
|
+
common_model_name: str,
|
|
79
|
+
exclude_remote_field_metadata: typing.Optional[bool] = None,
|
|
80
|
+
jmes_path: typing.Optional[str] = OMIT,
|
|
81
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
82
|
+
) -> HttpResponse[FieldMappingInstanceResponse]:
|
|
83
|
+
"""
|
|
84
|
+
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.
|
|
85
|
+
|
|
86
|
+
Parameters
|
|
87
|
+
----------
|
|
88
|
+
target_field_name : str
|
|
89
|
+
The name of the target field you want this remote field to map to.
|
|
90
|
+
|
|
91
|
+
target_field_description : str
|
|
92
|
+
The description of the target field you want this remote field to map to.
|
|
93
|
+
|
|
94
|
+
remote_field_traversal_path : typing.Sequence[typing.Optional[typing.Any]]
|
|
95
|
+
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
|
|
96
|
+
|
|
97
|
+
remote_method : str
|
|
98
|
+
The method of the remote endpoint where the remote field is coming from.
|
|
99
|
+
|
|
100
|
+
remote_url_path : str
|
|
101
|
+
The path of the remote endpoint where the remote field is coming from.
|
|
102
|
+
|
|
103
|
+
common_model_name : str
|
|
104
|
+
The name of the Common Model that the remote field corresponds to in a given category.
|
|
105
|
+
|
|
106
|
+
exclude_remote_field_metadata : typing.Optional[bool]
|
|
107
|
+
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.
|
|
108
|
+
|
|
109
|
+
jmes_path : typing.Optional[str]
|
|
110
|
+
JMES path to specify json query expression to be used on field mapping.
|
|
111
|
+
|
|
112
|
+
request_options : typing.Optional[RequestOptions]
|
|
113
|
+
Request-specific configuration.
|
|
114
|
+
|
|
115
|
+
Returns
|
|
116
|
+
-------
|
|
117
|
+
HttpResponse[FieldMappingInstanceResponse]
|
|
118
|
+
|
|
119
|
+
"""
|
|
120
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
121
|
+
"knowledgebase/v1/field-mappings",
|
|
122
|
+
method="POST",
|
|
123
|
+
params={
|
|
124
|
+
"exclude_remote_field_metadata": exclude_remote_field_metadata,
|
|
125
|
+
},
|
|
126
|
+
json={
|
|
127
|
+
"target_field_name": target_field_name,
|
|
128
|
+
"target_field_description": target_field_description,
|
|
129
|
+
"remote_field_traversal_path": remote_field_traversal_path,
|
|
130
|
+
"remote_method": remote_method,
|
|
131
|
+
"remote_url_path": remote_url_path,
|
|
132
|
+
"common_model_name": common_model_name,
|
|
133
|
+
"jmes_path": jmes_path,
|
|
134
|
+
},
|
|
135
|
+
headers={
|
|
136
|
+
"content-type": "application/json",
|
|
137
|
+
},
|
|
138
|
+
request_options=request_options,
|
|
139
|
+
omit=OMIT,
|
|
140
|
+
)
|
|
141
|
+
try:
|
|
142
|
+
if 200 <= _response.status_code < 300:
|
|
143
|
+
_data = typing.cast(
|
|
144
|
+
FieldMappingInstanceResponse,
|
|
145
|
+
construct_type(
|
|
146
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
147
|
+
object_=_response.json(),
|
|
148
|
+
),
|
|
149
|
+
)
|
|
150
|
+
return HttpResponse(response=_response, data=_data)
|
|
151
|
+
_response_json = _response.json()
|
|
152
|
+
except JSONDecodeError:
|
|
153
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
154
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
155
|
+
|
|
156
|
+
def field_mappings_destroy(
|
|
157
|
+
self, field_mapping_id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
158
|
+
) -> HttpResponse[FieldMappingInstanceResponse]:
|
|
159
|
+
"""
|
|
160
|
+
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.
|
|
161
|
+
|
|
162
|
+
Parameters
|
|
163
|
+
----------
|
|
164
|
+
field_mapping_id : str
|
|
165
|
+
|
|
166
|
+
request_options : typing.Optional[RequestOptions]
|
|
167
|
+
Request-specific configuration.
|
|
168
|
+
|
|
169
|
+
Returns
|
|
170
|
+
-------
|
|
171
|
+
HttpResponse[FieldMappingInstanceResponse]
|
|
172
|
+
|
|
173
|
+
"""
|
|
174
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
175
|
+
f"knowledgebase/v1/field-mappings/{jsonable_encoder(field_mapping_id)}",
|
|
176
|
+
method="DELETE",
|
|
177
|
+
request_options=request_options,
|
|
178
|
+
)
|
|
179
|
+
try:
|
|
180
|
+
if 200 <= _response.status_code < 300:
|
|
181
|
+
_data = typing.cast(
|
|
182
|
+
FieldMappingInstanceResponse,
|
|
183
|
+
construct_type(
|
|
184
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
185
|
+
object_=_response.json(),
|
|
186
|
+
),
|
|
187
|
+
)
|
|
188
|
+
return HttpResponse(response=_response, data=_data)
|
|
189
|
+
_response_json = _response.json()
|
|
190
|
+
except JSONDecodeError:
|
|
191
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
192
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
193
|
+
|
|
194
|
+
def field_mappings_partial_update(
|
|
195
|
+
self,
|
|
196
|
+
field_mapping_id: str,
|
|
197
|
+
*,
|
|
198
|
+
remote_field_traversal_path: typing.Optional[typing.Sequence[typing.Optional[typing.Any]]] = OMIT,
|
|
199
|
+
remote_method: typing.Optional[str] = OMIT,
|
|
200
|
+
remote_url_path: typing.Optional[str] = OMIT,
|
|
201
|
+
jmes_path: typing.Optional[str] = OMIT,
|
|
202
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
203
|
+
) -> HttpResponse[FieldMappingInstanceResponse]:
|
|
204
|
+
"""
|
|
205
|
+
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.
|
|
206
|
+
|
|
207
|
+
Parameters
|
|
208
|
+
----------
|
|
209
|
+
field_mapping_id : str
|
|
210
|
+
|
|
211
|
+
remote_field_traversal_path : typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]
|
|
212
|
+
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
|
|
213
|
+
|
|
214
|
+
remote_method : typing.Optional[str]
|
|
215
|
+
The method of the remote endpoint where the remote field is coming from.
|
|
216
|
+
|
|
217
|
+
remote_url_path : typing.Optional[str]
|
|
218
|
+
The path of the remote endpoint where the remote field is coming from.
|
|
219
|
+
|
|
220
|
+
jmes_path : typing.Optional[str]
|
|
221
|
+
JMES path to specify json query expression to be used on field mapping.
|
|
222
|
+
|
|
223
|
+
request_options : typing.Optional[RequestOptions]
|
|
224
|
+
Request-specific configuration.
|
|
225
|
+
|
|
226
|
+
Returns
|
|
227
|
+
-------
|
|
228
|
+
HttpResponse[FieldMappingInstanceResponse]
|
|
229
|
+
|
|
230
|
+
"""
|
|
231
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
232
|
+
f"knowledgebase/v1/field-mappings/{jsonable_encoder(field_mapping_id)}",
|
|
233
|
+
method="PATCH",
|
|
234
|
+
json={
|
|
235
|
+
"remote_field_traversal_path": remote_field_traversal_path,
|
|
236
|
+
"remote_method": remote_method,
|
|
237
|
+
"remote_url_path": remote_url_path,
|
|
238
|
+
"jmes_path": jmes_path,
|
|
239
|
+
},
|
|
240
|
+
headers={
|
|
241
|
+
"content-type": "application/json",
|
|
242
|
+
},
|
|
243
|
+
request_options=request_options,
|
|
244
|
+
omit=OMIT,
|
|
245
|
+
)
|
|
246
|
+
try:
|
|
247
|
+
if 200 <= _response.status_code < 300:
|
|
248
|
+
_data = typing.cast(
|
|
249
|
+
FieldMappingInstanceResponse,
|
|
250
|
+
construct_type(
|
|
251
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
252
|
+
object_=_response.json(),
|
|
253
|
+
),
|
|
254
|
+
)
|
|
255
|
+
return HttpResponse(response=_response, data=_data)
|
|
256
|
+
_response_json = _response.json()
|
|
257
|
+
except JSONDecodeError:
|
|
258
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
259
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
260
|
+
|
|
261
|
+
def remote_fields_retrieve(
|
|
262
|
+
self,
|
|
263
|
+
*,
|
|
264
|
+
common_models: typing.Optional[str] = None,
|
|
265
|
+
include_example_values: typing.Optional[str] = None,
|
|
266
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
267
|
+
) -> HttpResponse[RemoteFieldApiResponse]:
|
|
268
|
+
"""
|
|
269
|
+
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/).
|
|
270
|
+
|
|
271
|
+
Parameters
|
|
272
|
+
----------
|
|
273
|
+
common_models : typing.Optional[str]
|
|
274
|
+
A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
|
|
275
|
+
|
|
276
|
+
include_example_values : typing.Optional[str]
|
|
277
|
+
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.
|
|
278
|
+
|
|
279
|
+
request_options : typing.Optional[RequestOptions]
|
|
280
|
+
Request-specific configuration.
|
|
281
|
+
|
|
282
|
+
Returns
|
|
283
|
+
-------
|
|
284
|
+
HttpResponse[RemoteFieldApiResponse]
|
|
285
|
+
|
|
286
|
+
"""
|
|
287
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
288
|
+
"knowledgebase/v1/remote-fields",
|
|
289
|
+
method="GET",
|
|
290
|
+
params={
|
|
291
|
+
"common_models": common_models,
|
|
292
|
+
"include_example_values": include_example_values,
|
|
293
|
+
},
|
|
294
|
+
request_options=request_options,
|
|
295
|
+
)
|
|
296
|
+
try:
|
|
297
|
+
if 200 <= _response.status_code < 300:
|
|
298
|
+
_data = typing.cast(
|
|
299
|
+
RemoteFieldApiResponse,
|
|
300
|
+
construct_type(
|
|
301
|
+
type_=RemoteFieldApiResponse, # type: ignore
|
|
302
|
+
object_=_response.json(),
|
|
303
|
+
),
|
|
304
|
+
)
|
|
305
|
+
return HttpResponse(response=_response, data=_data)
|
|
306
|
+
_response_json = _response.json()
|
|
307
|
+
except JSONDecodeError:
|
|
308
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
309
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
310
|
+
|
|
311
|
+
def target_fields_retrieve(
|
|
312
|
+
self, *, request_options: typing.Optional[RequestOptions] = None
|
|
313
|
+
) -> HttpResponse[ExternalTargetFieldApiResponse]:
|
|
314
|
+
"""
|
|
315
|
+
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/).
|
|
316
|
+
|
|
317
|
+
Parameters
|
|
318
|
+
----------
|
|
319
|
+
request_options : typing.Optional[RequestOptions]
|
|
320
|
+
Request-specific configuration.
|
|
321
|
+
|
|
322
|
+
Returns
|
|
323
|
+
-------
|
|
324
|
+
HttpResponse[ExternalTargetFieldApiResponse]
|
|
325
|
+
|
|
326
|
+
"""
|
|
327
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
328
|
+
"knowledgebase/v1/target-fields",
|
|
329
|
+
method="GET",
|
|
330
|
+
request_options=request_options,
|
|
331
|
+
)
|
|
332
|
+
try:
|
|
333
|
+
if 200 <= _response.status_code < 300:
|
|
334
|
+
_data = typing.cast(
|
|
335
|
+
ExternalTargetFieldApiResponse,
|
|
336
|
+
construct_type(
|
|
337
|
+
type_=ExternalTargetFieldApiResponse, # type: ignore
|
|
338
|
+
object_=_response.json(),
|
|
339
|
+
),
|
|
340
|
+
)
|
|
341
|
+
return HttpResponse(response=_response, data=_data)
|
|
342
|
+
_response_json = _response.json()
|
|
343
|
+
except JSONDecodeError:
|
|
344
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
345
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
class AsyncRawFieldMappingClient:
|
|
349
|
+
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
|
350
|
+
self._client_wrapper = client_wrapper
|
|
351
|
+
|
|
352
|
+
async def field_mappings_retrieve(
|
|
353
|
+
self,
|
|
354
|
+
*,
|
|
355
|
+
exclude_remote_field_metadata: typing.Optional[bool] = None,
|
|
356
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
357
|
+
) -> AsyncHttpResponse[FieldMappingApiInstanceResponse]:
|
|
358
|
+
"""
|
|
359
|
+
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/).
|
|
360
|
+
|
|
361
|
+
Parameters
|
|
362
|
+
----------
|
|
363
|
+
exclude_remote_field_metadata : typing.Optional[bool]
|
|
364
|
+
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.
|
|
365
|
+
|
|
366
|
+
request_options : typing.Optional[RequestOptions]
|
|
367
|
+
Request-specific configuration.
|
|
368
|
+
|
|
369
|
+
Returns
|
|
370
|
+
-------
|
|
371
|
+
AsyncHttpResponse[FieldMappingApiInstanceResponse]
|
|
372
|
+
|
|
373
|
+
"""
|
|
374
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
375
|
+
"knowledgebase/v1/field-mappings",
|
|
376
|
+
method="GET",
|
|
377
|
+
params={
|
|
378
|
+
"exclude_remote_field_metadata": exclude_remote_field_metadata,
|
|
379
|
+
},
|
|
380
|
+
request_options=request_options,
|
|
381
|
+
)
|
|
382
|
+
try:
|
|
383
|
+
if 200 <= _response.status_code < 300:
|
|
384
|
+
_data = typing.cast(
|
|
385
|
+
FieldMappingApiInstanceResponse,
|
|
386
|
+
construct_type(
|
|
387
|
+
type_=FieldMappingApiInstanceResponse, # type: ignore
|
|
388
|
+
object_=_response.json(),
|
|
389
|
+
),
|
|
390
|
+
)
|
|
391
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
392
|
+
_response_json = _response.json()
|
|
393
|
+
except JSONDecodeError:
|
|
394
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
395
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
396
|
+
|
|
397
|
+
async def field_mappings_create(
|
|
398
|
+
self,
|
|
399
|
+
*,
|
|
400
|
+
target_field_name: str,
|
|
401
|
+
target_field_description: str,
|
|
402
|
+
remote_field_traversal_path: typing.Sequence[typing.Optional[typing.Any]],
|
|
403
|
+
remote_method: str,
|
|
404
|
+
remote_url_path: str,
|
|
405
|
+
common_model_name: str,
|
|
406
|
+
exclude_remote_field_metadata: typing.Optional[bool] = None,
|
|
407
|
+
jmes_path: typing.Optional[str] = OMIT,
|
|
408
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
409
|
+
) -> AsyncHttpResponse[FieldMappingInstanceResponse]:
|
|
410
|
+
"""
|
|
411
|
+
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.
|
|
412
|
+
|
|
413
|
+
Parameters
|
|
414
|
+
----------
|
|
415
|
+
target_field_name : str
|
|
416
|
+
The name of the target field you want this remote field to map to.
|
|
417
|
+
|
|
418
|
+
target_field_description : str
|
|
419
|
+
The description of the target field you want this remote field to map to.
|
|
420
|
+
|
|
421
|
+
remote_field_traversal_path : typing.Sequence[typing.Optional[typing.Any]]
|
|
422
|
+
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
|
|
423
|
+
|
|
424
|
+
remote_method : str
|
|
425
|
+
The method of the remote endpoint where the remote field is coming from.
|
|
426
|
+
|
|
427
|
+
remote_url_path : str
|
|
428
|
+
The path of the remote endpoint where the remote field is coming from.
|
|
429
|
+
|
|
430
|
+
common_model_name : str
|
|
431
|
+
The name of the Common Model that the remote field corresponds to in a given category.
|
|
432
|
+
|
|
433
|
+
exclude_remote_field_metadata : typing.Optional[bool]
|
|
434
|
+
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.
|
|
435
|
+
|
|
436
|
+
jmes_path : typing.Optional[str]
|
|
437
|
+
JMES path to specify json query expression to be used on field mapping.
|
|
438
|
+
|
|
439
|
+
request_options : typing.Optional[RequestOptions]
|
|
440
|
+
Request-specific configuration.
|
|
441
|
+
|
|
442
|
+
Returns
|
|
443
|
+
-------
|
|
444
|
+
AsyncHttpResponse[FieldMappingInstanceResponse]
|
|
445
|
+
|
|
446
|
+
"""
|
|
447
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
448
|
+
"knowledgebase/v1/field-mappings",
|
|
449
|
+
method="POST",
|
|
450
|
+
params={
|
|
451
|
+
"exclude_remote_field_metadata": exclude_remote_field_metadata,
|
|
452
|
+
},
|
|
453
|
+
json={
|
|
454
|
+
"target_field_name": target_field_name,
|
|
455
|
+
"target_field_description": target_field_description,
|
|
456
|
+
"remote_field_traversal_path": remote_field_traversal_path,
|
|
457
|
+
"remote_method": remote_method,
|
|
458
|
+
"remote_url_path": remote_url_path,
|
|
459
|
+
"common_model_name": common_model_name,
|
|
460
|
+
"jmes_path": jmes_path,
|
|
461
|
+
},
|
|
462
|
+
headers={
|
|
463
|
+
"content-type": "application/json",
|
|
464
|
+
},
|
|
465
|
+
request_options=request_options,
|
|
466
|
+
omit=OMIT,
|
|
467
|
+
)
|
|
468
|
+
try:
|
|
469
|
+
if 200 <= _response.status_code < 300:
|
|
470
|
+
_data = typing.cast(
|
|
471
|
+
FieldMappingInstanceResponse,
|
|
472
|
+
construct_type(
|
|
473
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
474
|
+
object_=_response.json(),
|
|
475
|
+
),
|
|
476
|
+
)
|
|
477
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
478
|
+
_response_json = _response.json()
|
|
479
|
+
except JSONDecodeError:
|
|
480
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
481
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
482
|
+
|
|
483
|
+
async def field_mappings_destroy(
|
|
484
|
+
self, field_mapping_id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
485
|
+
) -> AsyncHttpResponse[FieldMappingInstanceResponse]:
|
|
486
|
+
"""
|
|
487
|
+
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.
|
|
488
|
+
|
|
489
|
+
Parameters
|
|
490
|
+
----------
|
|
491
|
+
field_mapping_id : str
|
|
492
|
+
|
|
493
|
+
request_options : typing.Optional[RequestOptions]
|
|
494
|
+
Request-specific configuration.
|
|
495
|
+
|
|
496
|
+
Returns
|
|
497
|
+
-------
|
|
498
|
+
AsyncHttpResponse[FieldMappingInstanceResponse]
|
|
499
|
+
|
|
500
|
+
"""
|
|
501
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
502
|
+
f"knowledgebase/v1/field-mappings/{jsonable_encoder(field_mapping_id)}",
|
|
503
|
+
method="DELETE",
|
|
504
|
+
request_options=request_options,
|
|
505
|
+
)
|
|
506
|
+
try:
|
|
507
|
+
if 200 <= _response.status_code < 300:
|
|
508
|
+
_data = typing.cast(
|
|
509
|
+
FieldMappingInstanceResponse,
|
|
510
|
+
construct_type(
|
|
511
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
512
|
+
object_=_response.json(),
|
|
513
|
+
),
|
|
514
|
+
)
|
|
515
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
516
|
+
_response_json = _response.json()
|
|
517
|
+
except JSONDecodeError:
|
|
518
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
519
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
520
|
+
|
|
521
|
+
async def field_mappings_partial_update(
|
|
522
|
+
self,
|
|
523
|
+
field_mapping_id: str,
|
|
524
|
+
*,
|
|
525
|
+
remote_field_traversal_path: typing.Optional[typing.Sequence[typing.Optional[typing.Any]]] = OMIT,
|
|
526
|
+
remote_method: typing.Optional[str] = OMIT,
|
|
527
|
+
remote_url_path: typing.Optional[str] = OMIT,
|
|
528
|
+
jmes_path: typing.Optional[str] = OMIT,
|
|
529
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
530
|
+
) -> AsyncHttpResponse[FieldMappingInstanceResponse]:
|
|
531
|
+
"""
|
|
532
|
+
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.
|
|
533
|
+
|
|
534
|
+
Parameters
|
|
535
|
+
----------
|
|
536
|
+
field_mapping_id : str
|
|
537
|
+
|
|
538
|
+
remote_field_traversal_path : typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]
|
|
539
|
+
The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
|
|
540
|
+
|
|
541
|
+
remote_method : typing.Optional[str]
|
|
542
|
+
The method of the remote endpoint where the remote field is coming from.
|
|
543
|
+
|
|
544
|
+
remote_url_path : typing.Optional[str]
|
|
545
|
+
The path of the remote endpoint where the remote field is coming from.
|
|
546
|
+
|
|
547
|
+
jmes_path : typing.Optional[str]
|
|
548
|
+
JMES path to specify json query expression to be used on field mapping.
|
|
549
|
+
|
|
550
|
+
request_options : typing.Optional[RequestOptions]
|
|
551
|
+
Request-specific configuration.
|
|
552
|
+
|
|
553
|
+
Returns
|
|
554
|
+
-------
|
|
555
|
+
AsyncHttpResponse[FieldMappingInstanceResponse]
|
|
556
|
+
|
|
557
|
+
"""
|
|
558
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
559
|
+
f"knowledgebase/v1/field-mappings/{jsonable_encoder(field_mapping_id)}",
|
|
560
|
+
method="PATCH",
|
|
561
|
+
json={
|
|
562
|
+
"remote_field_traversal_path": remote_field_traversal_path,
|
|
563
|
+
"remote_method": remote_method,
|
|
564
|
+
"remote_url_path": remote_url_path,
|
|
565
|
+
"jmes_path": jmes_path,
|
|
566
|
+
},
|
|
567
|
+
headers={
|
|
568
|
+
"content-type": "application/json",
|
|
569
|
+
},
|
|
570
|
+
request_options=request_options,
|
|
571
|
+
omit=OMIT,
|
|
572
|
+
)
|
|
573
|
+
try:
|
|
574
|
+
if 200 <= _response.status_code < 300:
|
|
575
|
+
_data = typing.cast(
|
|
576
|
+
FieldMappingInstanceResponse,
|
|
577
|
+
construct_type(
|
|
578
|
+
type_=FieldMappingInstanceResponse, # type: ignore
|
|
579
|
+
object_=_response.json(),
|
|
580
|
+
),
|
|
581
|
+
)
|
|
582
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
583
|
+
_response_json = _response.json()
|
|
584
|
+
except JSONDecodeError:
|
|
585
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
586
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
587
|
+
|
|
588
|
+
async def remote_fields_retrieve(
|
|
589
|
+
self,
|
|
590
|
+
*,
|
|
591
|
+
common_models: typing.Optional[str] = None,
|
|
592
|
+
include_example_values: typing.Optional[str] = None,
|
|
593
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
594
|
+
) -> AsyncHttpResponse[RemoteFieldApiResponse]:
|
|
595
|
+
"""
|
|
596
|
+
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/).
|
|
597
|
+
|
|
598
|
+
Parameters
|
|
599
|
+
----------
|
|
600
|
+
common_models : typing.Optional[str]
|
|
601
|
+
A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
|
|
602
|
+
|
|
603
|
+
include_example_values : typing.Optional[str]
|
|
604
|
+
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.
|
|
605
|
+
|
|
606
|
+
request_options : typing.Optional[RequestOptions]
|
|
607
|
+
Request-specific configuration.
|
|
608
|
+
|
|
609
|
+
Returns
|
|
610
|
+
-------
|
|
611
|
+
AsyncHttpResponse[RemoteFieldApiResponse]
|
|
612
|
+
|
|
613
|
+
"""
|
|
614
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
615
|
+
"knowledgebase/v1/remote-fields",
|
|
616
|
+
method="GET",
|
|
617
|
+
params={
|
|
618
|
+
"common_models": common_models,
|
|
619
|
+
"include_example_values": include_example_values,
|
|
620
|
+
},
|
|
621
|
+
request_options=request_options,
|
|
622
|
+
)
|
|
623
|
+
try:
|
|
624
|
+
if 200 <= _response.status_code < 300:
|
|
625
|
+
_data = typing.cast(
|
|
626
|
+
RemoteFieldApiResponse,
|
|
627
|
+
construct_type(
|
|
628
|
+
type_=RemoteFieldApiResponse, # type: ignore
|
|
629
|
+
object_=_response.json(),
|
|
630
|
+
),
|
|
631
|
+
)
|
|
632
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
633
|
+
_response_json = _response.json()
|
|
634
|
+
except JSONDecodeError:
|
|
635
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
636
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|
|
637
|
+
|
|
638
|
+
async def target_fields_retrieve(
|
|
639
|
+
self, *, request_options: typing.Optional[RequestOptions] = None
|
|
640
|
+
) -> AsyncHttpResponse[ExternalTargetFieldApiResponse]:
|
|
641
|
+
"""
|
|
642
|
+
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/).
|
|
643
|
+
|
|
644
|
+
Parameters
|
|
645
|
+
----------
|
|
646
|
+
request_options : typing.Optional[RequestOptions]
|
|
647
|
+
Request-specific configuration.
|
|
648
|
+
|
|
649
|
+
Returns
|
|
650
|
+
-------
|
|
651
|
+
AsyncHttpResponse[ExternalTargetFieldApiResponse]
|
|
652
|
+
|
|
653
|
+
"""
|
|
654
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
655
|
+
"knowledgebase/v1/target-fields",
|
|
656
|
+
method="GET",
|
|
657
|
+
request_options=request_options,
|
|
658
|
+
)
|
|
659
|
+
try:
|
|
660
|
+
if 200 <= _response.status_code < 300:
|
|
661
|
+
_data = typing.cast(
|
|
662
|
+
ExternalTargetFieldApiResponse,
|
|
663
|
+
construct_type(
|
|
664
|
+
type_=ExternalTargetFieldApiResponse, # type: ignore
|
|
665
|
+
object_=_response.json(),
|
|
666
|
+
),
|
|
667
|
+
)
|
|
668
|
+
return AsyncHttpResponse(response=_response, data=_data)
|
|
669
|
+
_response_json = _response.json()
|
|
670
|
+
except JSONDecodeError:
|
|
671
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
|
|
672
|
+
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
|