diff --git a/README.md b/README.md index 290a4f5c..73bd2a65 100644 --- a/README.md +++ b/README.md @@ -262,3 +262,4 @@ while response.next is not None: + diff --git a/poetry.lock b/poetry.lock index 69701adb..5092d3a1 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2026.1.4" +version = "2026.2.25" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.7" files = [ - {file = "certifi-2026.1.4-py3-none-any.whl", hash = "sha256:9943707519e4add1115f44c2bc244f782c0249876bf51b6599fee1ffbedd685c"}, - {file = "certifi-2026.1.4.tar.gz", hash = "sha256:ac726dd470482006e014ad384921ed6438c457018f4b3d204aea4281258b2120"}, + {file = "certifi-2026.2.25-py3-none-any.whl", hash = "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa"}, + {file = "certifi-2026.2.25.tar.gz", hash = "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"}, ] [[package]] @@ -222,13 +222,13 @@ files = [ [[package]] name = "packaging" -version = "25.0" +version = "26.0" description = "Core utilities for Python packages" optional = false python-versions = ">=3.8" files = [ - {file = "packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484"}, - {file = "packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f"}, + {file = "packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529"}, + {file = "packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4"}, ] [[package]] @@ -483,58 +483,58 @@ files = [ [[package]] name = "tomli" -version = "2.4.0" +version = "2.4.1" description = "A lil' TOML parser" optional = false python-versions = ">=3.8" files = [ - {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"}, - {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"}, - {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"}, - {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"}, - {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"}, - {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"}, - {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"}, - {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"}, - {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"}, - {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"}, - {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"}, - {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"}, - {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"}, - {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"}, - {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"}, - {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"}, - {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"}, - {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"}, - {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"}, - {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"}, - {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"}, - {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"}, - {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"}, - {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"}, - {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"}, - {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"}, - {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"}, - {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"}, - {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"}, - {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"}, - {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"}, - {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"}, - {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"}, - {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"}, - {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"}, - {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"}, - {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"}, - {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"}, - {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"}, - {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"}, - {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"}, - {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"}, - {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"}, - {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"}, - {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"}, - {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"}, - {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"}, + {file = "tomli-2.4.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f8f0fc26ec2cc2b965b7a3b87cd19c5c6b8c5e5f436b984e85f486d652285c30"}, + {file = "tomli-2.4.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4ab97e64ccda8756376892c53a72bd1f964e519c77236368527f758fbc36a53a"}, + {file = "tomli-2.4.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:96481a5786729fd470164b47cdb3e0e58062a496f455ee41b4403be77cb5a076"}, + {file = "tomli-2.4.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5a881ab208c0baf688221f8cecc5401bd291d67e38a1ac884d6736cbcd8247e9"}, + {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:47149d5bd38761ac8be13a84864bf0b7b70bc051806bc3669ab1cbc56216b23c"}, + {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:ec9bfaf3ad2df51ace80688143a6a4ebc09a248f6ff781a9945e51937008fcbc"}, + {file = "tomli-2.4.1-cp311-cp311-win32.whl", hash = "sha256:ff2983983d34813c1aeb0fa89091e76c3a22889ee83ab27c5eeb45100560c049"}, + {file = "tomli-2.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:5ee18d9ebdb417e384b58fe414e8d6af9f4e7a0ae761519fb50f721de398dd4e"}, + {file = "tomli-2.4.1-cp311-cp311-win_arm64.whl", hash = "sha256:c2541745709bad0264b7d4705ad453b76ccd191e64aa6f0fc66b69a293a45ece"}, + {file = "tomli-2.4.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c742f741d58a28940ce01d58f0ab2ea3ced8b12402f162f4d534dfe18ba1cd6a"}, + {file = "tomli-2.4.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7f86fd587c4ed9dd76f318225e7d9b29cfc5a9d43de44e5754db8d1128487085"}, + {file = "tomli-2.4.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ff18e6a727ee0ab0388507b89d1bc6a22b138d1e2fa56d1ad494586d61d2eae9"}, + {file = "tomli-2.4.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:136443dbd7e1dee43c68ac2694fde36b2849865fa258d39bf822c10e8068eac5"}, + {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:5e262d41726bc187e69af7825504c933b6794dc3fbd5945e41a79bb14c31f585"}, + {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:5cb41aa38891e073ee49d55fbc7839cfdb2bc0e600add13874d048c94aadddd1"}, + {file = "tomli-2.4.1-cp312-cp312-win32.whl", hash = "sha256:da25dc3563bff5965356133435b757a795a17b17d01dbc0f42fb32447ddfd917"}, + {file = "tomli-2.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:52c8ef851d9a240f11a88c003eacb03c31fc1c9c4ec64a99a0f922b93874fda9"}, + {file = "tomli-2.4.1-cp312-cp312-win_arm64.whl", hash = "sha256:f758f1b9299d059cc3f6546ae2af89670cb1c4d48ea29c3cacc4fe7de3058257"}, + {file = "tomli-2.4.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:36d2bd2ad5fb9eaddba5226aa02c8ec3fa4f192631e347b3ed28186d43be6b54"}, + {file = "tomli-2.4.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:eb0dc4e38e6a1fd579e5d50369aa2e10acfc9cace504579b2faabb478e76941a"}, + {file = "tomli-2.4.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c7f2c7f2b9ca6bdeef8f0fa897f8e05085923eb091721675170254cbc5b02897"}, + {file = "tomli-2.4.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f3c6818a1a86dd6dca7ddcaaf76947d5ba31aecc28cb1b67009a5877c9a64f3f"}, + {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:d312ef37c91508b0ab2cee7da26ec0b3ed2f03ce12bd87a588d771ae15dcf82d"}, + {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:51529d40e3ca50046d7606fa99ce3956a617f9b36380da3b7f0dd3dd28e68cb5"}, + {file = "tomli-2.4.1-cp313-cp313-win32.whl", hash = "sha256:2190f2e9dd7508d2a90ded5ed369255980a1bcdd58e52f7fe24b8162bf9fedbd"}, + {file = "tomli-2.4.1-cp313-cp313-win_amd64.whl", hash = "sha256:8d65a2fbf9d2f8352685bc1364177ee3923d6baf5e7f43ea4959d7d8bc326a36"}, + {file = "tomli-2.4.1-cp313-cp313-win_arm64.whl", hash = "sha256:4b605484e43cdc43f0954ddae319fb75f04cc10dd80d830540060ee7cd0243cd"}, + {file = "tomli-2.4.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:fd0409a3653af6c147209d267a0e4243f0ae46b011aa978b1080359fddc9b6cf"}, + {file = "tomli-2.4.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:a120733b01c45e9a0c34aeef92bf0cf1d56cfe81ed9d47d562f9ed591a9828ac"}, + {file = "tomli-2.4.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:559db847dc486944896521f68d8190be1c9e719fced785720d2216fe7022b662"}, + {file = "tomli-2.4.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:01f520d4f53ef97964a240a035ec2a869fe1a37dde002b57ebc4417a27ccd853"}, + {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7f94b27a62cfad8496c8d2513e1a222dd446f095fca8987fceef261225538a15"}, + {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ede3e6487c5ef5d28634ba3f31f989030ad6af71edfb0055cbbd14189ff240ba"}, + {file = "tomli-2.4.1-cp314-cp314-win32.whl", hash = "sha256:3d48a93ee1c9b79c04bb38772ee1b64dcf18ff43085896ea460ca8dec96f35f6"}, + {file = "tomli-2.4.1-cp314-cp314-win_amd64.whl", hash = "sha256:88dceee75c2c63af144e456745e10101eb67361050196b0b6af5d717254dddf7"}, + {file = "tomli-2.4.1-cp314-cp314-win_arm64.whl", hash = "sha256:b8c198f8c1805dc42708689ed6864951fd2494f924149d3e4bce7710f8eb5232"}, + {file = "tomli-2.4.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:d4d8fe59808a54658fcc0160ecfb1b30f9089906c50b23bcb4c69eddc19ec2b4"}, + {file = "tomli-2.4.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:7008df2e7655c495dd12d2a4ad038ff878d4ca4b81fccaf82b714e07eae4402c"}, + {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1d8591993e228b0c930c4bb0db464bdad97b3289fb981255d6c9a41aedc84b2d"}, + {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:734e20b57ba95624ecf1841e72b53f6e186355e216e5412de414e3c51e5e3c41"}, + {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8a650c2dbafa08d42e51ba0b62740dae4ecb9338eefa093aa5c78ceb546fcd5c"}, + {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:504aa796fe0569bb43171066009ead363de03675276d2d121ac1a4572397870f"}, + {file = "tomli-2.4.1-cp314-cp314t-win32.whl", hash = "sha256:b1d22e6e9387bf4739fbe23bfa80e93f6b0373a7f1b96c6227c32bef95a4d7a8"}, + {file = "tomli-2.4.1-cp314-cp314t-win_amd64.whl", hash = "sha256:2c1c351919aca02858f740c6d33adea0c5deea37f9ecca1cc1ef9e884a619d26"}, + {file = "tomli-2.4.1-cp314-cp314t-win_arm64.whl", hash = "sha256:eab21f45c7f66c13f2a9e0e1535309cee140182a9cdae1e041d02e47291e8396"}, + {file = "tomli-2.4.1-py3-none-any.whl", hash = "sha256:0d85819802132122da43cb86656f8d1f8c6587d54ae7dcaf30e90533028b49fe"}, + {file = "tomli-2.4.1.tar.gz", hash = "sha256:7c7e1a961a0b2f2472c1ac5b69affa0ae1132c39adcb67aba98568702b9cc23f"}, ] [[package]] diff --git a/pyproject.toml b/pyproject.toml index 6e9177d0..62139c69 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.6.1" +version = "2.6.2" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 3bf686bb..72c3f6b5 100644 --- a/reference.md +++ b/reference.md @@ -12220,8 +12220,8 @@ client.chat.webhook_receivers.create( -## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -12254,7 +12254,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.crm.account_details.retrieve() ```
@@ -12282,8 +12282,8 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +## Crm AccountToken +
client.crm.account_token.retrieve(...)
@@ -12316,7 +12316,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( +client.crm.account_token.retrieve( public_token="public_token", ) @@ -12354,8 +12354,8 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -12367,7 +12367,7 @@ client.filestorage.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Account` objects.
@@ -12382,18 +12382,36 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python +import datetime + 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", +client.crm.accounts.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", ), + name="name", + owner_id="owner_id", + page_size=1, + remote_id="remote_id", ) ``` @@ -12410,7 +12428,7 @@ client.filestorage.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -12418,70 +12436,103 @@ client.filestorage.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. +
+
+
+**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.filestorage.async_passthrough.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. + +
+
+
-Retrieves data from earlier async-passthrough POST request +**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). +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +
+
-``` +**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. +
+ +
+
+ +**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**async_passthrough_receipt_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -12501,8 +12552,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.crm.accounts.create(...)
@@ -12514,7 +12564,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Creates an `Account` object with the given values.
@@ -12530,18 +12580,16 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", - page_size=1, - start_date="start_date", - user_email="user_email", +client.crm.accounts.create( + is_debug_mode=True, + run_async=True, + model=AccountRequest(), ) ``` @@ -12558,31 +12606,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` - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model:** `AccountRequest`
@@ -12590,7 +12614,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.
@@ -12598,7 +12622,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.
@@ -12618,8 +12642,7 @@ client.filestorage.audit_trail.list(
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +
client.crm.accounts.retrieve(...)
@@ -12631,7 +12654,7 @@ client.filestorage.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns an `Account` object with the given `id`.
@@ -12652,7 +12675,12 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.crm.accounts.retrieve( + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) ``` @@ -12668,65 +12696,43 @@ client.filestorage.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[typing.Literal["owner"]]` — 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_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.filestorage.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 - -
-
-
@@ -12742,7 +12748,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +
client.crm.accounts.partial_update(...)
@@ -12754,7 +12760,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). +Updates an `Account` object with the given `id`.
@@ -12770,12 +12776,18 @@ Get all available permissions for Merge Common Models and fields for a single Li ```python from merge import Merge +from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_retrieve() +client.crm.accounts.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedAccountRequest(), +) ``` @@ -12791,31 +12803,63 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**model:** `PatchedAccountRequest` +
-
-
client.filestorage.scopes.linked_account_scopes_create(...)
-#### 📝 Description +**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. + +
+
+ +
-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) +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ + + + + + +
+ +
client.crm.accounts.meta_patch_retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `CRMAccount` PATCHs.
@@ -12831,42 +12875,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.crm.accounts.meta_patch_retrieve( + id="id", ) ``` @@ -12883,7 +12898,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**id:** `str`
@@ -12903,8 +12918,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete() +
client.crm.accounts.meta_post_retrieve()
@@ -12916,7 +12930,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns metadata for `CRMAccount` POSTs.
@@ -12937,7 +12951,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.delete_account.delete() +client.crm.accounts.meta_post_retrieve() ``` @@ -12965,8 +12979,7 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives -
client.filestorage.drives.list(...) +
client.crm.accounts.remote_field_classes_list(...)
@@ -12978,7 +12991,7 @@ client.filestorage.delete_account.delete()
-Returns a list of `Drive` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -12993,34 +13006,21 @@ Returns a list of `Drive` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.crm.accounts.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - name="name", + is_common_model_field=True, + is_custom=True, page_size=1, - remote_id="remote_id", ) ``` @@ -13037,22 +13037,6 @@ client.filestorage.drives.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.
@@ -13077,7 +13061,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). +**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.
@@ -13085,7 +13069,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. +**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).
@@ -13093,7 +13077,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. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -13101,7 +13085,7 @@ client.filestorage.drives.list(
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -13117,14 +13101,6 @@ client.filestorage.drives.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13137,7 +13113,8 @@ client.filestorage.drives.list(
-
client.filestorage.drives.retrieve(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -13149,7 +13126,7 @@ client.filestorage.drives.list(
-Returns a `Drive` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -13165,15 +13142,17 @@ Returns a `Drive` 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.filestorage.drives.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.crm.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -13190,23 +13169,7 @@ client.filestorage.drives.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`
@@ -13226,8 +13189,7 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +
client.crm.async_passthrough.retrieve(...)
@@ -13239,7 +13201,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/). +Retrieves data from earlier async-passthrough POST request
@@ -13260,8 +13222,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -13278,7 +13240,7 @@ 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. +**async_passthrough_receipt_id:** `str`
@@ -13298,7 +13260,8 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-
client.filestorage.field_mapping.field_mappings_create(...) +## Crm AuditTrail +
client.crm.audit_trail.list(...)
@@ -13310,7 +13273,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. +Gets a list of audit trail events.
@@ -13331,14 +13294,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", ) ``` @@ -13355,15 +13317,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13371,7 +13325,7 @@ client.filestorage.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. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -13379,7 +13333,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**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`
@@ -13387,7 +13341,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13395,7 +13349,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. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -13403,7 +13357,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. +**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.
@@ -13423,7 +13377,8 @@ client.filestorage.field_mapping.field_mappings_create(
-
client.filestorage.field_mapping.field_mappings_destroy(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -13435,7 +13390,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 a list of models and actions available for an account.
@@ -13456,9 +13411,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.crm.available_actions.retrieve() ``` @@ -13474,14 +13427,6 @@ client.filestorage.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13494,7 +13439,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -13506,7 +13452,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. +Returns a list of `Contact` objects.
@@ -13521,31 +13467,56 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python +import datetime + from merge import Merge +from merge.resources.crm.resources.contacts import ContactsListRequestExpand 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", -) - -``` -
-
- - - -#### ⚙️ Parameters - -
-
- +client.crm.contacts.list( + account_id="account_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email_addresses="email_addresses", + expand=ContactsListRequestExpand.ACCOUNT, + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + phone_numbers="phone_numbers", + remote_id="remote_id", +) + +``` +
+
+ + + +#### ⚙️ Parameters +
-**field_mapping_id:** `str` +
+
+ +**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -13553,7 +13524,7 @@ 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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13561,7 +13532,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13569,7 +13540,7 @@ client.filestorage.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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13577,71 +13548,79 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.filestorage.field_mapping.remote_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 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/). -
-
+**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 -
+**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.filestorage.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", -) - -``` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -13649,7 +13628,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13669,7 +13648,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
client.filestorage.field_mapping.target_fields_retrieve() +
client.crm.contacts.create(...)
@@ -13681,7 +13660,7 @@ client.filestorage.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/). +Creates a `Contact` object with the given values.
@@ -13697,12 +13676,17 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun ```python from merge import Merge +from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.target_fields_retrieve() +client.crm.contacts.create( + is_debug_mode=True, + run_async=True, + model=ContactRequest(), +) ``` @@ -13718,6 +13702,30 @@ client.filestorage.field_mapping.target_fields_retrieve()
+**model:** `ContactRequest` + +
+
+ +
+
+ +**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.
@@ -13730,8 +13738,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +
client.crm.contacts.retrieve(...)
@@ -13743,7 +13750,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Returns a `Contact` object with the given `id`.
@@ -13758,49 +13765,19 @@ Returns a list of `File` objects.
```python -import datetime - from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesListRequestExpand, - FilesListRequestOrderBy, -) +from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - drive_id="drive_id", - expand=FilesListRequestExpand.DRIVE, - folder_id="folder_id", - include_deleted_data=True, +client.crm.contacts.retrieve( + id="id", + expand=ContactsRetrieveRequestExpand.ACCOUNT, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - mime_type="mime_type", - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - name="name", - order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, - page_size=1, - remote_created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_id="remote_id", ) ``` @@ -13817,7 +13794,7 @@ client.filestorage.files.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -13825,7 +13802,7 @@ client.filestorage.files.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.
@@ -13833,7 +13810,7 @@ client.filestorage.files.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.
@@ -13841,7 +13818,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. +**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.
@@ -13849,7 +13826,7 @@ 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. +**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).
@@ -13857,47 +13834,74 @@ client.filestorage.files.list(
-**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. +**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.crm.contacts.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 `Contact` 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 +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", + is_debug_mode=True, + run_async=True, + model=PatchedContactRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**id:** `str`
@@ -13905,7 +13909,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. +**model:** `PatchedContactRequest`
@@ -13913,39 +13917,7 @@ client.filestorage.files.list(
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. - -
-
- -
-
- -**order_by:** `typing.Optional[FilesListRequestOrderBy]` — 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. - -
-
- -
-
- -**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime. - -
-
- -
-
- -**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -13953,7 +13925,7 @@ client.filestorage.files.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.
@@ -13973,7 +13945,7 @@ client.filestorage.files.list(
-
client.filestorage.files.create(...) +
client.crm.contacts.ignore_create(...)
@@ -13985,7 +13957,7 @@ client.filestorage.files.list(
-Creates a `File` 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.
@@ -14001,16 +13973,17 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( - is_debug_mode=True, - run_async=True, - model=FileRequest(), +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -14027,15 +14000,7 @@ 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. +**model_id:** `str`
@@ -14043,7 +14008,7 @@ client.filestorage.files.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**request:** `IgnoreCommonModelRequest`
@@ -14063,7 +14028,7 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +
client.crm.contacts.meta_patch_retrieve(...)
@@ -14075,7 +14040,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns metadata for `CRMContact` PATCHs.
@@ -14091,19 +14056,13 @@ Returns a `File` object with the given `id`. ```python from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( +client.crm.contacts.meta_patch_retrieve( id="id", - expand=FilesRetrieveRequestExpand.DRIVE, - include_remote_data=True, - include_shell_data=True, ) ``` @@ -14128,30 +14087,6 @@ 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. - -
-
- -
-
- -**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.
@@ -14164,7 +14099,7 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +
client.crm.contacts.meta_post_retrieve()
@@ -14176,7 +14111,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 metadata for `CRMContact` POSTs.
@@ -14197,10 +14132,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( - id="id", - mime_type="mime_type", -) +client.crm.contacts.meta_post_retrieve() ``` @@ -14216,22 +14148,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.
@@ -14244,7 +14160,7 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +
client.crm.contacts.remote_field_classes_list(...)
@@ -14256,7 +14172,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 `RemoteFieldClass` objects.
@@ -14272,23 +14188,19 @@ Returns metadata to construct authenticated file download requests, allowing you ```python from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesDownloadRequestMetaListRequestOrderBy, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list( - created_after="created_after", - created_before="created_before", +client.crm.contacts.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, - mime_types="mime_types", - modified_after="modified_after", - modified_before="modified_before", - order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, page_size=1, ) @@ -14306,22 +14218,6 @@ client.filestorage.files.download_request_meta_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.
@@ -14330,14 +14226,6 @@ client.filestorage.files.download_request_meta_list(
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings. - -
-
- -
-
- **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/).
@@ -14346,7 +14234,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.
@@ -14354,7 +14242,7 @@ client.filestorage.files.download_request_meta_list(
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified 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.
@@ -14362,7 +14250,7 @@ client.filestorage.files.download_request_meta_list(
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified 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).
@@ -14370,7 +14258,7 @@ 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. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -14378,7 +14266,7 @@ client.filestorage.files.download_request_meta_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
@@ -14386,63 +14274,10 @@ client.filestorage.files.download_request_meta_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - -
-
- -
client.filestorage.files.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `FileStorageFile` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.files.meta_post_retrieve() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
@@ -14459,8 +14294,8 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -14472,7 +14307,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a list of `CustomObjectClass` objects.
@@ -14490,15 +14325,12 @@ Returns a list of `Folder` objects. import datetime from merge import Merge -from merge.resources.filestorage.resources.folders import ( - FoldersListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list( +client.crm.custom_object_classes.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -14506,8 +14338,6 @@ client.filestorage.folders.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - drive_id="drive_id", - expand=FoldersListRequestExpand.DRIVE, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -14517,9 +14347,7 @@ client.filestorage.folders.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", page_size=1, - parent_folder_id="parent_folder_id", remote_id="remote_id", ) @@ -14561,7 +14389,7 @@ client.filestorage.folders.list(
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14569,7 +14397,7 @@ 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. +**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/).
@@ -14577,7 +14405,7 @@ client.filestorage.folders.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.
@@ -14585,15 +14413,7 @@ client.filestorage.folders.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). +**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).
@@ -14617,14 +14437,6 @@ client.filestorage.folders.list(
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14633,14 +14445,6 @@ 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. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -14661,7 +14465,7 @@ client.filestorage.folders.list(
-
client.filestorage.folders.create(...) +
client.crm.custom_object_classes.retrieve(...)
@@ -14673,7 +14477,7 @@ client.filestorage.folders.list(
-Creates a `Folder` object with the given values. +Returns a `CustomObjectClass` object with the given `id`.
@@ -14689,16 +14493,15 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - is_debug_mode=True, - run_async=True, - model=FolderRequest(), +client.crm.custom_object_classes.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -14715,7 +14518,7 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**id:** `str`
@@ -14723,7 +14526,7 @@ client.filestorage.folders.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14731,7 +14534,15 @@ client.filestorage.folders.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -14751,7 +14562,8 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -14763,7 +14575,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns a list of `AssociationType` objects.
@@ -14778,20 +14590,34 @@ Returns a `Folder` object with the given `id`.
```python +import datetime + from merge import Merge -from merge.resources.filestorage.resources.folders import ( - FoldersRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( - id="id", - expand=FoldersRetrieveRequestExpand.DRIVE, +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -14808,7 +14634,7 @@ client.filestorage.folders.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -14816,7 +14642,7 @@ 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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -14824,7 +14650,7 @@ client.filestorage.folders.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.
@@ -14832,7 +14658,7 @@ client.filestorage.folders.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.
@@ -14840,64 +14666,67 @@ client.filestorage.folders.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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_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.filestorage.folders.meta_post_retrieve()
-#### 📝 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 metadata for `FileStorageFolder` POSTs. -
-
+**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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.folders.meta_post_retrieve() - -``` -
-
+**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. + +
+
+
@@ -14913,8 +14742,7 @@ client.filestorage.folders.meta_post_retrieve()
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -14926,7 +14754,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +Creates an `AssociationType` object with the given values.
@@ -14942,13 +14770,33 @@ Create a remote key. ```python from merge import Merge +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", +client.crm.association_types.custom_object_classes_association_types_create( + custom_object_class_id="custom_object_class_id", + is_debug_mode=True, + run_async=True, + 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", + ), ) ``` @@ -14965,7 +14813,31 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `AssociationTypeRequestRequest` + +
+
+ +
+
+ +**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.
@@ -14985,8 +14857,7 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -14998,7 +14869,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns an `AssociationType` object with the given `id`.
@@ -15013,33 +14884,17 @@ Returns a list of `Group` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -15056,7 +14911,7 @@ client.filestorage.groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**custom_object_class_id:** `str`
@@ -15064,7 +14919,7 @@ client.filestorage.groups.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**id:** `str`
@@ -15072,7 +14927,7 @@ client.filestorage.groups.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -15080,7 +14935,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15088,7 +14943,7 @@ client.filestorage.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_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).
@@ -15096,79 +14951,31 @@ client.filestorage.groups.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_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.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-**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. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -
client.filestorage.groups.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Group` object with the given `id`. +Returns metadata for `CRMAssociationType` POSTs.
@@ -15189,10 +14996,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", ) ``` @@ -15209,31 +15014,7 @@ client.filestorage.groups.retrieve(
-**id:** `str` - -
-
- -
-
- -**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. - -
-
- -
-
- -**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). +**custom_object_class_id:** `str`
@@ -15253,8 +15034,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -15266,7 +15047,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `CustomObject` objects.
@@ -15284,35 +15065,32 @@ Gets all issues for Organization. import datetime from merge import Merge -from merge.resources.filestorage.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", + created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - first_incident_time_before=datetime.datetime.fromisoformat( + created_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - last_incident_time_before=datetime.datetime.fromisoformat( + modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - linked_account_id="linked_account_id", page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, + remote_id="remote_id", ) ``` @@ -15329,15 +15107,7 @@ client.filestorage.issues.list(
-**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**custom_object_class_id:** `str`
@@ -15345,7 +15115,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_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15353,7 +15123,7 @@ client.filestorage.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -15361,7 +15131,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15369,7 +15139,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/).
@@ -15377,7 +15147,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.
@@ -15385,7 +15155,7 @@ client.filestorage.issues.list(
-**integration_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.
@@ -15393,7 +15163,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. +**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).
@@ -15401,7 +15171,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_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15409,7 +15179,7 @@ client.filestorage.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -15425,20 +15195,7 @@ client.filestorage.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15458,7 +15215,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
@@ -15470,7 +15227,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Creates a `CustomObject` object with the given values.
@@ -15486,13 +15243,19 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + is_debug_mode=True, + run_async=True, + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), ) ``` @@ -15509,7 +15272,31 @@ client.filestorage.issues.retrieve(
-**id:** `str` +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `CustomObjectRequest` + +
+
+ +
+
+ +**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.
@@ -15529,8 +15316,7 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken -
client.filestorage.link_token.create(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -15542,7 +15328,7 @@ client.filestorage.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a `CustomObject` object with the given `id`.
@@ -15558,17 +15344,17 @@ Creates a link token to be used when linking a new end user. ```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], +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -15585,7 +15371,7 @@ client.filestorage.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. +**custom_object_class_id:** `str`
@@ -15593,7 +15379,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**id:** `str`
@@ -15601,7 +15387,7 @@ 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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15609,7 +15395,7 @@ client.filestorage.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**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.
@@ -15617,7 +15403,7 @@ client.filestorage.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15625,75 +15411,70 @@ client.filestorage.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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
-**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. - -
-
+#### 📝 Description
-**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. - +Returns metadata for `CRMCustomObject` POSTs. +
+
+#### 🔌 Usage +
-**language:** `typing.Optional[LanguageEnum]` +
+
-The following subset of IETF language tags can be used to configure localization. +```python +from merge import Merge -* `en` - en -* `de` - de - +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", +) + +```
+
+
+ +#### ⚙️ 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. +**custom_object_class_id:** `str`
@@ -15713,8 +15494,7 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
@@ -15726,7 +15506,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `RemoteFieldClass` objects.
@@ -15742,28 +15522,20 @@ List linked accounts for your organization. ```python from merge import Merge -from merge.resources.filestorage.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, page_size=1, - status="status", ) ``` @@ -15780,24 +15552,6 @@ 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 - -
-
- -
-
- **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15806,31 +15560,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. - -
-
- -
-
- -**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. +**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/).
@@ -15838,7 +15568,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15846,7 +15576,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_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -15854,7 +15584,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).
@@ -15862,7 +15592,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. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -15870,7 +15600,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. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -15886,14 +15616,6 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -15906,8 +15628,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -15919,7 +15641,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Returns a list of `Association` objects.
@@ -15934,18 +15656,36 @@ Pull data from an endpoint not currently supported by Merge.
```python +import datetime + 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.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", + association_type_id="association_type_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", ), + page_size=1, + remote_id="remote_id", ) ``` @@ -15962,7 +15702,7 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**custom_object_class_id:** `str`
@@ -15970,71 +15710,103 @@ client.filestorage.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...)
-#### 📝 Description +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+
-Exchange remote keys. +**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/). +
-#### 🔌 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 +**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 = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) +
+
-``` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**name:** `str` — The name of the remote key +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16054,8 +15826,7 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -16067,7 +15838,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). +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -16088,9 +15859,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.crm.associations.custom_object_classes_custom_objects_associations_update( + source_class_id="source_class_id", + source_object_id="source_object_id", + target_class_id="target_class_id", + target_object_id="target_object_id", + association_type_id="association_type_id", + is_debug_mode=True, + run_async=True, ) ``` @@ -16107,7 +15883,7 @@ client.filestorage.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**source_class_id:** `str`
@@ -16115,7 +15891,7 @@ client.filestorage.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**source_object_id:** `str`
@@ -16123,65 +15899,43 @@ client.filestorage.sync_status.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**target_class_id:** `str`
- -
+
+
+**target_object_id:** `str` +
-
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create()
-#### 📝 Description - -
-
+**association_type_id:** `str` + +
+
-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_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.force_resync.sync_status_resync_create() - -``` -
-
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
-#### ⚙️ Parameters - -
-
-
@@ -16197,8 +15951,8 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -16210,7 +15964,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` 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).
@@ -16225,35 +15979,13 @@ Returns a list of `User` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - is_me="is_me", - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", -) +client.crm.scopes.default_scopes_retrieve() ```
@@ -16269,91 +16001,64 @@ client.filestorage.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.crm.scopes.linked_account_scopes_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). - +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).
- -
-
- -**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. -
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.scopes.linked_account_scopes_retrieve() -**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. - -
-
-
@@ -16369,7 +16074,7 @@ client.filestorage.users.list(
-
client.filestorage.users.retrieve(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -16381,7 +16086,7 @@ client.filestorage.users.list(
-Returns a `User` object with the given `id`. +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)
@@ -16397,15 +16102,42 @@ Returns a `User` object with the given `id`. ```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.filestorage.users.retrieve( - id="id", - include_remote_data=True, - include_shell_data=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, + ) + }, + ), + ], ) ``` @@ -16422,23 +16154,7 @@ client.filestorage.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -16458,8 +16174,8 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +## Crm DeleteAccount +
client.crm.delete_account.delete()
@@ -16471,7 +16187,7 @@ client.filestorage.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Delete a linked account.
@@ -16492,7 +16208,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.crm.delete_account.delete() ``` @@ -16520,7 +16236,8 @@ client.filestorage.webhook_receivers.list()
-
client.filestorage.webhook_receivers.create(...) +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -16532,7 +16249,7 @@ client.filestorage.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `EngagementType` objects.
@@ -16547,15 +16264,34 @@ Creates a `WebhookReceiver` object with the given values.
```python +import datetime + 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, +client.crm.engagement_types.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -16572,7 +16308,7 @@ client.filestorage.webhook_receivers.create(
-**event:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16580,7 +16316,7 @@ client.filestorage.webhook_receivers.create(
-**is_active:** `bool` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -16588,7 +16324,7 @@ client.filestorage.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16596,39 +16332,102 @@ client.filestorage.webhook_receivers.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. +
-
-## Crm AccountDetails -
client.crm.account_details.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. + +
+
-Get details for 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 - +
+
+ +**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. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ + + + + + +
+ +
client.crm.engagement_types.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns an `EngagementType` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage +
@@ -16642,7 +16441,12 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.crm.engagement_types.retrieve( + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) ```
@@ -16658,6 +16462,38 @@ client.crm.account_details.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_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.
@@ -16670,8 +16506,7 @@ client.crm.account_details.retrieve()
-## Crm AccountToken -
client.crm.account_token.retrieve(...) +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -16683,7 +16518,7 @@ client.crm.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a list of `RemoteFieldClass` objects.
@@ -16704,8 +16539,15 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_token.retrieve( - public_token="public_token", +client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, ) ``` @@ -16722,7 +16564,63 @@ client.crm.account_token.retrieve(
-**public_token:** `str` +**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 + +
+
+ +
+
+ +**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.
@@ -16742,8 +16640,8 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +## Crm Engagements +
client.crm.engagements.list(...)
@@ -16755,7 +16653,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `Engagement` objects.
@@ -16773,12 +16671,15 @@ Returns a list of `Account` objects. import datetime from merge import Merge +from merge.resources.crm.resources.engagements import ( + EngagementsListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list( +client.crm.engagements.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -16786,6 +16687,7 @@ client.crm.accounts.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=EngagementsListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, include_remote_fields=True, @@ -16796,10 +16698,14 @@ client.crm.accounts.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", - owner_id="owner_id", page_size=1, remote_id="remote_id", + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -16840,7 +16746,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. +**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16896,7 +16802,7 @@ client.crm.accounts.list(
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16904,7 +16810,7 @@ client.crm.accounts.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16912,7 +16818,7 @@ client.crm.accounts.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
@@ -16920,7 +16826,7 @@ client.crm.accounts.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -16940,7 +16846,7 @@ client.crm.accounts.list(
-
client.crm.accounts.create(...) +
client.crm.engagements.create(...)
@@ -16952,7 +16858,7 @@ client.crm.accounts.list(
-Creates an `Account` object with the given values. +Creates an `Engagement` object with the given values.
@@ -16968,16 +16874,16 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest +from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( +client.crm.engagements.create( is_debug_mode=True, run_async=True, - model=AccountRequest(), + model=EngagementRequest(), ) ``` @@ -16994,7 +16900,7 @@ client.crm.accounts.create(
-**model:** `AccountRequest` +**model:** `EngagementRequest`
@@ -17030,7 +16936,7 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +
client.crm.engagements.retrieve(...)
@@ -17042,7 +16948,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Returns an `Engagement` object with the given `id`.
@@ -17058,13 +16964,17 @@ Returns an `Account` object with the given `id`. ```python from merge import Merge +from merge.resources.crm.resources.engagements import ( + EngagementsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( +client.crm.engagements.retrieve( id="id", + expand=EngagementsRetrieveRequestExpand.ACCOUNT, include_remote_data=True, include_remote_fields=True, include_shell_data=True, @@ -17092,7 +17002,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. +**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17136,7 +17046,7 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +
client.crm.engagements.partial_update(...)
@@ -17148,7 +17058,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +Updates an `Engagement` object with the given `id`.
@@ -17164,17 +17074,17 @@ Updates an `Account` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedAccountRequest +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.partial_update( +client.crm.engagements.partial_update( id="id", is_debug_mode=True, run_async=True, - model=PatchedAccountRequest(), + model=PatchedEngagementRequest(), ) ``` @@ -17199,7 +17109,7 @@ client.crm.accounts.partial_update(
-**model:** `PatchedAccountRequest` +**model:** `PatchedEngagementRequest`
@@ -17235,7 +17145,7 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +
client.crm.engagements.meta_patch_retrieve(...)
@@ -17247,7 +17157,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +Returns metadata for `Engagement` PATCHs.
@@ -17268,7 +17178,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( +client.crm.engagements.meta_patch_retrieve( id="id", ) @@ -17306,7 +17216,7 @@ client.crm.accounts.meta_patch_retrieve(
-
client.crm.accounts.meta_post_retrieve() +
client.crm.engagements.meta_post_retrieve()
@@ -17318,7 +17228,7 @@ client.crm.accounts.meta_patch_retrieve(
-Returns metadata for `CRMAccount` POSTs. +Returns metadata for `Engagement` POSTs.
@@ -17339,7 +17249,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_post_retrieve() +client.crm.engagements.meta_post_retrieve() ``` @@ -17367,7 +17277,7 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -17400,7 +17310,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list( +client.crm.engagements.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, @@ -17501,8 +17411,8 @@ client.crm.accounts.remote_field_classes_list(
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...)
@@ -17514,7 +17424,7 @@ client.crm.accounts.remote_field_classes_list(
-Asynchronously pull data from an endpoint not currently supported by Merge. +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/).
@@ -17530,17 +17440,13 @@ Asynchronously 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.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -17557,7 +17463,7 @@ client.crm.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -17577,7 +17483,7 @@ client.crm.async_passthrough.create(
-
client.crm.async_passthrough.retrieve(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -17589,7 +17495,7 @@ client.crm.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +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.
@@ -17610,8 +17516,14 @@ 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", +client.crm.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -17628,84 +17540,15 @@ client.crm.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
- -
- - - - -
- -## Crm AuditTrail -
client.crm.audit_trail.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Gets a list of audit trail events. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", - page_size=1, - start_date="start_date", - user_email="user_email", -) - -``` -
-
-
-
- -#### ⚙️ Parameters
-
-
- -**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.
@@ -17713,7 +17556,7 @@ client.crm.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**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.
@@ -17721,7 +17564,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` +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -17729,7 +17572,7 @@ client.crm.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -17737,7 +17580,7 @@ client.crm.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -17745,7 +17588,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. +**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.
@@ -17765,8 +17608,7 @@ client.crm.audit_trail.list(
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -17778,7 +17620,7 @@ client.crm.audit_trail.list(
-Returns a list of models and actions available for an account. +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.
@@ -17799,7 +17641,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -17815,6 +17659,14 @@ client.crm.available_actions.retrieve()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17827,8 +17679,7 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +
client.crm.field_mapping.field_mappings_partial_update(...)
@@ -17840,7 +17691,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -17855,39 +17706,14 @@ Returns a list of `Contact` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.contacts import ContactsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list( - account_id="account_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_addresses="email_addresses", - expand=ContactsListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - phone_numbers="phone_numbers", - remote_id="remote_id", +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -17904,7 +17730,7 @@ client.crm.contacts.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. +**field_mapping_id:** `str`
@@ -17912,7 +17738,7 @@ client.crm.contacts.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**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.
@@ -17920,7 +17746,7 @@ client.crm.contacts.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -17928,7 +17754,7 @@ client.crm.contacts.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -17936,79 +17762,71 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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/). -
+
+
client.crm.field_mapping.remote_fields_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_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). - +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 +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -18016,7 +17834,7 @@ client.crm.contacts.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**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.
@@ -18036,7 +17854,7 @@ client.crm.contacts.list(
-
client.crm.contacts.create(...) +
client.crm.field_mapping.target_fields_retrieve()
@@ -18048,7 +17866,7 @@ client.crm.contacts.list(
-Creates a `Contact` object with the given values. +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/).
@@ -18064,17 +17882,12 @@ 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( - is_debug_mode=True, - run_async=True, - model=ContactRequest(), -) +client.crm.field_mapping.target_fields_retrieve() ``` @@ -18090,31 +17903,7 @@ client.crm.contacts.create(
-**model:** `ContactRequest` - -
-
- -
-
- -**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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18126,7 +17915,8 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +## Crm GenerateKey +
client.crm.generate_key.create(...)
@@ -18138,7 +17928,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Create a remote key.
@@ -18154,18 +17944,13 @@ Returns a `Contact` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", - expand=ContactsRetrieveRequestExpand.ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.crm.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -18182,39 +17967,7 @@ client.crm.contacts.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — 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). +**name:** `str` — The name of the remote key
@@ -18234,7 +17987,8 @@ client.crm.contacts.retrieve(
-
client.crm.contacts.partial_update(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -18246,7 +18000,7 @@ client.crm.contacts.retrieve(
-Updates a `Contact` object with the given `id`. +Gets all issues for Organization.
@@ -18261,18 +18015,38 @@ Updates a `Contact` object with the given `id`.
```python +import datetime + from merge import Merge -from merge.resources.crm import PatchedContactRequest +from merge.resources.crm.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.partial_update( - id="id", - is_debug_mode=True, - run_async=True, - model=PatchedContactRequest(), +client.crm.issues.list( + account_token="account_token", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + first_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + last_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + linked_account_id="linked_account_id", + page_size=1, + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -18289,7 +18063,7 @@ client.crm.contacts.partial_update(
-**id:** `str` +**account_token:** `typing.Optional[str]`
@@ -18297,7 +18071,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18305,7 +18079,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. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -18313,7 +18087,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_user_organization_name:** `typing.Optional[str]`
@@ -18321,74 +18095,71 @@ client.crm.contacts.partial_update(
-**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.
-
-
+
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +
-
-
client.crm.contacts.ignore_create(...)
-#### 📝 Description +**include_muted:** `typing.Optional[str]` — If true, will include muted issues + +
+
+**integration_name:** `typing.Optional[str]` + +
+
+
-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. -
-
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. + -#### 🔌 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 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, - ), -) - -``` -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**model_id:** `str` +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -18396,7 +18167,12 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -18416,7 +18192,7 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +
client.crm.issues.retrieve(...)
@@ -18428,7 +18204,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Get a specific issue.
@@ -18449,7 +18225,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( +client.crm.issues.retrieve( id="id", ) @@ -18487,7 +18263,8 @@ client.crm.contacts.meta_patch_retrieve(
-
client.crm.contacts.meta_post_retrieve() +## Crm Leads +
client.crm.leads.list(...)
@@ -18499,7 +18276,7 @@ client.crm.contacts.meta_patch_retrieve(
-Returns metadata for `CRMContact` POSTs. +Returns a list of `Lead` objects.
@@ -18514,13 +18291,42 @@ Returns metadata for `CRMContact` POSTs.
```python +import datetime + from merge import Merge +from merge.resources.crm.resources.leads import LeadsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_post_retrieve() +client.crm.leads.list( + converted_account_id="converted_account_id", + converted_contact_id="converted_contact_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email_addresses="email_addresses", + expand=LeadsListRequestExpand.CONVERTED_ACCOUNT, + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + owner_id="owner_id", + page_size=1, + phone_numbers="phone_numbers", + remote_id="remote_id", +) ```
@@ -18536,77 +18342,79 @@ client.crm.contacts.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.contacts.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### 🔌 Usage -
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+
-```python -from merge import Merge +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, -) +
+
-``` +**expand:** `typing.Optional[LeadsListRequestExpand]` — 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/). +
-#### ⚙️ 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_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.
@@ -18614,7 +18422,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/). +**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).
@@ -18622,7 +18430,7 @@ 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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -18630,7 +18438,7 @@ client.crm.contacts.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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -18638,7 +18446,7 @@ client.crm.contacts.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). +**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
@@ -18646,7 +18454,7 @@ client.crm.contacts.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 +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18654,7 +18462,7 @@ client.crm.contacts.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -18662,7 +18470,7 @@ client.crm.contacts.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.
@@ -18682,8 +18490,7 @@ client.crm.contacts.remote_field_classes_list(
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +
client.crm.leads.create(...)
@@ -18695,7 +18502,7 @@ client.crm.contacts.remote_field_classes_list(
-Returns a list of `CustomObjectClass` objects. +Creates a `Lead` object with the given values.
@@ -18710,33 +18517,17 @@ Returns a list of `CustomObjectClass` objects.
```python -import datetime - from merge import Merge +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", +client.crm.leads.create( + is_debug_mode=True, + run_async=True, + model=LeadRequest(), ) ``` @@ -18753,7 +18544,7 @@ client.crm.custom_object_classes.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**model:** `LeadRequest`
@@ -18761,7 +18552,7 @@ client.crm.custom_object_classes.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18769,7 +18560,7 @@ client.crm.custom_object_classes.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18777,31 +18568,75 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+
client.crm.leads.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 + +
+
+ +
+
+ +Returns a `Lead` object with the given `id`.
+
+
+ +#### 🔌 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 +from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.leads.retrieve( + id="id", + expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) + +``` +
+
+#### ⚙️ 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). +
+
+ +**id:** `str`
@@ -18809,7 +18644,7 @@ client.crm.custom_object_classes.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18817,7 +18652,7 @@ client.crm.custom_object_classes.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.
@@ -18825,7 +18660,7 @@ client.crm.custom_object_classes.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.
@@ -18833,7 +18668,7 @@ client.crm.custom_object_classes.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).
@@ -18853,7 +18688,7 @@ client.crm.custom_object_classes.list(
-
client.crm.custom_object_classes.retrieve(...) +
client.crm.leads.meta_post_retrieve()
@@ -18865,7 +18700,7 @@ client.crm.custom_object_classes.list(
-Returns a `CustomObjectClass` object with the given `id`. +Returns metadata for `Lead` POSTs.
@@ -18886,11 +18721,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) +client.crm.leads.meta_post_retrieve() ``` @@ -18906,38 +18737,6 @@ client.crm.custom_object_classes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["fields"]]` — 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.
@@ -18950,8 +18749,7 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +
client.crm.leads.remote_field_classes_list(...)
@@ -18963,7 +18761,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -18978,34 +18776,21 @@ Returns a list of `AssociationType` objects.
```python -import datetime - from merge import Merge 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", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.crm.leads.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + is_common_model_field=True, + is_custom=True, page_size=1, - remote_id="remote_id", ) ``` @@ -19022,7 +18807,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19030,7 +18815,7 @@ client.crm.association_types.custom_object_classes_association_types_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/).
@@ -19038,7 +18823,7 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -19046,7 +18831,7 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -19054,7 +18839,7 @@ 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. +**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).
@@ -19062,7 +18847,7 @@ client.crm.association_types.custom_object_classes_association_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/). +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -19070,7 +18855,7 @@ client.crm.association_types.custom_object_classes_association_types_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
@@ -19078,7 +18863,7 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -19086,122 +18871,154 @@ client.crm.association_types.custom_object_classes_association_types_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 LinkToken +
client.crm.link_token.create(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+#### 📝 Description
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +
+
+ +Creates a link token to be used when linking a new end user. +
+
+#### 🔌 Usage +
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - +
+
+ +```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], +) + +```
+#### ⚙️ Parameters - - -
+
+
-
client.crm.association_types.custom_object_classes_association_types_create(...)
-#### 📝 Description +**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. + +
+
+
-Creates an `AssociationType` object with the given values. +**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. +
-#### 🔌 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 -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) +**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 = 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", - is_debug_mode=True, - run_async=True, - 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", - ), -) +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**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. + +
+
+
-**custom_object_class_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.
@@ -19209,7 +19026,12 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**model:** `AssociationTypeRequestRequest` +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -19217,7 +19039,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**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.
@@ -19225,7 +19047,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**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.
@@ -19245,7 +19067,8 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -19257,7 +19080,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +List linked accounts for your organization.
@@ -19273,16 +19096,28 @@ Returns an `AssociationType` object with the given `id`. ```python from merge import Merge +from merge.resources.crm.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) 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.crm.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", id="id", - include_remote_data=True, - include_shell_data=True, + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", ) ``` @@ -19299,7 +19134,17 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_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
@@ -19307,7 +19152,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19315,7 +19160,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. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -19323,7 +19168,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. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -19331,7 +19176,7 @@ 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). +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -19339,70 +19184,63 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**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]` +
-
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-#### 📝 Description - -
-
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
-Returns metadata for `CRMAssociationType` POSTs. -
-
+**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. +
-#### 🔌 Usage -
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
+
-```python -from merge import Merge - -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", -) - -``` -
-
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**custom_object_class_id:** `str` +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -19422,8 +19260,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(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -19435,7 +19273,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Returns a list of `Note` objects.
@@ -19453,13 +19291,15 @@ Returns a list of `CustomObject` objects. import datetime from merge import Merge +from merge.resources.crm.resources.notes import NotesListRequestExpand 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.crm.notes.list( + account_id="account_id", + contact_id="contact_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -19467,6 +19307,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=NotesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, include_remote_fields=True, @@ -19477,6 +19318,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + opportunity_id="opportunity_id", + owner_id="owner_id", page_size=1, remote_id="remote_id", ) @@ -19495,7 +19338,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -19503,7 +19346,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
@@ -19511,7 +19354,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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.
@@ -19519,7 +19362,23 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19575,6 +19434,22 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. + +
+
+ +
+
+ +**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.
@@ -19603,7 +19478,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +
client.crm.notes.create(...)
@@ -19615,7 +19490,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Creates a `Note` object with the given values.
@@ -19631,19 +19506,16 @@ Creates a `CustomObject` object with the given values. ```python from merge import Merge -from merge.resources.crm import CustomObjectRequest +from merge.resources.crm import NoteRequest 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", +client.crm.notes.create( is_debug_mode=True, run_async=True, - model=CustomObjectRequest( - fields={"test_field": "hello"}, - ), + model=NoteRequest(), ) ``` @@ -19660,15 +19532,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `CustomObjectRequest` +**model:** `NoteRequest`
@@ -19704,7 +19568,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +
client.crm.notes.retrieve(...)
@@ -19716,7 +19580,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-Returns a `CustomObject` object with the given `id`. +Returns a `Note` object with the given `id`.
@@ -19732,14 +19596,15 @@ Returns a `CustomObject` object with the given `id`. ```python from merge import Merge +from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand 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.crm.notes.retrieve( id="id", + expand=NotesRetrieveRequestExpand.ACCOUNT, include_remote_data=True, include_remote_fields=True, include_shell_data=True, @@ -19759,7 +19624,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -19767,7 +19632,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**id:** `str` +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19811,7 +19676,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +
client.crm.notes.meta_post_retrieve()
@@ -19823,7 +19688,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Returns metadata for `Note` POSTs.
@@ -19844,9 +19709,7 @@ 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.crm.notes.meta_post_retrieve() ``` @@ -19862,14 +19725,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19882,7 +19737,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -19915,7 +19770,7 @@ 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( +client.crm.notes.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, @@ -20016,8 +19871,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -20029,7 +19884,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +Returns a list of `Opportunity` objects.
@@ -20047,15 +19902,17 @@ Returns a list of `Association` objects. import datetime from merge import Merge +from merge.resources.crm.resources.opportunities import ( + OpportunitiesListRequestExpand, + OpportunitiesListRequestStatus, +) 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", - association_type_id="association_type_id", +client.crm.opportunities.list( + account_id="account_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -20063,8 +19920,10 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=OpportunitiesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", @@ -20072,8 +19931,14 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + owner_id="owner_id", page_size=1, + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), remote_id="remote_id", + stage_id="stage_id", + status=OpportunitiesListRequestStatus.LOST, ) ``` @@ -20090,7 +19955,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
@@ -20098,7 +19963,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**object_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20106,7 +19971,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -20114,7 +19979,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20122,7 +19987,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20130,7 +19995,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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/).
@@ -20138,7 +20003,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20146,7 +20011,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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.
@@ -20154,7 +20019,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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).
@@ -20162,7 +20027,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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.
@@ -20170,7 +20035,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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.
@@ -20178,7 +20043,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
@@ -20194,6 +20059,22 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
+**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.
@@ -20202,6 +20083,36 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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) + +
+
+ +
+
+ +**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 + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20214,7 +20125,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +
client.crm.opportunities.create(...)
@@ -20226,7 +20137,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`. +Creates an `Opportunity` object with the given values.
@@ -20242,19 +20153,16 @@ Creates an Association between `source_object_id` and `target_object_id` of type ```python from merge import Merge +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_update( - source_class_id="source_class_id", - source_object_id="source_object_id", - target_class_id="target_class_id", - target_object_id="target_object_id", - association_type_id="association_type_id", +client.crm.opportunities.create( is_debug_mode=True, run_async=True, + model=OpportunityRequest(), ) ``` @@ -20271,39 +20179,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_class_id:** `str` - -
-
- -
-
- -**source_object_id:** `str` - -
-
- -
-
- -**target_class_id:** `str` - -
-
- -
-
- -**target_object_id:** `str` - -
-
- -
-
- -**association_type_id:** `str` +**model:** `OpportunityRequest`
@@ -20339,8 +20215,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +
client.crm.opportunities.retrieve(...)
@@ -20352,7 +20227,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 an `Opportunity` object with the given `id`.
@@ -20368,12 +20243,21 @@ Get the default permissions for Merge Common Models and fields across all Linked ```python from merge import Merge +from merge.resources.crm.resources.opportunities import ( + OpportunitiesRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.crm.opportunities.retrieve( + id="id", + expand=OpportunitiesRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) ``` @@ -20389,19 +20273,75 @@ client.crm.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.crm.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. + +
+
+ +
+
+ +**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). + +
+
+ +
+
+ +**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. + +
+
+ + + + + + +
+ +
client.crm.opportunities.partial_update(...)
@@ -20413,7 +20353,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). +Updates an `Opportunity` object with the given `id`.
@@ -20429,12 +20369,18 @@ Get all available permissions for Merge Common Models and fields for a single Li ```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.scopes.linked_account_scopes_retrieve() +client.crm.opportunities.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedOpportunityRequest(), +) ``` @@ -20450,6 +20396,38 @@ client.crm.scopes.linked_account_scopes_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedOpportunityRequest` + +
+
+ +
+
+ +**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.
@@ -20462,7 +20440,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +
client.crm.opportunities.meta_patch_retrieve(...)
@@ -20474,7 +20452,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) +Returns metadata for `Opportunity` PATCHs.
@@ -20490,42 +20468,13 @@ 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.crm.opportunities.meta_patch_retrieve( + id="id", ) ``` @@ -20542,7 +20491,7 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**id:** `str`
@@ -20562,8 +20511,7 @@ client.crm.scopes.linked_account_scopes_create(
-## Crm DeleteAccount -
client.crm.delete_account.delete() +
client.crm.opportunities.meta_post_retrieve()
@@ -20575,7 +20523,7 @@ client.crm.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns metadata for `Opportunity` POSTs.
@@ -20596,7 +20544,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.delete_account.delete() +client.crm.opportunities.meta_post_retrieve() ``` @@ -20624,8 +20572,7 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +
client.crm.opportunities.remote_field_classes_list(...)
@@ -20637,7 +20584,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -20652,34 +20599,21 @@ Returns a list of `EngagementType` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.crm.opportunities.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + is_common_model_field=True, + is_custom=True, page_size=1, - remote_id="remote_id", ) ``` @@ -20696,22 +20630,6 @@ client.crm.engagement_types.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.
@@ -20752,7 +20670,7 @@ client.crm.engagement_types.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after 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
@@ -20760,7 +20678,7 @@ client.crm.engagement_types.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -20776,14 +20694,6 @@ client.crm.engagement_types.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20796,7 +20706,8 @@ client.crm.engagement_types.list(
-
client.crm.engagement_types.retrieve(...) +## Crm Passthrough +
client.crm.passthrough.create(...)
@@ -20808,7 +20719,7 @@ client.crm.engagement_types.list(
-Returns an `EngagementType` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -20824,16 +20735,17 @@ Returns an `EngagementType` 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.crm.engagement_types.retrieve( - id="id", - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -20850,31 +20762,7 @@ client.crm.engagement_types.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_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:** `DataPassthroughRequest`
@@ -20894,7 +20782,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -20906,7 +20795,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Exchange remote keys.
@@ -20927,15 +20816,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, +client.crm.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -20952,63 +20834,7 @@ client.crm.engagement_types.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 - -
-
- -
-
- -**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. +**name:** `str` — The name of the remote key
@@ -21028,8 +20854,8 @@ client.crm.engagement_types.remote_field_classes_list(
-## Crm Engagements -
client.crm.engagements.list(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -21041,7 +20867,7 @@ client.crm.engagement_types.remote_field_classes_list(
-Returns a list of `Engagement` objects. +Returns a list of `Stage` objects.
@@ -21059,15 +20885,12 @@ Returns a list of `Engagement` objects. import datetime from merge import Merge -from merge.resources.crm.resources.engagements import ( - EngagementsListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list( +client.crm.stages.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -21075,7 +20898,6 @@ client.crm.engagements.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=EngagementsListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, include_remote_fields=True, @@ -21088,12 +20910,6 @@ client.crm.engagements.list( ), page_size=1, remote_id="remote_id", - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), ) ``` @@ -21134,14 +20950,6 @@ 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. - -
-
- -
-
- **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/).
@@ -21206,22 +21014,6 @@ client.crm.engagements.list(
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. - -
-
- -
-
- -**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21234,7 +21026,7 @@ client.crm.engagements.list(
-
client.crm.engagements.create(...) +
client.crm.stages.retrieve(...)
@@ -21246,7 +21038,7 @@ client.crm.engagements.list(
-Creates an `Engagement` object with the given values. +Returns a `Stage` object with the given `id`.
@@ -21262,16 +21054,16 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( - is_debug_mode=True, - run_async=True, - model=EngagementRequest(), +client.crm.stages.retrieve( + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -21288,7 +21080,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**id:** `str`
@@ -21296,7 +21088,7 @@ client.crm.engagements.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.
@@ -21304,7 +21096,15 @@ client.crm.engagements.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -21324,7 +21124,7 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -21336,7 +21136,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -21352,20 +21152,20 @@ Returns an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.engagements import ( - EngagementsRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.retrieve( - id="id", - expand=EngagementsRetrieveRequestExpand.ACCOUNT, +client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, include_remote_data=True, include_remote_fields=True, include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, ) ``` @@ -21382,7 +21182,7 @@ client.crm.engagements.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21390,7 +21190,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. +**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/).
@@ -21422,6 +21222,30 @@ client.crm.engagements.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.
@@ -21434,7 +21258,8 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -21446,7 +21271,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` 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).
@@ -21462,17 +21287,14 @@ 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", - is_debug_mode=True, - run_async=True, - model=PatchedEngagementRequest(), +client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, ) ``` @@ -21489,23 +21311,7 @@ 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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21513,7 +21319,7 @@ client.crm.engagements.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21533,7 +21339,8 @@ client.crm.engagements.partial_update(
-
client.crm.engagements.meta_patch_retrieve(...) +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create()
@@ -21545,7 +21352,7 @@ client.crm.engagements.partial_update(
-Returns metadata for `Engagement` PATCHs. +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.
@@ -21566,9 +21373,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_patch_retrieve( - id="id", -) +client.crm.force_resync.sync_status_resync_create() ``` @@ -21584,14 +21389,6 @@ client.crm.engagements.meta_patch_retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21604,7 +21401,8 @@ client.crm.engagements.meta_patch_retrieve(
-
client.crm.engagements.meta_post_retrieve() +## Crm Tasks +
client.crm.tasks.list(...)
@@ -21616,7 +21414,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Returns a list of `Task` objects.
@@ -21631,13 +21429,37 @@ Returns metadata for `Engagement` POSTs.
```python +import datetime + from merge import Merge +from merge.resources.crm.resources.tasks import TasksListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.crm.tasks.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=TasksListRequestExpand.ACCOUNT, + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) ```
@@ -21653,77 +21475,31 @@ client.crm.engagements.meta_post_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.
- -
- - - - -
- -
client.crm.engagements.remote_field_classes_list(...) -
-
- -#### 📝 Description - -
-
-Returns a list of `RemoteFieldClass` 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.crm.engagements.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, -) - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21763,7 +21539,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 +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21771,7 +21547,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 +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21787,6 +21563,14 @@ client.crm.engagements.remote_field_classes_list(
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21799,8 +21583,7 @@ client.crm.engagements.remote_field_classes_list(
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...) +
client.crm.tasks.create(...)
@@ -21812,7 +21595,7 @@ client.crm.engagements.remote_field_classes_list(
-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 `Task` object with the given values.
@@ -21828,13 +21611,16 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.crm.tasks.create( + is_debug_mode=True, + run_async=True, + model=TaskRequest(), ) ``` @@ -21851,7 +21637,23 @@ client.crm.field_mapping.field_mappings_retrieve(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**model:** `TaskRequest` + +
+
+ +
+
+ +**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.
@@ -21871,7 +21673,7 @@ client.crm.field_mapping.field_mappings_retrieve(
-
client.crm.field_mapping.field_mappings_create(...) +
client.crm.tasks.retrieve(...)
@@ -21883,7 +21685,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 `Task` object with the given `id`.
@@ -21899,19 +21701,18 @@ Create new Field Mappings that will be available after the next scheduled sync. ```python from merge import Merge +from merge.resources.crm.resources.tasks import TasksRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.crm.tasks.retrieve( + id="id", + expand=TasksRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -21928,23 +21729,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. - -
-
- -
-
- -**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`
@@ -21952,7 +21737,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21960,7 +21745,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.
@@ -21968,7 +21753,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_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.
@@ -21976,7 +21761,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. +**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).
@@ -21996,7 +21781,7 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +
client.crm.tasks.partial_update(...)
@@ -22008,7 +21793,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. +Updates a `Task` object with the given `id`.
@@ -22024,13 +21809,17 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp ```python from merge import Merge +from merge.resources.crm import PatchedTaskRequest 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.crm.tasks.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedTaskRequest(), ) ``` @@ -22047,7 +21836,31 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedTaskRequest` + +
+
+ +
+
+ +**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.
@@ -22067,7 +21880,7 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +
client.crm.tasks.meta_patch_retrieve(...)
@@ -22079,7 +21892,7 @@ client.crm.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 metadata for `Task` PATCHs.
@@ -22100,8 +21913,8 @@ 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", +client.crm.tasks.meta_patch_retrieve( + id="id", ) ``` @@ -22118,31 +21931,7 @@ client.crm.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. +**id:** `str`
@@ -22162,7 +21951,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
client.crm.field_mapping.remote_fields_retrieve(...) +
client.crm.tasks.meta_post_retrieve()
@@ -22174,7 +21963,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 metadata for `Task` POSTs.
@@ -22195,10 +21984,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", -) +client.crm.tasks.meta_post_retrieve() ``` @@ -22214,22 +22000,6 @@ 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. - -
-
- -
-
- -**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22242,7 +22012,7 @@ client.crm.field_mapping.remote_fields_retrieve(
-
client.crm.field_mapping.target_fields_retrieve() +
client.crm.tasks.remote_field_classes_list(...)
@@ -22254,7 +22024,7 @@ client.crm.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 `RemoteFieldClass` objects.
@@ -22275,7 +22045,16 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.target_fields_retrieve() +client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, +) ``` @@ -22291,71 +22070,63 @@ client.crm.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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/). +
-
-## Crm GenerateKey -
client.crm.generate_key.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Create a remote key. -
-
+**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 -
+**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.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**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 + +
+
+
-**name:** `str` — The name of the remote key +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22375,8 +22146,8 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +## Crm Users +
client.crm.users.list(...)
@@ -22388,7 +22159,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Returns a list of `User` objects.
@@ -22406,35 +22177,32 @@ Gets all issues for Organization. import datetime from merge import Merge -from merge.resources.crm.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( +client.crm.users.list( + created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - first_incident_time_before=datetime.datetime.fromisoformat( + created_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email="email", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - last_incident_time_before=datetime.datetime.fromisoformat( + modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - linked_account_id="linked_account_id", page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, + remote_id="remote_id", ) ``` @@ -22451,15 +22219,7 @@ client.crm.issues.list(
-**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22467,7 +22227,7 @@ client.crm.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.
@@ -22475,7 +22235,7 @@ client.crm.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22483,7 +22243,7 @@ client.crm.issues.list(
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**email:** `typing.Optional[str]` — If provided, will only return users with this email.
@@ -22491,7 +22251,7 @@ client.crm.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/).
@@ -22499,7 +22259,7 @@ client.crm.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.
@@ -22507,7 +22267,7 @@ client.crm.issues.list(
-**integration_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.
@@ -22515,7 +22275,7 @@ client.crm.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_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).
@@ -22523,7 +22283,7 @@ client.crm.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_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -22531,7 +22291,7 @@ client.crm.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -22547,20 +22307,7 @@ client.crm.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -22580,7 +22327,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.crm.users.retrieve(...)
@@ -22592,7 +22339,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a `User` object with the given `id`.
@@ -22613,8 +22360,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( +client.crm.users.retrieve( id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -22639,6 +22389,30 @@ client.crm.issues.retrieve(
+**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.
@@ -22651,8 +22425,7 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +
client.crm.users.ignore_create(...)
@@ -22664,7 +22437,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +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.
@@ -22679,41 +22452,18 @@ Returns a list of `Lead` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.leads import LeadsListRequestExpand +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list( - converted_account_id="converted_account_id", - converted_contact_id="converted_contact_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_addresses="email_addresses", - expand=LeadsListRequestExpand.CONVERTED_ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, ), - owner_id="owner_id", - page_size=1, - phone_numbers="phone_numbers", - remote_id="remote_id", ) ``` @@ -22730,7 +22480,7 @@ client.crm.leads.list(
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. +**model_id:** `str`
@@ -22738,7 +22488,7 @@ client.crm.leads.list(
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact. +**request:** `IgnoreCommonModelRequest`
@@ -22746,87 +22496,77 @@ client.crm.leads.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.crm.users.remote_field_classes_list(...)
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - -
-
+#### 📝 Description
-**expand:** `typing.Optional[LeadsListRequestExpand]` — 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/). - +Returns a list of `RemoteFieldClass` objects.
- -
-
- -**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. - -
-
+#### 🔌 Usage
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, +) + +``` + + + + + +#### ⚙️ 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.
@@ -22834,7 +22574,7 @@ client.crm.leads.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +**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/).
@@ -22842,7 +22582,7 @@ client.crm.leads.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.
@@ -22850,7 +22590,7 @@ 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. +**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.
@@ -22858,7 +22598,31 @@ client.crm.leads.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). + +
+
+ +
+
+ +**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.
@@ -22878,7 +22642,8 @@ client.crm.leads.list(
-
client.crm.leads.create(...) +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -22890,7 +22655,7 @@ client.crm.leads.list(
-Creates a `Lead` object with the given values. +Returns a list of `WebhookReceiver` objects.
@@ -22906,17 +22671,12 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - is_debug_mode=True, - run_async=True, - model=LeadRequest(), -) +client.crm.webhook_receivers.list() ``` @@ -22932,30 +22692,6 @@ client.crm.leads.create(
-**model:** `LeadRequest` - -
-
- -
-
- -**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.
@@ -22968,7 +22704,7 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +
client.crm.webhook_receivers.create(...)
@@ -22980,7 +22716,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -22996,18 +22732,14 @@ Returns a `Lead` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( - id="id", - expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.crm.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -23024,23 +22756,7 @@ client.crm.leads.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — 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. +**event:** `str`
@@ -23048,7 +22764,7 @@ 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. +**is_active:** `bool`
@@ -23056,7 +22772,7 @@ client.crm.leads.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). +**key:** `typing.Optional[str]`
@@ -23076,7 +22792,8 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -23088,7 +22805,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +Get details for a linked account.
@@ -23109,7 +22826,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.filestorage.account_details.retrieve() ``` @@ -23137,7 +22854,8 @@ client.crm.leads.meta_post_retrieve()
-
client.crm.leads.remote_field_classes_list(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -23149,7 +22867,7 @@ client.crm.leads.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns the account token for the end user with the provided public token.
@@ -23170,15 +22888,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, +client.filestorage.account_token.retrieve( + public_token="public_token", ) ``` @@ -23195,7 +22906,7 @@ client.crm.leads.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**public_token:** `str`
@@ -23203,55 +22914,75 @@ client.crm.leads.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. -
+
+## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
-**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 - +Asynchronously pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 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.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", + ), +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**request:** `DataPassthroughRequest`
@@ -23271,8 +23002,7 @@ client.crm.leads.remote_field_classes_list(
-## Crm LinkToken -
client.crm.link_token.create(...) +
client.filestorage.async_passthrough.retrieve(...)
@@ -23284,7 +23014,7 @@ client.crm.leads.remote_field_classes_list(
-Creates a link token to be used when linking a new end user. +Retrieves data from earlier async-passthrough POST request
@@ -23300,17 +23030,13 @@ 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.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -23327,7 +23053,7 @@ 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. +**async_passthrough_receipt_id:** `str`
@@ -23335,47 +23061,76 @@ client.crm.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - -
-
+#### 📝 Description
-**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. - +Gets a list of audit trail events. +
+
+#### 🔌 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.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23383,7 +23138,7 @@ client.crm.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. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -23391,7 +23146,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. +**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`
@@ -23399,47 +23154,374 @@ 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. +**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. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of models and actions available for an account. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.available_actions.retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Filestorage Scopes +
client.filestorage.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.filestorage.scopes.default_scopes_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.filestorage.scopes.linked_account_scopes_retrieve() +
+
+ +#### 📝 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 + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.scopes.linked_account_scopes_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+ +
client.filestorage.scopes.linked_account_scopes_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +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 + +
+
+ +
+
+ +```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 + +
+
+ +
+
+ +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Filestorage DeleteAccount +
client.filestorage.delete_account.delete() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a linked account. +
+
+
+
+ +#### 🔌 Usage + +
+
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +```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.filestorage.delete_account.delete() -* `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. - -
-
-
@@ -23455,8 +23537,8 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -23468,7 +23550,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Drive` objects.
@@ -23483,29 +23565,34 @@ List linked accounts for your organization.
```python +import datetime + from merge import Merge -from merge.resources.crm.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, +client.filestorage.drives.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", page_size=1, - status="status", + remote_id="remote_id", ) ``` @@ -23522,17 +23609,15 @@ client.crm.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.
@@ -23548,7 +23633,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. +**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/).
@@ -23556,7 +23641,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23564,7 +23649,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_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).
@@ -23572,7 +23657,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -23580,7 +23665,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -23588,7 +23673,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. +**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -23596,7 +23681,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23604,7 +23689,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23612,15 +23697,72 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+
client.filestorage.drives.retrieve(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +#### 📝 Description + +
+
+ +
+
+ +Returns a `Drive` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.drives.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -23628,7 +23770,15 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**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).
@@ -23648,8 +23798,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -23661,7 +23811,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +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/).
@@ -23676,40 +23826,14 @@ Returns a list of `Note` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.notes import NotesListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list( - account_id="account_id", - contact_id="contact_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=NotesListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - opportunity_id="opportunity_id", - owner_id="owner_id", - page_size=1, - remote_id="remote_id", +client.filestorage.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -23726,7 +23850,7 @@ client.crm.notes.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. +**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.
@@ -23734,71 +23858,76 @@ client.crm.notes.list(
-**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. -
+
+
client.filestorage.field_mapping.field_mappings_create(...)
-**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[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +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 +
-**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.filestorage.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) + +```
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+#### ⚙️ 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. - -
-
-
-**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_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -23806,7 +23935,7 @@ client.crm.notes.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -23814,7 +23943,7 @@ client.crm.notes.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.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -23822,7 +23951,7 @@ client.crm.notes.list(
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -23830,7 +23959,7 @@ client.crm.notes.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -23838,7 +23967,7 @@ client.crm.notes.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -23846,7 +23975,7 @@ client.crm.notes.list(
-**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.
@@ -23866,7 +23995,7 @@ client.crm.notes.list(
-
client.crm.notes.create(...) +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -23878,7 +24007,7 @@ client.crm.notes.list(
-Creates a `Note` object with the given values. +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.
@@ -23894,16 +24023,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( - is_debug_mode=True, - run_async=True, - model=NoteRequest(), +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -23920,23 +24046,7 @@ client.crm.notes.create(
-**model:** `NoteRequest` - -
-
- -
-
- -**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. +**field_mapping_id:** `str`
@@ -23956,7 +24066,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -23968,7 +24078,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -23984,18 +24094,13 @@ Returns a `Note` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( - id="id", - expand=NotesRetrieveRequestExpand.ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -24012,15 +24117,7 @@ client.crm.notes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**field_mapping_id:** `str`
@@ -24028,7 +24125,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. +**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.
@@ -24036,7 +24133,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. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -24044,7 +24141,7 @@ 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). +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -24064,7 +24161,7 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +
client.filestorage.field_mapping.remote_fields_retrieve(...)
@@ -24076,7 +24173,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` POSTs. +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/).
@@ -24097,7 +24194,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.filestorage.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", +) ``` @@ -24113,6 +24213,22 @@ client.crm.notes.meta_post_retrieve()
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. + +
+
+ +
+
+ +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24125,7 +24241,7 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -24137,7 +24253,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` 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/).
@@ -24158,16 +24274,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, -) +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -24183,70 +24290,6 @@ client.crm.notes.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 - -
-
- -
-
- -**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.
@@ -24259,8 +24302,8 @@ client.crm.notes.remote_field_classes_list(
-## Crm Opportunities -
client.crm.opportunities.list(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -24272,7 +24315,7 @@ client.crm.notes.remote_field_classes_list(
-Returns a list of `Opportunity` objects. +Returns a list of `File` objects.
@@ -24290,17 +24333,16 @@ Returns a list of `Opportunity` objects. import datetime from merge import Merge -from merge.resources.crm.resources.opportunities import ( - OpportunitiesListRequestExpand, - OpportunitiesListRequestStatus, +from merge.resources.filestorage.resources.files import ( + FilesListRequestExpand, + FilesListRequestOrderBy, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list( - account_id="account_id", +client.filestorage.files.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -24308,25 +24350,29 @@ client.crm.opportunities.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=OpportunitiesListRequestExpand.ACCOUNT, + drive_id="drive_id", + expand=FilesListRequestExpand.DRIVE, + folder_id="folder_id", include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, + mime_type="mime_type", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - owner_id="owner_id", + name="name", + order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, page_size=1, remote_created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + remote_created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), remote_id="remote_id", - stage_id="stage_id", - status=OpportunitiesListRequestStatus.LOST, ) ``` @@ -24343,14 +24389,6 @@ client.crm.opportunities.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24375,7 +24413,7 @@ client.crm.opportunities.list(
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — 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.
@@ -24383,7 +24421,7 @@ client.crm.opportunities.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[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24391,7 +24429,7 @@ client.crm.opportunities.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -24399,7 +24437,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. +**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/).
@@ -24407,7 +24445,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). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24415,7 +24453,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. +**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).
@@ -24423,7 +24461,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. +**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
@@ -24431,7 +24469,7 @@ client.crm.opportunities.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24439,7 +24477,7 @@ client.crm.opportunities.list(
-**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.
@@ -24447,7 +24485,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. +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -24455,7 +24493,7 @@ client.crm.opportunities.list(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — 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.
@@ -24463,7 +24501,7 @@ client.crm.opportunities.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.
@@ -24471,7 +24509,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) +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime.
@@ -24479,7 +24517,7 @@ client.crm.opportunities.list(
-**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime.
@@ -24487,13 +24525,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 +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24513,7 +24545,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +
client.filestorage.files.create(...)
@@ -24525,7 +24557,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Creates a `File` object with the given values.
@@ -24541,16 +24573,16 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( +client.filestorage.files.create( is_debug_mode=True, run_async=True, - model=OpportunityRequest(), + model=FileRequest(), ) ``` @@ -24567,7 +24599,7 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` +**model:** `FileRequest`
@@ -24603,7 +24635,7 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +
client.filestorage.files.retrieve(...)
@@ -24615,7 +24647,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` object with the given `id`. +Returns a `File` object with the given `id`.
@@ -24631,19 +24663,18 @@ Returns an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.opportunities import ( - OpportunitiesRetrieveRequestExpand, +from merge.resources.filestorage.resources.files import ( + FilesRetrieveRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( +client.filestorage.files.retrieve( id="id", - expand=OpportunitiesRetrieveRequestExpand.ACCOUNT, + expand=FilesRetrieveRequestExpand.DRIVE, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, ) @@ -24669,7 +24700,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. +**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24685,14 +24716,6 @@ 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_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).
@@ -24701,22 +24724,6 @@ client.crm.opportunities.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.
@@ -24729,7 +24736,7 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -24741,7 +24748,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -24757,17 +24764,14 @@ 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.filestorage.files.download_request_meta_retrieve( id="id", - is_debug_mode=True, - run_async=True, - model=PatchedOpportunityRequest(), + mime_type="mime_type", ) ``` @@ -24792,23 +24796,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. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -24828,7 +24816,7 @@ client.crm.opportunities.partial_update(
-
client.crm.opportunities.meta_patch_retrieve(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -24840,7 +24828,7 @@ client.crm.opportunities.partial_update(
-Returns metadata for `Opportunity` PATCHs. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -24856,13 +24844,24 @@ Returns metadata for `Opportunity` PATCHs. ```python from merge import Merge +from merge.resources.filestorage.resources.files import ( + FilesDownloadRequestMetaListRequestOrderBy, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_patch_retrieve( - id="id", +client.filestorage.files.download_request_meta_list( + created_after="created_after", + created_before="created_before", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + mime_types="mime_types", + modified_after="modified_after", + modified_before="modified_before", + order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, + page_size=1, ) ``` @@ -24879,7 +24878,79 @@ client.crm.opportunities.meta_patch_retrieve(
-**id:** `str` +**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. + +
+
+ +
+
+ +**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings. + +
+
+ +
+
+ +**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/). + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. + +
+
+ +
+
+ +**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.
@@ -24899,7 +24970,7 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +
client.filestorage.files.meta_post_retrieve()
@@ -24911,7 +24982,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Returns metadata for `FileStorageFile` POSTs.
@@ -24932,7 +25003,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.filestorage.files.meta_post_retrieve() ``` @@ -24960,7 +25031,8 @@ client.crm.opportunities.meta_post_retrieve()
-
client.crm.opportunities.remote_field_classes_list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -24972,7 +25044,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Folder` objects.
@@ -24987,21 +25059,40 @@ Returns a list of `RemoteFieldClass` objects.
```python +import datetime + from merge import Merge +from merge.resources.filestorage.resources.folders import ( + FoldersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list( +client.filestorage.folders.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + drive_id="drive_id", + expand=FoldersListRequestExpand.DRIVE, include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, - is_common_model_field=True, - is_custom=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", page_size=1, + parent_folder_id="parent_folder_id", + remote_id="remote_id", ) ``` @@ -25018,23 +25109,7 @@ client.crm.opportunities.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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25042,7 +25117,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25050,7 +25125,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). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25058,7 +25133,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 +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
@@ -25066,7 +25141,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 +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25074,7 +25149,7 @@ client.crm.opportunities.remote_field_classes_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/).
@@ -25082,75 +25157,63 @@ client.crm.opportunities.remote_field_classes_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.
-
-
- - - - -
-## Crm Passthrough -
client.crm.passthrough.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. + +
+
+
-Pull data from an endpoint not currently supported by Merge. -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. + +
+
+
-```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", - ), -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + -#### ⚙️ Parameters -
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. + +
+
+
-**request:** `DataPassthroughRequest` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -25170,8 +25233,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +
client.filestorage.folders.create(...)
@@ -25183,7 +25245,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +Creates a `Folder` object with the given values.
@@ -25199,13 +25261,16 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.filestorage.folders.create( + is_debug_mode=True, + run_async=True, + model=FolderRequest(), ) ``` @@ -25222,7 +25287,23 @@ client.crm.regenerate_key.create(
-**name:** `str` — The name of the remote key +**model:** `FolderRequest` + +
+
+ +
+
+ +**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.
@@ -25242,8 +25323,7 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +
client.filestorage.folders.retrieve(...)
@@ -25255,7 +25335,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Returns a `Folder` object with the given `id`.
@@ -25270,34 +25350,20 @@ Returns a list of `Stage` objects.
```python -import datetime - from merge import Merge +from merge.resources.filestorage.resources.folders import ( + FoldersRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.folders.retrieve( + id="id", + expand=FoldersRetrieveRequestExpand.DRIVE, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -25314,7 +25380,7 @@ client.crm.stages.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -25322,7 +25388,7 @@ client.crm.stages.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25330,7 +25396,7 @@ client.crm.stages.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.
@@ -25338,7 +25404,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/). +**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).
@@ -25346,59 +25412,64 @@ 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. +**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. -
+
+
client.filestorage.folders.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). - -
-
+#### 📝 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 metadata for `FileStorageFolder` POSTs. +
+
+#### 🔌 Usage +
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.folders.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -25414,7 +25485,8 @@ client.crm.stages.list(
-
client.crm.stages.retrieve(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -25426,7 +25498,7 @@ client.crm.stages.list(
-Returns a `Stage` object with the given `id`. +Create a remote key.
@@ -25447,11 +25519,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( - id="id", - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -25468,31 +25537,7 @@ client.crm.stages.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_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). +**name:** `str` — The name of the remote key
@@ -25512,7 +25557,8 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -25524,7 +25570,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Group` objects.
@@ -25539,21 +25585,33 @@ Returns a list of `RemoteFieldClass` objects.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list( +client.filestorage.groups.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, - is_common_model_field=True, - is_custom=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), page_size=1, + remote_id="remote_id", ) ``` @@ -25570,7 +25628,31 @@ client.crm.stages.remote_field_classes_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. + +
+
+ +
+
+ +**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["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25594,7 +25676,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).
@@ -25602,7 +25684,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.
@@ -25610,7 +25692,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.
@@ -25618,7 +25700,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.
@@ -25626,7 +25708,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.
@@ -25646,8 +25728,7 @@ client.crm.stages.remote_field_classes_list(
-## Crm SyncStatus -
client.crm.sync_status.list(...) +
client.filestorage.groups.retrieve(...)
@@ -25659,7 +25740,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 `Group` object with the given `id`.
@@ -25680,9 +25761,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.filestorage.groups.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -25699,7 +25781,7 @@ client.crm.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -25707,7 +25789,7 @@ client.crm.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25715,65 +25797,19 @@ client.crm.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.
- -
- - - - -
- -## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() -
-
- -#### 📝 Description - -
-
- -
-
- -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 - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.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). +
-#### ⚙️ Parameters - -
-
-
@@ -25789,8 +25825,8 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -25802,7 +25838,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Gets all issues for Organization.
@@ -25820,33 +25856,35 @@ Returns a list of `Task` objects. import datetime from merge import Merge -from merge.resources.crm.resources.tasks import TasksListRequestExpand +from merge.resources.filestorage.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list( - created_after=datetime.datetime.fromisoformat( +client.filestorage.issues.list( + account_token="account_token", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - created_before=datetime.datetime.fromisoformat( + first_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=TasksListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - modified_before=datetime.datetime.fromisoformat( + last_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + linked_account_id="linked_account_id", page_size=1, - remote_id="remote_id", + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -25863,7 +25901,7 @@ client.crm.tasks.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**account_token:** `typing.Optional[str]`
@@ -25871,7 +25909,7 @@ client.crm.tasks.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.
@@ -25879,7 +25917,7 @@ client.crm.tasks.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
@@ -25887,7 +25925,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. +**end_user_organization_name:** `typing.Optional[str]`
@@ -25895,7 +25933,7 @@ client.crm.tasks.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.
@@ -25903,7 +25941,7 @@ client.crm.tasks.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.
@@ -25911,7 +25949,7 @@ client.crm.tasks.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
@@ -25919,7 +25957,7 @@ client.crm.tasks.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]`
@@ -25927,7 +25965,7 @@ client.crm.tasks.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.
@@ -25935,7 +25973,15 @@ client.crm.tasks.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. + +
+
+ +
+
+ +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -25951,7 +25997,20 @@ client.crm.tasks.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + +
+
+ +
+
+ +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -25971,7 +26030,7 @@ client.crm.tasks.list(
-
client.crm.tasks.create(...) +
client.filestorage.issues.retrieve(...)
@@ -25983,7 +26042,7 @@ client.crm.tasks.list(
-Creates a `Task` object with the given values. +Get a specific issue.
@@ -25999,16 +26058,13 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - is_debug_mode=True, - run_async=True, - model=TaskRequest(), +client.filestorage.issues.retrieve( + id="id", ) ``` @@ -26025,7 +26081,7 @@ client.crm.tasks.create(
-**model:** `TaskRequest` +**id:** `str`
@@ -26033,91 +26089,139 @@ client.crm.tasks.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Filestorage LinkToken +
client.filestorage.link_token.create(...) +
+
+ +#### 📝 Description
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - +
+
+ +Creates a link token to be used when linking a new end user.
+
+
+ +#### 🔌 Usage
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +
+
+ +```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], +) + +``` +
+
+
+
+ +#### ⚙️ 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.
+ +
+
+ +**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.crm.tasks.retrieve(...)
-#### 📝 Description +**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/. + +
+
+
-Returns a `Task` object with the given `id`. -
-
+**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. + -#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.crm.resources.tasks import TasksRetrieveRequestExpand - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.retrieve( - id="id", - expand=TasksRetrieveRequestExpand.ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, -) - -``` -
-
+**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. +
-#### ⚙️ 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. + +
+
+
-**id:** `str` +**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.
@@ -26125,7 +26229,14 @@ 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. +**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.
@@ -26133,7 +26244,12 @@ client.crm.tasks.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**language:** `typing.Optional[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -26141,7 +26257,7 @@ client.crm.tasks.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. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -26149,7 +26265,7 @@ client.crm.tasks.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.
@@ -26169,7 +26285,8 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -26181,7 +26298,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +List linked accounts for your organization.
@@ -26197,17 +26314,28 @@ Updates a `Task` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedTaskRequest +from merge.resources.filestorage.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.partial_update( +client.filestorage.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", id="id", - is_debug_mode=True, - run_async=True, - model=PatchedTaskRequest(), + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", ) ``` @@ -26224,7 +26352,17 @@ client.crm.tasks.partial_update(
-**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
@@ -26232,7 +26370,7 @@ client.crm.tasks.partial_update(
-**model:** `PatchedTaskRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26240,7 +26378,7 @@ client.crm.tasks.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -26248,7 +26386,7 @@ client.crm.tasks.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -26256,70 +26394,71 @@ client.crm.tasks.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.tasks.meta_patch_retrieve(...)
-#### 📝 Description +**id:** `typing.Optional[str]` + +
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+
-Returns metadata for `Task` PATCHs. -
-
+**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. + -#### 🔌 Usage -
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.meta_patch_retrieve( - id="id", -) - -``` -
-
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**id:** `str` +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -26339,7 +26478,8 @@ client.crm.tasks.meta_patch_retrieve(
-
client.crm.tasks.meta_post_retrieve() +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -26351,7 +26491,7 @@ client.crm.tasks.meta_patch_retrieve(
-Returns metadata for `Task` POSTs. +Pull data from an endpoint not currently supported by Merge.
@@ -26367,12 +26507,18 @@ Returns metadata for `Task` POSTs. ```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.crm.tasks.meta_post_retrieve() +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -26388,6 +26534,14 @@ client.crm.tasks.meta_post_retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26400,7 +26554,8 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
@@ -26412,7 +26567,7 @@ client.crm.tasks.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Exchange remote keys.
@@ -26433,15 +26588,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -26452,69 +26600,13 @@ client.crm.tasks.remote_field_classes_list( #### ⚙️ 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/). - -
-
- -
-
- -**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 - -
-
- -
-
- -**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. +**name:** `str` — The name of the remote key
@@ -26534,8 +26626,8 @@ client.crm.tasks.remote_field_classes_list(
-## Crm Users -
client.crm.users.list(...) +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -26547,7 +26639,7 @@ client.crm.tasks.remote_field_classes_list(
-Returns a list of `User` 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).
@@ -26562,35 +26654,15 @@ Returns a list of `User` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.filestorage.sync_status.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email="email", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), page_size=1, - remote_id="remote_id", ) ``` @@ -26607,7 +26679,7 @@ client.crm.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26615,7 +26687,7 @@ client.crm.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26623,83 +26695,65 @@ client.crm.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 users with this email. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_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_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). - +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.
- -
-
- -**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. - -
-
-
-**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.filestorage.force_resync.sync_status_resync_create() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -26715,7 +26769,8 @@ client.crm.users.list(
-
client.crm.users.retrieve(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -26727,7 +26782,7 @@ client.crm.users.list(
-Returns a `User` object with the given `id`. +Returns a list of `User` objects.
@@ -26742,17 +26797,34 @@ Returns a `User` object with the given `id`.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( - id="id", +client.filestorage.users.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, + is_me="is_me", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -26769,7 +26841,7 @@ client.crm.users.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26777,7 +26849,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26785,7 +26857,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26793,7 +26865,7 @@ client.crm.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). +**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/).
@@ -26801,74 +26873,47 @@ client.crm.users.retrieve(
-**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.users.ignore_create(...)
-#### 📝 Description - -
-
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. + +
+
-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.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, - ), -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
-
-
- -**model_id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26876,7 +26921,7 @@ client.crm.users.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26896,7 +26941,7 @@ client.crm.users.ignore_create(
-
client.crm.users.remote_field_classes_list(...) +
client.filestorage.users.retrieve(...)
@@ -26908,7 +26953,7 @@ client.crm.users.ignore_create(
-Returns a list of `RemoteFieldClass` objects. +Returns a `User` object with the given `id`.
@@ -26929,15 +26974,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.users.retrieve( + id="id", include_remote_data=True, - include_remote_fields=True, include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, ) ``` @@ -26954,15 +26994,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/). +**id:** `str`
@@ -26978,14 +27010,6 @@ client.crm.users.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).
@@ -26994,30 +27018,6 @@ client.crm.users.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 - -
-
- -
-
- -**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.
@@ -27030,8 +27030,8 @@ client.crm.users.remote_field_classes_list(
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
@@ -27064,7 +27064,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.filestorage.webhook_receivers.list() ```
@@ -27092,7 +27092,7 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +
client.filestorage.webhook_receivers.create(...)
@@ -27125,7 +27125,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( +client.filestorage.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index e064abf5..4350fe25 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -90,8 +90,8 @@ def __init__( ) self._ats: typing.Optional[AtsClient] = None self._chat: typing.Optional[ChatClient] = None - self._filestorage: typing.Optional[FilestorageClient] = None self._crm: typing.Optional[CrmClient] = None + self._filestorage: typing.Optional[FilestorageClient] = None self._hris: typing.Optional[HrisClient] = None self._knowledgebase: typing.Optional[KnowledgebaseClient] = None self._ticketing: typing.Optional[TicketingClient] = None @@ -113,14 +113,6 @@ def chat(self): self._chat = ChatClient(client_wrapper=self._client_wrapper) return self._chat - @property - def filestorage(self): - if self._filestorage is None: - from .resources.filestorage.client import FilestorageClient # noqa: E402 - - self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) - return self._filestorage - @property def crm(self): if self._crm is None: @@ -129,6 +121,14 @@ def crm(self): self._crm = CrmClient(client_wrapper=self._client_wrapper) return self._crm + @property + def filestorage(self): + if self._filestorage is None: + from .resources.filestorage.client import FilestorageClient # noqa: E402 + + self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) + return self._filestorage + @property def hris(self): if self._hris is None: @@ -233,8 +233,8 @@ def __init__( ) self._ats: typing.Optional[AsyncAtsClient] = None self._chat: typing.Optional[AsyncChatClient] = None - self._filestorage: typing.Optional[AsyncFilestorageClient] = None self._crm: typing.Optional[AsyncCrmClient] = None + self._filestorage: typing.Optional[AsyncFilestorageClient] = None self._hris: typing.Optional[AsyncHrisClient] = None self._knowledgebase: typing.Optional[AsyncKnowledgebaseClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None @@ -256,14 +256,6 @@ def chat(self): self._chat = AsyncChatClient(client_wrapper=self._client_wrapper) return self._chat - @property - def filestorage(self): - if self._filestorage is None: - from .resources.filestorage.client import AsyncFilestorageClient # noqa: E402 - - self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) - return self._filestorage - @property def crm(self): if self._crm is None: @@ -272,6 +264,14 @@ def crm(self): self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) return self._crm + @property + def filestorage(self): + if self._filestorage is None: + from .resources.filestorage.client import AsyncFilestorageClient # noqa: E402 + + self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) + return self._filestorage + @property def hris(self): if self._hris is None: diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 45e75a53..af760778 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.6.1", + "User-Agent": "MergePythonClient/2.6.2", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.6.1", + "X-Fern-SDK-Version": "2.6.2", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/resources/accounting/types/expense_line.py b/src/merge/resources/accounting/types/expense_line.py index 7ff6f26f..e3bf7be8 100644 --- a/src/merge/resources/accounting/types/expense_line.py +++ b/src/merge/resources/accounting/types/expense_line.py @@ -408,6 +408,16 @@ class ExpenseLine(UncheckedBaseModel): The tax rate that applies to this line item. """ + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + Number of items for the expense line. + """ + + unit_price: typing.Optional[str] = pydantic.Field(default=None) + """ + Unit price of the item for the expense line. + """ + remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ 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/). diff --git a/src/merge/resources/accounting/types/expense_line_request.py b/src/merge/resources/accounting/types/expense_line_request.py index c9fbb2e0..1a60035c 100644 --- a/src/merge/resources/accounting/types/expense_line_request.py +++ b/src/merge/resources/accounting/types/expense_line_request.py @@ -397,6 +397,16 @@ class ExpenseLineRequest(UncheckedBaseModel): The tax rate that applies to this line item. """ + quantity: typing.Optional[str] = pydantic.Field(default=None) + """ + Number of items for the expense line. + """ + + unit_price: typing.Optional[str] = pydantic.Field(default=None) + """ + Unit price of the item for the expense line. + """ + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None diff --git a/src/merge/resources/filestorage/types/drive.py b/src/merge/resources/filestorage/types/drive.py index 50a5f2bf..c0f931ee 100644 --- a/src/merge/resources/filestorage/types/drive.py +++ b/src/merge/resources/filestorage/types/drive.py @@ -49,6 +49,11 @@ class Drive(UncheckedBaseModel): The drive's url. """ + size: typing.Optional[int] = pydantic.Field(default=None) + """ + The drive's size, in bytes. + """ + remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ 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/).