diff --git a/Cargo.lock b/Cargo.lock index e67d1761..60fee1f1 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -53,27 +53,10 @@ dependencies = [ ] [[package]] -name = "assert-json-diff" -version = "2.0.2" +name = "atomic-waker" +version = "1.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "47e4f2b81832e72834d7518d8487a0396a28cc408186a2e8854c0f98011faf12" -dependencies = [ - "serde", - "serde_json", -] - -[[package]] -name = "async-compression" -version = "0.3.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "942c7cd7ae39e91bde4820d74132e9862e62c2f386c3aa90ccf55949f5bad63a" -dependencies = [ - "flate2", - "futures-core", - "memchr", - "pin-project-lite", - "tokio", -] +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" [[package]] name = "atty" @@ -111,9 +94,9 @@ checksum = "9e1b586273c5702936fe7b7d6896644d8be71e6314cfe09d3167c95f712589e8" [[package]] name = "base64" -version = "0.21.0" +version = "0.22.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4a4ddaa51a5bc52a6948f74c06d20aaaddb71924eab79b8c97a8c556e942d6a" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" [[package]] name = "bitflags" @@ -387,7 +370,7 @@ dependencies = [ "proc-macro2", "quote", "scratch", - "syn 2.0.34", + "syn 2.0.106", ] [[package]] @@ -404,14 +387,14 @@ checksum = "2345488264226bf682893e25de0769f3360aac9957980ec49361b083ddaa5bc5" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", ] [[package]] name = "darling" -version = "0.14.4" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7b750cb3417fd1b327431a470f388520309479ab0bf5e323505daf0290cd3850" +checksum = "fc7f46116c46ff9ab3eb1597a45688b6715c6e628b5c133e288e709a29bcb4ee" dependencies = [ "darling_core", "darling_macro", @@ -419,27 +402,27 @@ dependencies = [ [[package]] name = "darling_core" -version = "0.14.4" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "109c1ca6e6b7f82cc233a97004ea8ed7ca123a9af07a8230878fcfda9b158bf0" +checksum = "0d00b9596d185e565c2207a0b01f8bd1a135483d02d9b7b0a54b11da8d53412e" dependencies = [ "fnv", "ident_case", "proc-macro2", "quote", "strsim", - "syn 1.0.109", + "syn 2.0.106", ] [[package]] name = "darling_macro" -version = "0.14.4" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4aab4dbc9f7611d8b55048a3a16d2d010c2c8334e46304b40ac1cc14bf3b48e" +checksum = "fc34b93ccb385b40dc71c6fceac4b2ad23662c7eeb248cf10d529b7e055b6ead" dependencies = [ "darling_core", "quote", - "syn 1.0.109", + "syn 2.0.106", ] [[package]] @@ -472,7 +455,7 @@ checksum = "30542c1ad912e0e3d22a1935c290e12e8a29d704a420177a31faad4a601a0800" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", ] [[package]] @@ -547,6 +530,23 @@ dependencies = [ "winapi", ] +[[package]] +name = "displaydoc" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + +[[package]] +name = "dyn-clone" +version = "1.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0881ea181b1df73ff77ffaaf9c7544ecc11e82fba9b5f27b262a3c73a332555" + [[package]] name = "either" version = "1.13.0" @@ -657,9 +657,9 @@ checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" [[package]] name = "form_urlencoded" -version = "1.1.0" +version = "1.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a9c384f161156f5260c24a097c56119f9be8c798586aecc13afbcbe7b7e26bf8" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" dependencies = [ "percent-encoding", ] @@ -671,6 +671,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "164713a5a0dcc3e7b4b1ed7d3b433cabc18025386f9339346e8daf15963cf7ac" dependencies = [ "futures-core", + "futures-sink", ] [[package]] @@ -705,6 +706,7 @@ checksum = "3ef6b17e481503ec85211fed8f39d1970f128935ca1f814cd32ac4a6842e84ab" dependencies = [ "futures-core", "futures-io", + "futures-sink", "futures-task", "memchr", "pin-project-lite", @@ -758,17 +760,17 @@ dependencies = [ [[package]] name = "h2" -version = "0.3.16" +version = "0.4.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5be7b54589b581f624f566bf5d8eb2bab1db736c51528720b6bd36b96b55924d" +checksum = "f3c0b69cfcb4e1b9f1bf2f53f95f766e4661169728ec61cd3fe5a0166f2d1386" dependencies = [ + "atomic-waker", "bytes", "fnv", "futures-core", "futures-sink", - "futures-util", "http", - "indexmap 1.9.3", + "indexmap 2.8.0", "slab", "tokio", "tokio-util", @@ -837,9 +839,9 @@ dependencies = [ [[package]] name = "http" -version = "0.2.9" +version = "1.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bd6effc99afb63425aff9b05836f029929e345a6148a14b7ecd5ab67af944482" +checksum = "f4a85d31aea989eead29a3aaf9e1115a180df8282431156e533de47660892565" dependencies = [ "bytes", "fnv", @@ -848,12 +850,24 @@ dependencies = [ [[package]] name = "http-body" -version = "0.4.5" +version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d5f38f16d184e36f2408a55281cd658ecbd3ca05cce6d6510a176eca393e26d1" +checksum = "1efedce1fb8e6913f23e0c92de8e62cd5b772a67e7b3946df930a62566c93184" dependencies = [ "bytes", "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b021d93e26becf5dc7e1b75b1bed1fd93124b374ceb73f43d4d4eafec896a64a" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", "pin-project-lite", ] @@ -863,12 +877,6 @@ version = "1.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d897f394bad6a705d5f4104762e116a75639e470d80901eed05a860a95cb1904" -[[package]] -name = "httpdate" -version = "1.0.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c4a1e36c821dbe04574f602848a19f742f4fb3c98d40449f11bcad18d6b17421" - [[package]] name = "humantime" version = "2.1.0" @@ -877,39 +885,58 @@ checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4" [[package]] name = "hyper" -version = "0.14.25" +version = "1.5.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cc5e554ff619822309ffd57d8734d77cd5ce6238bc956f037ea06c58238c9899" +checksum = "256fb8d4bd6413123cc9d91832d78325c48ff41677595be797d90f42969beae0" dependencies = [ "bytes", "futures-channel", - "futures-core", "futures-util", "h2", "http", "http-body", "httparse", - "httpdate", "itoa", "pin-project-lite", - "socket2", + "smallvec", "tokio", - "tower-service", - "tracing", "want", ] [[package]] name = "hyper-tls" -version = "0.5.0" +version = "0.6.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d6183ddfa99b85da61a140bea0efc93fdf56ceaa041b37d553518030827f9905" +checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0" dependencies = [ "bytes", + "http-body-util", "hyper", + "hyper-util", "native-tls", "tokio", "tokio-native-tls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cde7055719c54e36e95e8719f95883f22072a48ede39db7fc17a4e1d5281e9b9" +dependencies = [ + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "hyper", + "pin-project-lite", + "socket2 0.5.8", + "tokio", + "tower", + "tower-service", + "tracing", ] [[package]] @@ -936,6 +963,92 @@ dependencies = [ "cxx-build", ] +[[package]] +name = "icu_collections" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "200072f5d0e3614556f94a9930d5dc3e0662a652823904c3a75dc3b0af7fee47" +dependencies = [ + "displaydoc", + "potential_utf", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0cde2700ccaed3872079a65fb1a78f6c0a36c91570f28755dda67bc8f7d9f00a" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "436880e8e18df4d7bbc06d58432329d6458cc84531f7ac5f024e93deadb37979" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00210d6893afc98edb752b664b8890f0ef174c8adbb8d0be9710fa66fbbf72d3" + +[[package]] +name = "icu_properties" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "016c619c1eeb94efb86809b015c58f479963de65bdb6253345c1a1276f22e32b" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "potential_utf", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "298459143998310acd25ffe6810ed544932242d3f07083eee1084d83a71bd632" + +[[package]] +name = "icu_provider" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03c80da27b5f4187909049ee2d72f276f0d9f99a42c306bd0131ecfe04d8e5af" +dependencies = [ + "displaydoc", + "icu_locale_core", + "stable_deref_trait", + "tinystr", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + [[package]] name = "ident_case" version = "1.0.1" @@ -944,12 +1057,23 @@ checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" [[package]] name = "idna" -version = "0.3.0" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e14ddfc70884202db2244c223200c204c2bda1bc6e0998d11b5e024d657209e6" +checksum = "3acae9609540aa318d1bc588455225fb2085b9ed0c4f6bd0d9d5bcd86f1a0344" dependencies = [ - "unicode-bidi", - "unicode-normalization", + "icu_normalizer", + "icu_properties", ] [[package]] @@ -971,6 +1095,7 @@ checksum = "3954d50fe15b02142bf25d3b8bdadb634ec3948f103d04ffe3031bc8fe9d7058" dependencies = [ "equivalent", "hashbrown 0.15.2", + "serde", ] [[package]] @@ -1134,6 +1259,12 @@ version = "0.1.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f051f77a7c8e6957c0696eac88f26b0117e54f52d3fc682ab19397a8812846a4" +[[package]] +name = "litemap" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "241eaef5fd12c88705a01fc1066c48c4b36e0dd4377dcdc7ec3942cea7a69956" + [[package]] name = "lockfree-object-pool" version = "0.1.6" @@ -1163,12 +1294,6 @@ version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3e2e65a1a2e43cfcb47a895c4c8b10d1f4a61097f9f254f183aee60cad9c651d" -[[package]] -name = "matches" -version = "0.1.10" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2532096657941c2fea9c289d370a250971c689d4f143798ff67113ec042024a5" - [[package]] name = "memchr" version = "2.7.4" @@ -1212,24 +1337,6 @@ dependencies = [ "windows-sys 0.45.0", ] -[[package]] -name = "mockito" -version = "0.31.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "80f9fece9bd97ab74339fe19f4bcaf52b76dcc18e5364c7977c1838f76b38de9" -dependencies = [ - "assert-json-diff", - "colored", - "httparse", - "lazy_static", - "log", - "rand", - "regex", - "serde_json", - "serde_urlencoded", - "similar", -] - [[package]] name = "native-tls" version = "0.2.11" @@ -1295,6 +1402,19 @@ version = "1.21.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d" +[[package]] +name = "openapi" +version = "0.1.0" +dependencies = [ + "reqwest", + "serde", + "serde_json", + "serde_repr", + "serde_with", + "url", + "uuid", +] + [[package]] name = "openssl" version = "0.10.48" @@ -1327,15 +1447,6 @@ version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" -[[package]] -name = "openssl-src" -version = "111.25.2+1.1.1t" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "320708a054ad9b3bf314688b5db87cf4d6683d64cfc835e2337924ae62bf4431" -dependencies = [ - "cc", -] - [[package]] name = "openssl-sys" version = "0.9.83" @@ -1345,7 +1456,6 @@ dependencies = [ "autocfg", "cc", "libc", - "openssl-src", "pkg-config", "vcpkg", ] @@ -1382,9 +1492,29 @@ dependencies = [ [[package]] name = "percent-encoding" -version = "2.2.0" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "pin-project" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677f1add503faace112b9f1373e43e9e054bfdd22ff1a63c1bc485eaec6a6a8a" +dependencies = [ + "pin-project-internal", +] + +[[package]] +name = "pin-project-internal" +version = "1.1.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "478c572c3d73181ff3c2539045f6eb99e5491218eae919370993b890cdbdd98e" +checksum = "6e918e4ff8c4549eb882f14b3a4bc8c8bc93de829416eacf579f1207a8fbf861" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] [[package]] name = "pin-project-lite" @@ -1410,6 +1540,15 @@ version = "0.3.19" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "26f6a7b87c2e435a3241addceeeff740ff8b7e76b74c13bf9acb17fa454ea00b" +[[package]] +name = "potential_utf" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5a7c30837279ca13e7c867e9e40053bc68740f988cb07f7ca6df43cc734b585" +dependencies = [ + "zerovec", +] + [[package]] name = "powerfmt" version = "0.2.0" @@ -1474,18 +1613,18 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.67" +version = "1.0.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3d433d9f1a3e8c1263d9456598b16fec66f4acc9a74dacffd35c7bb09b3a1328" +checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de" dependencies = [ "unicode-ident", ] [[package]] name = "quote" -version = "1.0.33" +version = "1.0.40" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae" +checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d" dependencies = [ "proc-macro2", ] @@ -1554,6 +1693,26 @@ dependencies = [ "thiserror", ] +[[package]] +name = "ref-cast" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a0ae411dbe946a674d89546582cea4ba2bb8defac896622d6496f14c23ba5cf" +dependencies = [ + "ref-cast-impl", +] + +[[package]] +name = "ref-cast-impl" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1165225c21bff1f3bbce98f5a1f889949bc902d3575308cc7b0de30b4f6d27c7" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + [[package]] name = "regex" version = "1.7.3" @@ -1595,12 +1754,12 @@ dependencies = [ "maplit", "mime_guess", "once_cell", + "openapi", "ordered-float", "pretty_assertions", "prettytable-rs", "rand", "regex", - "reinfer-client", "reqwest", "scoped_threadpool", "serde", @@ -1611,43 +1770,25 @@ dependencies = [ "zip", ] -[[package]] -name = "reinfer-client" -version = "0.38.10" -dependencies = [ - "chrono", - "http", - "log", - "matches", - "mockito", - "once_cell", - "ordered-float", - "regex", - "reqwest", - "serde", - "serde_json", - "serde_with", - "thiserror", - "url", -] - [[package]] name = "reqwest" -version = "0.11.16" +version = "0.12.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "27b71749df584b7f4cac2c426c127a7c785a5106cc98f7a8feb044115f0fa254" +checksum = "566cafdd92868e0939d3fb961bd0dc25fcfaaed179291093b3d43e6b3150ea10" dependencies = [ - "async-compression", - "base64 0.21.0", + "base64 0.22.1", "bytes", "encoding_rs", + "futures-channel", "futures-core", "futures-util", "h2", "http", "http-body", + "http-body-util", "hyper", "hyper-tls", + "hyper-util", "ipnet", "js-sys", "log", @@ -1657,12 +1798,14 @@ dependencies = [ "once_cell", "percent-encoding", "pin-project-lite", + "rustls-pemfile", "serde", "serde_json", "serde_urlencoded", + "sync_wrapper", + "system-configuration", "tokio", "tokio-native-tls", - "tokio-util", "tower-service", "url", "wasm-bindgen", @@ -1685,6 +1828,24 @@ dependencies = [ "windows-sys 0.45.0", ] +[[package]] +name = "rustls-pemfile" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dce314e5fee3f39953d46bb63bb8a46d40c2f8fb7cc5a3b6cab2bde9721d6e50" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "rustls-pki-types" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "229a4a4c221013e7e1f1a043678c5cc39fe5171437c88fb47151a21e6f5b5c79" +dependencies = [ + "zeroize", +] + [[package]] name = "rustversion" version = "1.0.12" @@ -1706,6 +1867,30 @@ dependencies = [ "windows-sys 0.42.0", ] +[[package]] +name = "schemars" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cd191f9397d57d581cddd31014772520aa448f65ef991055d7f61582c65165f" +dependencies = [ + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + +[[package]] +name = "schemars" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82d20c4491bc164fa2f6c5d44565947a52ad80b9505d8e36f8d54c27c739fcd0" +dependencies = [ + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + [[package]] name = "scoped_threadpool" version = "0.1.9" @@ -1743,35 +1928,47 @@ dependencies = [ [[package]] name = "serde" -version = "1.0.188" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cf9e0fcba69a370eed61bcf2b728575f726b50b55cba78064753d708ddc7549e" +checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6" dependencies = [ "serde_derive", ] [[package]] name = "serde_derive" -version = "1.0.188" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4eca7ac642d82aa35b60049a6eccb4be6be75e599bd2e9adb5f875a737654af2" +checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", ] [[package]] name = "serde_json" -version = "1.0.95" +version = "1.0.143" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d721eca97ac802aa7777b701877c8004d950fc142651367300d21c1cc0194744" +checksum = "d401abef1d108fbd9cbaebc3e46611f4b1021f714a0597a71f41ee463f5f4a5a" dependencies = [ "itoa", + "memchr", "ryu", "serde", ] +[[package]] +name = "serde_repr" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "175ee3e80ae9982737ca543e96133087cbd9a485eecc3bc4de9c1a37b47ea59c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + [[package]] name = "serde_urlencoded" version = "0.7.1" @@ -1786,15 +1983,19 @@ dependencies = [ [[package]] name = "serde_with" -version = "2.3.1" +version = "3.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "85456ffac572dc8826334164f2fb6fb40a7c766aebe195a2a21ee69ee2885ecf" +checksum = "f2c45cd61fefa9db6f254525d46e392b852e0e61d9a1fd36e5bd183450a556d5" dependencies = [ - "base64 0.13.1", + "base64 0.22.1", "chrono", "hex", "indexmap 1.9.3", + "indexmap 2.8.0", + "schemars 0.9.0", + "schemars 1.0.4", "serde", + "serde_derive", "serde_json", "serde_with_macros", "time 0.3.41", @@ -1802,14 +2003,14 @@ dependencies = [ [[package]] name = "serde_with_macros" -version = "2.3.1" +version = "3.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7cbcd6104f8a4ab6af7f6be2a0da6be86b9de3c401f6e86bb856ab2af739232f" +checksum = "de90945e6565ce0d9a25098082ed4ee4002e047cb59892c318d66821e14bb30f" dependencies = [ "darling", "proc-macro2", "quote", - "syn 1.0.109", + "syn 2.0.106", ] [[package]] @@ -1841,12 +2042,6 @@ version = "0.3.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe" -[[package]] -name = "similar" -version = "2.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "420acb44afdae038210c99e69aae24109f32f15500aa708e81d46c9f29d55fcf" - [[package]] name = "slab" version = "0.4.8" @@ -1856,6 +2051,12 @@ dependencies = [ "autocfg", ] +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + [[package]] name = "socket2" version = "0.4.9" @@ -1866,11 +2067,27 @@ dependencies = [ "winapi", ] +[[package]] +name = "socket2" +version = "0.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c970269d99b64e60ec3bd6ad27270092a5394c4e309314b18ae3fe575695fbe8" +dependencies = [ + "libc", + "windows-sys 0.52.0", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3" + [[package]] name = "strsim" -version = "0.10.0" +version = "0.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "structopt" @@ -1915,15 +2132,53 @@ dependencies = [ [[package]] name = "syn" -version = "2.0.34" +version = "2.0.106" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "88ec6cdb6a4c16306eccf52ccd8d492e4ab64705a15a5016acb205251001bf72" +checksum = "ede7c438028d4436d71104916910f5bb611972c5cfd7f89b8300a8186e6fada6" dependencies = [ "proc-macro2", "quote", "unicode-ident", ] +[[package]] +name = "sync_wrapper" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160" + +[[package]] +name = "synstructure" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + +[[package]] +name = "system-configuration" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba3a3adc5c275d719af8cb4272ea1c4a6d668a777f37e115f6d11ddbc1c8e0e7" +dependencies = [ + "bitflags 1.3.2", + "core-foundation", + "system-configuration-sys", +] + +[[package]] +name = "system-configuration-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75fb188eb626b924683e3b95e3a48e63551fcfb51949de2f06a9d91dbee93c9" +dependencies = [ + "core-foundation-sys", + "libc", +] + [[package]] name = "tempfile" version = "3.4.0" @@ -1983,7 +2238,7 @@ checksum = "f9456a42c5b0d803c8cd86e73dd7cc9edd429499f37a3550d286d5e86720569f" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", ] [[package]] @@ -2039,20 +2294,15 @@ dependencies = [ ] [[package]] -name = "tinyvec" -version = "1.6.0" +name = "tinystr" +version = "0.8.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +checksum = "5d4f6d1145dcb577acf783d4e601bc1d76a13337bb54e6233add580b07344c8b" dependencies = [ - "tinyvec_macros", + "displaydoc", + "zerovec", ] -[[package]] -name = "tinyvec_macros" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" - [[package]] name = "tokio" version = "1.27.0" @@ -2065,7 +2315,7 @@ dependencies = [ "mio", "num_cpus", "pin-project-lite", - "socket2", + "socket2 0.4.9", "windows-sys 0.45.0", ] @@ -2093,6 +2343,27 @@ dependencies = [ "tracing", ] +[[package]] +name = "tower" +version = "0.4.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8fa9be0de6cf49e536ce1851f987bd21a43b771b09473c3549a6c853db37c1c" +dependencies = [ + "futures-core", + "futures-util", + "pin-project", + "pin-project-lite", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + [[package]] name = "tower-service" version = "0.3.2" @@ -2140,27 +2411,12 @@ dependencies = [ "version_check", ] -[[package]] -name = "unicode-bidi" -version = "0.3.13" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "92888ba5573ff080736b3648696b70cafad7d250551175acbaa4e0385b3e1460" - [[package]] name = "unicode-ident" version = "1.0.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b15811caf2415fb889178633e7724bad2509101cde276048e013b9def5e51fa0" -[[package]] -name = "unicode-normalization" -version = "0.1.22" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c5713f0fc4b5db668a2ac63cdb7bb4469d8c9fed047b1d0292cc7b0ce2ba921" -dependencies = [ - "tinyvec", -] - [[package]] name = "unicode-segmentation" version = "1.10.1" @@ -2175,9 +2431,9 @@ checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b" [[package]] name = "url" -version = "2.3.1" +version = "2.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d68c799ae75762b8c3fe375feb6600ef5602c883c5d21eb51c09f22b83c4643" +checksum = "08bc136a29a3d1758e07a9cca267be308aeebf5cfd5a10f3f67ab2097683ef5b" dependencies = [ "form_urlencoded", "idna", @@ -2185,13 +2441,22 @@ dependencies = [ "serde", ] +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + [[package]] name = "uuid" -version = "1.3.0" +version = "1.18.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1674845326ee10d37ca60470760d4288a6f80f304007d92e5c53bab78c9cfd79" +checksum = "f33196643e165781c20a5ead5582283a7dacbb87855d867fbc2df3f81eddc1be" dependencies = [ - "getrandom 0.2.10", + "getrandom 0.3.2", + "js-sys", + "serde", + "wasm-bindgen", ] [[package]] @@ -2259,7 +2524,7 @@ dependencies = [ "log", "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", "wasm-bindgen-shared", ] @@ -2293,7 +2558,7 @@ checksum = "8ae87ea40c9f689fc23f209965b6fb8a99ad69aeeb0231408be24920604395de" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", "wasm-bindgen-backend", "wasm-bindgen-shared", ] @@ -2354,7 +2619,7 @@ version = "0.46.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cdacb41e6a96a052c6cb63a144f24900236121c6f63f4f8219fef5977ecb0c25" dependencies = [ - "windows-targets", + "windows-targets 0.42.2", ] [[package]] @@ -2363,13 +2628,13 @@ version = "0.42.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5a3e1820f08b8513f676f7ab6c1f99ff312fb97b553d30ff4dd86f9f15728aa7" dependencies = [ - "windows_aarch64_gnullvm", - "windows_aarch64_msvc", - "windows_i686_gnu", - "windows_i686_msvc", - "windows_x86_64_gnu", - "windows_x86_64_gnullvm", - "windows_x86_64_msvc", + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", ] [[package]] @@ -2378,7 +2643,25 @@ version = "0.45.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" dependencies = [ - "windows-targets", + "windows-targets 0.42.2", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets 0.52.6", ] [[package]] @@ -2387,13 +2670,44 @@ version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071" dependencies = [ - "windows_aarch64_gnullvm", - "windows_aarch64_msvc", - "windows_i686_gnu", - "windows_i686_msvc", - "windows_x86_64_gnu", - "windows_x86_64_gnullvm", - "windows_x86_64_msvc", + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm 0.52.6", + "windows_aarch64_msvc 0.52.6", + "windows_i686_gnu 0.52.6", + "windows_i686_gnullvm", + "windows_i686_msvc 0.52.6", + "windows_x86_64_gnu 0.52.6", + "windows_x86_64_gnullvm 0.52.6", + "windows_x86_64_msvc 0.52.6", ] [[package]] @@ -2402,49 +2716,140 @@ version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8" +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + [[package]] name = "windows_aarch64_msvc" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43" +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + [[package]] name = "windows_i686_gnu" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f" +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + [[package]] name = "windows_i686_msvc" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060" +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + [[package]] name = "windows_x86_64_gnu" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36" +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + [[package]] name = "windows_x86_64_gnullvm" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3" +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + [[package]] name = "windows_x86_64_msvc" version = "0.42.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0" +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + [[package]] name = "winreg" -version = "0.10.1" +version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "80d0f4e272c85def139476380b12f9ac60926689dd2e01d4923222f40580869d" +checksum = "a277a57398d4bfa075df44f501a17cfdf8542d224f0d36095a2adc7aee4ef0a5" dependencies = [ - "winapi", + "cfg-if", + "windows-sys 0.48.0", ] [[package]] @@ -2456,12 +2861,63 @@ dependencies = [ "bitflags 2.9.0", ] +[[package]] +name = "writeable" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea2f10b9bb0928dfb1b42b65e1f9e36f7f54dbdf08457afefb38afcdec4fa2bb" + [[package]] name = "yansi" version = "0.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec" +[[package]] +name = "yoke" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5f41bb01b8226ef4bfd589436a297c53d118f65921786300e427be8d487695cc" +dependencies = [ + "serde", + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38da3c9736e16c5d3c8c597a9aaa5d1fa565d0532ae05e27c24aa62fb32c0ab6" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", + "synstructure", +] + +[[package]] +name = "zerofrom" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50cc42e0333e05660c3587f3bf9d0478688e15d870fab3346451ce7f8c9fbea5" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d71e5d6e06ab090c67b5e44993ec16b72dcbaabc526db883a360057678b48502" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", + "synstructure", +] + [[package]] name = "zeroize" version = "1.8.1" @@ -2479,7 +2935,40 @@ checksum = "ce36e65b0d2999d2aafac989fb249189a141aee1f53c612c1f37d72631959f69" dependencies = [ "proc-macro2", "quote", - "syn 2.0.34", + "syn 2.0.106", +] + +[[package]] +name = "zerotrie" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36f0bbd478583f79edad978b407914f61b2972f5af6fa089686016be8f9af595" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7aa2bd55086f1ab526693ecbe444205da57e25f4489879da80635a46d90e73b" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b96237efa0c878c64bd89c436f661be4e46b2f3eff1ebb976f7ef2321d2f58f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", ] [[package]] diff --git a/Cargo.toml b/Cargo.toml index 5dc3e76b..61c3e40b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [workspace] members = [ - "api", "cli", + "api" ] resolver = "2" diff --git a/README.md b/README.md index a2bc52e2..a883668d 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,16 @@ The binary is located at `../target/release/re`. Move it somewhere suitable, e.g sudo mv ../target/release/re /usr/local/bin/ ``` +## Development + +### 🚀 For Publishing +Use `./cli/publish-binaries` - automatically uses `develop` branch and generates fresh client. + +### 🔧 For Local Development +Use `./scripts/openapi-client/update-and-generate-complete.sh` - prompts for branch, generates client in `api/` directory. + +For more details, see the [scripts README](scripts/README.md). + ## Getting Started Check the installation and see a full listing of the available commands by running `re` with no arguments. diff --git a/api/.gitignore b/api/.gitignore index 53eaa219..6aa10640 100644 --- a/api/.gitignore +++ b/api/.gitignore @@ -1,2 +1,3 @@ -/target +/target/ **/*.rs.bk +Cargo.lock diff --git a/api/.openapi-generator-ignore b/api/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/api/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/api/.openapi-generator/FILES b/api/.openapi-generator/FILES new file mode 100644 index 00000000..c84c814d --- /dev/null +++ b/api/.openapi-generator/FILES @@ -0,0 +1,1755 @@ +.gitignore +.travis.yml +Cargo.toml +README.md +docs/Access.md +docs/AddCommentsRequest.md +docs/AddCommentsResponse.md +docs/AddEmailsToBucketRequest.md +docs/AddEmailsToBucketResponse.md +docs/AddSupportTenantRequest.md +docs/AddSupportTenantResponse.md +docs/AdvanceStreamRequest.md +docs/AdvanceStreamResponse.md +docs/AdvanceTriggerRequest.md +docs/AdvanceTriggerResponse.md +docs/Alert.md +docs/AlertConfig.md +docs/AlertConfigKind.md +docs/AlertFilter.md +docs/AlertIssuesResponse.md +docs/AlertMetric.md +docs/AlertNew.md +docs/AlertProcessThreshold.md +docs/AlertProcessVariation.md +docs/AlertSubscription.md +docs/AlertUpdate.md +docs/AlertsApi.md +docs/AmountFieldDataPrivate.md +docs/AnalyticsApi.md +docs/AnnotatedComment.md +docs/Annotation.md +docs/AnnotationLabel.md +docs/AnnotationMetadata.md +docs/AnnotationMetadataCount.md +docs/Annotations.md +docs/AppAccessModel.md +docs/AppAccessModelKind.md +docs/ApplianceConfigsApi.md +docs/Application.md +docs/AssignedPredictedPresentFilter.md +docs/AssignmentMethod.md +docs/Attachment.md +docs/AttachmentsApi.md +docs/Attribute.md +docs/AttributeFilter.md +docs/AttributeFilterAttribute.md +docs/AttributionMethod.md +docs/AuditEvent.md +docs/AuditEventsApi.md +docs/AuditEventsDataset.md +docs/AuditEventsProject.md +docs/AuditEventsSource.md +docs/AuditEventsTenant.md +docs/AuditEventsTrigger.md +docs/AuditEventsUser.md +docs/BinaryLabelHealthAction.md +docs/BinaryLabelHealthActionKind.md +docs/BinaryLabelHealthWarning.md +docs/BinaryLabelHealthWarningKind.md +docs/Binning.md +docs/BoolFieldDataPrivate.md +docs/BoolFieldDataType.md +docs/Breakdown.md +docs/Bucket.md +docs/BucketNew.md +docs/BucketStatistics.md +docs/BucketSyncState.md +docs/BucketUpdate.md +docs/BucketUpdatedBy.md +docs/BucketsApi.md +docs/BuiltinLabelDef.md +docs/BuiltinLabelDefName.md +docs/BuiltinLabelDefRequest.md +docs/BusinessRule.md +docs/BusinessRuleComparisonOperator.md +docs/BusinessRuleLogicalOperator.md +docs/BusinessRuleSet.md +docs/BusinessRuleSetCriticality.md +docs/BusinessRuleType.md +docs/ByLabels.md +docs/ByLabelsInclude.md +docs/ByLabelsIncludeContainer.md +docs/ByLabelsTop.md +docs/ByLabelsTopContainer.md +docs/CaptureThreshold.md +docs/ChoiceFieldDataPrivate.md +docs/ChoiceFieldDataType.md +docs/ClientSecretApplicationModel.md +docs/ClientSecretApplicationModelKind.md +docs/CmModelConfig.md +docs/Comment.md +docs/CommentExtractionsPredictions.md +docs/CommentFilter.md +docs/CommentNew.md +docs/CommentPrediction.md +docs/CommentSentiment.md +docs/CommentSpanNewChar.md +docs/CommentSpanNewUtf16.md +docs/CommentThread.md +docs/CommentsApi.md +docs/Comparison.md +docs/ConnectionModel.md +docs/ContentPart.md +docs/Contribution.md +docs/Contributor.md +docs/ContributorKind.md +docs/ConversationalFilterApi.md +docs/ConversationalFilterRequest.md +docs/ConversationalFilterResponse.md +docs/Coocurrence.md +docs/CoocurrenceLabels.md +docs/Count.md +docs/CreateAlertRequest.md +docs/CreateAlertResponse.md +docs/CreateBucketRequest.md +docs/CreateBucketResponse.md +docs/CreateDashboardRequest.md +docs/CreateDashboardResponse.md +docs/CreateDatasetRequest.md +docs/CreateDatasetResponse.md +docs/CreateIntegrationRequest.md +docs/CreateIntegrationResponse.md +docs/CreateIxpDatasetRequest.md +docs/CreateIxpDatasetResponse.md +docs/CreateLabelDefsBulkResponse.md +docs/CreateLabelGroupRequest.md +docs/CreateLabelGroupResponse.md +docs/CreateOrUpdateLabelDefsBulkRequest.md +docs/CreateOrUpdateLabelDefsBulkRequestLabelDefsInner.md +docs/CreatePageViewRequest.md +docs/CreatePageViewResponse.md +docs/CreateProjectRequest.md +docs/CreateProjectResponse.md +docs/CreateProjectSetupCreatedResponse.md +docs/CreateProjectSetupRequest.md +docs/CreateProjectSetupResponse.md +docs/CreateSourceRequest.md +docs/CreateSourceResponse.md +docs/CreateStreamRequest.md +docs/CreateStreamResponse.md +docs/CreateTenantRequest.md +docs/CreateTenantResponse.md +docs/CreateTriggerRequest.md +docs/CreateTriggerResponse.md +docs/CreateUserRequest.md +docs/CreateUserResponse.md +docs/CustomAction.md +docs/CustomTrainingAction.md +docs/Dashboard.md +docs/DashboardUpdate.md +docs/DashboardsApi.md +docs/Data.md +docs/DataType.md +docs/DataTypeDate.md +docs/DataTypeMoney.md +docs/DataTypeNumber.md +docs/DataTypeText.md +docs/Dataset.md +docs/DatasetFlag.md +docs/DatasetNew.md +docs/DatasetOperation.md +docs/DatasetQuality.md +docs/DatasetStatus.md +docs/DatasetStringSummaryValue.md +docs/DatasetSummary.md +docs/DatasetTrainingAction.md +docs/DatasetUpdate.md +docs/DatasetUpdateEntityDefsInner.md +docs/DatasetUserPropertiesSummary.md +docs/DatasetUserPropertiesSummaryNumber.md +docs/DatasetUserPropertiesSummaryString.md +docs/DatasetsApi.md +docs/DateFieldDataPrivate.md +docs/DateFieldDataType.md +docs/DeleteAlertResponse.md +docs/DeleteAlertSubscriptionReponse.md +docs/DeleteBucketResponse.md +docs/DeleteCommentResponse.md +docs/DeleteDashboardResponse.md +docs/DeleteDatasetByIdResponse.md +docs/DeleteDatasetResponse.md +docs/DeleteIntegrationResponse.md +docs/DeleteIxpDatasetResponse.md +docs/DeleteKeyedSyncStateResponse.md +docs/DeleteLabelDefResponse.md +docs/DeleteLabelGroupResponse.md +docs/DeleteModelTagResponse.md +docs/DeleteProjectResponse.md +docs/DeleteSourceResponse.md +docs/DeleteStreamExceptionResponse.md +docs/DeleteStreamResponse.md +docs/DeleteTenantDefaultProjectPermissionsResponse.md +docs/DeleteTenantResponse.md +docs/DeleteTriggerResponse.md +docs/DeleteUserResponse.md +docs/DeploymentApi.md +docs/DeprecatedUserModelMetadata.md +docs/DeprecationApi.md +docs/Diagnostic.md +docs/DiagnosticKind.md +docs/Direction.md +docs/DisableIntegrationAction.md +docs/DisableMailboxAction.md +docs/DiscoverApi.md +docs/DocPathIxpModelConfig.md +docs/DocumentLabelPropertyPrediction.md +docs/DocumentSearchResult.md +docs/DocumentSpan.md +docs/DocumentsApi.md +docs/Email.md +docs/EmailMetadata.md +docs/EmailMetadataNew.md +docs/EmailNew.md +docs/EmailPropertiesSummary.md +docs/EmailPropertiesSummaryByProperty.md +docs/EmailPropertiesSummaryValue.md +docs/EmailPropertyCounts.md +docs/EmailPropertyCountsByProperty.md +docs/EmailPropertyCountsSettings.md +docs/EmailPropertyCountsSettingsByProperty.md +docs/EmailTransformTagInfo.md +docs/EmailsApi.md +docs/Entities.md +docs/EntitiesNew.md +docs/EntitiesPrStats.md +docs/EntitiesRules.md +docs/EntitiesRulesPresenceInner.md +docs/Entity.md +docs/EntityAverageStats.md +docs/EntityDef.md +docs/EntityDefFlag.md +docs/EntityDefIdStat.md +docs/EntityDefNew.md +docs/EntityDefSummary.md +docs/EntityDefUpdate.md +docs/EntityDefUpdateInheritsFromInner.md +docs/EntityHealth.md +docs/EntityHealthAction.md +docs/EntityHealthActionKind.md +docs/EntityHealthSmart.md +docs/EntityHealthWarning.md +docs/EntityHealthWarningKind.md +docs/EntityKind.md +docs/EntityNew.md +docs/EntityNewSpansInner.md +docs/EntityPresenceFilter.md +docs/EntityPresenceFilterWithKind.md +docs/EntityRuleSetApi.md +docs/EntityRuleSetNewApi.md +docs/EntityRuleSetUpdateApi.md +docs/EntityRuleSetUpdateApiChoicesInner.md +docs/EntitySummaryV1.md +docs/EntityTemplatePropertiesApi.md +docs/EntityTemplatesPropertiesApi.md +docs/ErrorAction.md +docs/ErrorResponse.md +docs/EwsApiModel.md +docs/EwsApiModelKind.md +docs/ExactBucketCount.md +docs/ExceptionModel.md +docs/ExportDatasetRequest.md +docs/ExportDatasetResponse.md +docs/ExportedAnnotations.md +docs/ExportedComment.md +docs/ExportedLabel.md +docs/ExportedLabels.md +docs/ExportedPredictions.md +docs/ExtractionFieldDefinition.md +docs/ExtractionPrediction.md +docs/FetchFromGxStreamRequest.md +docs/FetchFromGxStreamResponse.md +docs/FetchFromStreamRequest.md +docs/FetchFromStreamResponse.md +docs/FieldAnnotationPrivate.md +docs/FieldChoiceApi.md +docs/FieldChoiceNewApi.md +docs/FieldGroupAnnotationPrivate.md +docs/FieldGroupPredictionPrivate.md +docs/FieldGroupSnapshot.md +docs/FieldGroupVersionEntry.md +docs/FieldPredictionPrivate.md +docs/FieldSnapshot.md +docs/FieldType.md +docs/FieldUipathContextModel.md +docs/FieldValuePrivate.md +docs/FieldVersionEntry.md +docs/FilesApi.md +docs/Filter.md +docs/Freshness.md +docs/FullParticipantFilter.md +docs/GeminiTableOnlyConfig.md +docs/GeneralFieldDef.md +docs/GeneralFieldDefNew.md +docs/GeneralFieldDefUpdate.md +docs/GeneralFieldDefinition.md +docs/GetAlertResponse.md +docs/GetAlertSubscriptionsResponse.md +docs/GetAllAlertsResponse.md +docs/GetAllBucketsResponse.md +docs/GetAllDashboardsInDatasetResponse.md +docs/GetAllDashboardsInProjectResponse.md +docs/GetAllDatasetsInProjectResponse.md +docs/GetAllDatasetsResponse.md +docs/GetAllIntegrationsInProjectResponse.md +docs/GetAllIntegrationsResponse.md +docs/GetAllIxpModelsInProjectResponse.md +docs/GetAllIxpProjectsResponse.md +docs/GetAllLabelGroupsResponse.md +docs/GetAllModelsInDatasetRequest.md +docs/GetAllModelsInDatasetResponse.md +docs/GetAllProjectsResponse.md +docs/GetAllProjectsV1Response.md +docs/GetAllSourcesInProjectResponse.md +docs/GetAllSourcesResponse.md +docs/GetAllStreamsResponse.md +docs/GetAllTriggersInDatasetResponse.md +docs/GetBucketByIdResponse.md +docs/GetBucketEmailsRequest.md +docs/GetBucketEmailsResponse.md +docs/GetBucketResponse.md +docs/GetBucketStatisticsResponse.md +docs/GetBucketSyncStateResponse.md +docs/GetBucketsByOwnerResponse.md +docs/GetCommentPredictionsRequest.md +docs/GetCommentPredictionsResponse.md +docs/GetCommentResponse.md +docs/GetComparisonRequest.md +docs/GetComparisonResponse.md +docs/GetDashboardResponse.md +docs/GetDatasetResponse.md +docs/GetDatasetStatisticsRequest.md +docs/GetDatasetStatisticsResponse.md +docs/GetDatasetStatusResponse.md +docs/GetDatasetSummaryRequest.md +docs/GetDatasetSummaryResponse.md +docs/GetDatasetUserPropertiesSummaryResponse.md +docs/GetDeprecatedUserModelsResponse.md +docs/GetDerivedPermissionResponse.md +docs/GetDerivedPermissionsRequest.md +docs/GetDocumentMetadataResponse.md +docs/GetDocumentSearchResponse.md +docs/GetEmailFromBucketByIdResponse.md +docs/GetEmailTransformTagInfoResponse.md +docs/GetFieldGroupHistoryResponse.md +docs/GetFieldHistoryResponse.md +docs/GetIntegrationByIdResponse.md +docs/GetIntegrationErrorsResponse.md +docs/GetIntegrationResponse.md +docs/GetIssueResponse.md +docs/GetIxpConsumabilityInfoResponse.md +docs/GetIxpProjectResponse.md +docs/GetKeyedSyncStateResponse.md +docs/GetLabelDefResponse.md +docs/GetLabelGroupResponse.md +docs/GetLabelValidationRequest.md +docs/GetLabelValidationResponse.md +docs/GetLabellingsResponse.md +docs/GetModelTagsResponse.md +docs/GetPageSelectionsResponse.md +docs/GetPretrainedLabelsResponse.md +docs/GetProjectResourceCountsResponse.md +docs/GetProjectResponse.md +docs/GetQualifiedLoginUrlRequest.md +docs/GetQualifiedLoginUrlResponse.md +docs/GetQuotasForTenantResponse.md +docs/GetReducedPermissionsRequest.md +docs/GetReducedPermissionsResponse.md +docs/GetReducedPermissionsResponsePermissionsInner.md +docs/GetSourceByIdResponse.md +docs/GetSourceCommentsResponse.md +docs/GetSourceCommentsResponseThreadPropertiesInner.md +docs/GetSourceResponse.md +docs/GetSourceStatisticsRequest.md +docs/GetSourceStatisticsResponse.md +docs/GetStreamByNameResponse.md +docs/GetStreamResultsResponse.md +docs/GetSubdomainResponse.md +docs/GetTenantClientSubnetsResponse.md +docs/GetTenantDefaultProjectPermissionsResponse.md +docs/GetTenantDomainsResponse.md +docs/GetTenantEntityDefIdsResponse.md +docs/GetTenantQuotaResponse.md +docs/GetTenantsResponse.md +docs/GetThemesResponse.md +docs/GetThreadThemesRequest.md +docs/GetThreadThemesResponse.md +docs/GetThreadsBySourceResponse.md +docs/GetTrainingActionsCommentUidsResponse.md +docs/GetTrainingActionsLabelsResponse.md +docs/GetTrainingActionsLabelsResponseTrainingActionsLabelsInner.md +docs/GetTriggerResponse.md +docs/GetUserByIdResponse.md +docs/GetUsersResponse.md +docs/GetUsersV1Response.md +docs/GetValidationResponse.md +docs/GetValidationV1Response.md +docs/GlobalPermission.md +docs/GptIxpFlag.md +docs/GptIxpModelConfig.md +docs/GptModelVersion.md +docs/GraphApiModel.md +docs/GraphApiModelKind.md +docs/GroupLabellingsRequest.md +docs/GroupPredictions.md +docs/Headers.md +docs/Highlight.md +docs/HistogramBin.md +docs/ImageInputConfig.md +docs/ImportTaxonomyRequest.md +docs/ImportTaxonomyResponse.md +docs/InferenceStats.md +docs/InheritsFrom.md +docs/InputConfig.md +docs/Integration.md +docs/IntegrationDisabledReason.md +docs/IntegrationError.md +docs/IntegrationErrorDetails.md +docs/IntegrationNew.md +docs/IntegrationType.md +docs/IntegrationUpdate.md +docs/IntegrationsApi.md +docs/IntegrationsOAuth2AuthenticateResponse.md +docs/IntentThreshold.md +docs/IntentValidation.md +docs/IntentValidationSummary.md +docs/IntentsValue.md +docs/InterpretationSpan.md +docs/Issue.md +docs/IssueDetail.md +docs/IssueStatus.md +docs/IterativeConfig.md +docs/IxpConfidence.md +docs/IxpDatasetNew.md +docs/IxpDatasetsApi.md +docs/IxpExtractionStatus.md +docs/IxpField.md +docs/IxpFieldGroup.md +docs/IxpFieldType.md +docs/IxpModelMetadata.md +docs/IxpModelsApi.md +docs/IxpPredictExtractionsResponse.md +docs/IxpProject.md +docs/IxpProjectsApi.md +docs/IxpRelativeUrls.md +docs/IxpTaxonomy.md +docs/IxpTaxonomyExtraction.md +docs/IxpUploadDocumentResponse.md +docs/IxpUploadedDocument.md +docs/KeyedFolderSyncState.md +docs/KeyedFolderSyncStateUpdate.md +docs/KeyedMailboxSyncState.md +docs/KeyedMailboxSyncStateUpdate.md +docs/KeyedSyncState.md +docs/KeyedSyncState1.md +docs/Label.md +docs/LabelAction.md +docs/LabelCollection.md +docs/LabelComparison.md +docs/LabelCounts.md +docs/LabelDef.md +docs/LabelDefFlag.md +docs/LabelDefNew.md +docs/LabelDefProperty.md +docs/LabelDefUpdate.md +docs/LabelDefUpdateMoonFormInner.md +docs/LabelDefUpdateRequest.md +docs/LabelDefinition.md +docs/LabelDefsApi.md +docs/LabelGroup.md +docs/LabelGroupNew.md +docs/LabelGroupsApi.md +docs/LabelHealth.md +docs/LabelHealthAction.md +docs/LabelHealthSmart.md +docs/LabelHealthWarning.md +docs/LabelMetrics.md +docs/LabelNameOnlyResponse.md +docs/LabelPropertiesDigest.md +docs/LabelProperty.md +docs/LabelPropertyDigest.md +docs/LabelPropertyId.md +docs/LabelPropertyName.md +docs/LabelPropertySummary.md +docs/LabelPropertySummaryLabel.md +docs/LabelPropertyTimeSeriesRow.md +docs/LabelSentiment.md +docs/LabelSuggestionReasoning.md +docs/LabelSummaryV1.md +docs/LabelTimeseriesEntry.md +docs/LabelTrainingAction.md +docs/LabelValidationSummary.md +docs/LabellingGroup.md +docs/Language.md +docs/LegacyEntityPatternApi.md +docs/ListKeyedSyncStatesResponse.md +docs/ListKeyedSyncStatesResponseKeyedSyncStatesInner.md +docs/Locales.md +docs/LocalesPreferences.md +docs/LowerBoundBucketCount.md +docs/MarkupBreak.md +docs/MarkupBreakKind.md +docs/MarkupImage.md +docs/MarkupLink.md +docs/MarkupList.md +docs/MarkupListItem.md +docs/MarkupListKind.md +docs/MarkupParagraph.md +docs/MarkupParagraphKind.md +docs/MarkupStyle.md +docs/MarkupStyleKind.md +docs/MarkupTable.md +docs/MarkupTableCaption.md +docs/MarkupTableCell.md +docs/MarkupTableCellChildrenInner.md +docs/MarkupTableCellKind.md +docs/MarkupTableRow.md +docs/MarkupTableSectionKind.md +docs/MarkupText.md +docs/MatchedFieldGroupExtractions.md +docs/MeanPrCurve.md +docs/Message.md +docs/MessageFilter.md +docs/MessageRichText.md +docs/MessageRichTextTextMarkupInner.md +docs/MessageSpan.md +docs/MessageText.md +docs/Metadata.md +docs/MetadataApi.md +docs/MicrosoftApi.md +docs/ModelConfig.md +docs/ModelDefinition.md +docs/ModelError.md +docs/ModelErrorKind.md +docs/ModelFamily.md +docs/ModelFamilyApi.md +docs/ModelName.md +docs/ModelRating.md +docs/ModelRatingAction.md +docs/ModelRatingFactor.md +docs/ModelRatingFactorKind.md +docs/ModelTaxonomy.md +docs/ModelsApi.md +docs/MonetaryFieldDataPrivate.md +docs/MonetaryQuantityFieldDataType.md +docs/MoonFormCaptureFieldsAnnotation.md +docs/MoonFormCaptureFieldsAnnotationNew.md +docs/MoonFormCaptureFieldsPrediction.md +docs/MoonFormDismissedUpdate.md +docs/MoonFormFieldAnnotation.md +docs/MoonFormFieldAnnotationNew.md +docs/MoonFormFieldDef.md +docs/MoonFormFieldDefNew.md +docs/MoonFormFieldDefUpdate.md +docs/MoonFormFieldPrediction.md +docs/MoonFormGroup.md +docs/MoonFormGroupUpdate.md +docs/MoonFormLabelAnnotation.md +docs/MoonFormLabelAnnotationUpdate.md +docs/MoonFormLabelPrediction.md +docs/MoonIntentFieldsMetrics.md +docs/MoonIntentValidationRequest.md +docs/MoonSummaryMetrics.md +docs/MoonValidation.md +docs/Name.md +docs/NewDashboard.md +docs/NoUiMetadataReason.md +docs/NpsSummary.md +docs/NtlmApplicationModel.md +docs/NtlmApplicationModelKind.md +docs/NullableStringArrayFilter.md +docs/NumberFieldDataType.md +docs/NumberOneOfFilter.md +docs/NumberRangeFilter.md +docs/NumberRangeFilterWithKind.md +docs/NumberUserPropertySummary.md +docs/OAuth2SalesforceCallbackRequest.md +docs/OAuth2SalesforceCallbackResponse.md +docs/OptimalThreshold.md +docs/Order.md +docs/PageDimensions.md +docs/PageMetadata.md +docs/PagePolygon.md +docs/PageSelection.md +docs/ParseEmailNewComment.md +docs/ParsedValue.md +docs/Period.md +docs/PermissionsApi.md +docs/PinModelResponse.md +docs/PollTriggerRequest.md +docs/PollTriggerResponse.md +docs/PrCurve.md +docs/PredictDocument.md +docs/PredictExtractionsRequest.md +docs/PredictExtractionsResponse.md +docs/PredictLatestRequest.md +docs/PredictLatestResponse.md +docs/PredictRawEmailsRequest.md +docs/PredictRawEmailsResponse.md +docs/PredictRequest.md +docs/PredictResponse.md +docs/PredictedEntity.md +docs/PredictedLabel.md +docs/PredictedLabelProperty.md +docs/PredictionsModel.md +docs/Preference.md +docs/PreferredLocale.md +docs/PreviewAlertRequest.md +docs/PreviewAlertResponse.md +docs/PrivateKeyApplicationModel.md +docs/PrivateKeyApplicationModelKind.md +docs/Process.md +docs/Project.md +docs/ProjectNew.md +docs/ProjectPermission.md +docs/ProjectSetupExistingSource.md +docs/ProjectSetupNewDataset.md +docs/ProjectSetupNewProject.md +docs/ProjectSetupNewSource.md +docs/ProjectSetupNewStream.md +docs/ProjectSetupNewUsers.md +docs/ProjectV1.md +docs/ProjectsApi.md +docs/PutCommentAsSeenRequest.md +docs/PutCommentAsSeenResponse.md +docs/QueryAuditEventsFilter.md +docs/QueryAuditEventsRequest.md +docs/QueryAuditEventsResponse.md +docs/QueryCommentsOrderAnyLabel.md +docs/QueryCommentsOrderAttachmentTextSearch.md +docs/QueryCommentsOrderByLabel.md +docs/QueryCommentsOrderCheck.md +docs/QueryCommentsOrderDiagnostic.md +docs/QueryCommentsOrderLabelProperty.md +docs/QueryCommentsOrderLearning.md +docs/QueryCommentsOrderMissed.md +docs/QueryCommentsOrderRecent.md +docs/QueryCommentsOrderSample.md +docs/QueryCommentsOrderTextSearch.md +docs/QueryCommentsRequest.md +docs/QueryCommentsResponse.md +docs/QueryDatasetUserPropertyValuesFilter.md +docs/QueryDatasetUserPropertyValuesRequest.md +docs/QueryDatasetUserPropertyValuesResponse.md +docs/QueryIssuesRequest.md +docs/QueryIssuesResponse.md +docs/QueryKeyedSyncStateIdsRequest.md +docs/QueryKeyedSyncStateIdsResponse.md +docs/QueryResultCounts.md +docs/Quota.md +docs/QuotaKind.md +docs/QuotasApi.md +docs/RawEmail.md +docs/RawEmailBody.md +docs/RawEmailDocument.md +docs/RawEmailHeadersParsed.md +docs/RawEmailHeadersRaw.md +docs/Regex.md +docs/RemoveSupportTenantRequest.md +docs/RemoveSupportTenantResponse.md +docs/ReportsApi.md +docs/ResetAnnotationsToPreviousPinnedModelRequest.md +docs/ResetAnnotationsToPreviousPinnedModelResponse.md +docs/ResetStreamRequest.md +docs/ResetStreamResponse.md +docs/ResetTenantQuotaResponse.md +docs/ResetTriggerRequest.md +docs/ResetTriggerResponse.md +docs/ResponseStatusError.md +docs/RetrievalMethod.md +docs/ReviewableBlock.md +docs/ReviewableBlockGroup.md +docs/Reviewed.md +docs/ReviewedFilterRule.md +docs/RichDiagnosticKind.md +docs/SearchApi.md +docs/SendWelcomeEmailResponse.md +docs/Sentiment.md +docs/SetCommentAudioResponse.md +docs/SetQuotaForTenantRequest.md +docs/SetQuotaForTenantResponse.md +docs/SetTenantQuotaRequest.md +docs/SetTenantQuotaResponse.md +docs/SetTenantStateRequest.md +docs/SetTenantStateResponse.md +docs/Significance.md +docs/SignificanceValue.md +docs/SingleLabelSummary.md +docs/SingleTenantsResponse.md +docs/SniffCsvResponse.md +docs/Source.md +docs/Source1.md +docs/SourceCounts.md +docs/SourceCountsSettings.md +docs/SourceKind.md +docs/SourceStatistics.md +docs/SourceUpdate.md +docs/SourcesApi.md +docs/Span.md +docs/Statistics.md +docs/StoreBucketSyncStateRequest.md +docs/StoreBucketSyncStateResponse.md +docs/StoreExceptionRequest.md +docs/StoreExceptionResponse.md +docs/StoreKeyedSyncStateRequest.md +docs/StoreKeyedSyncStateResponse.md +docs/StreamCommentExtractionsResult.md +docs/StreamCommentPrediction.md +docs/StreamCommentResult.md +docs/StreamConfidence.md +docs/StreamExtractionFieldPrediction.md +docs/StreamFieldValue.md +docs/StreamGeneralFieldPrediction.md +docs/StreamLabelPrediction.md +docs/StreamResult.md +docs/StreamScorePrediction.md +docs/StreamTaxonomyPrediction.md +docs/StreamTextSpan.md +docs/StreamsApi.md +docs/StringAnyOfFilter.md +docs/StringArrayFilter.md +docs/StringNoneOfFilter.md +docs/StringOneOfFilter.md +docs/StringSearchFilter.md +docs/StringUserPropertyCount.md +docs/StringUserPropertyCountSingle.md +docs/StringUserPropertyCountsSettings.md +docs/StringUserPropertySummary.md +docs/SuggestTaxonomyRequest.md +docs/SuggestTaxonomyResponse.md +docs/SuggestedLabel.md +docs/SuggestedTaxonomy.md +docs/SyncAnnotationsRequest.md +docs/SyncAnnotationsResponse.md +docs/SyncCommentsFromCsvResponse.md +docs/SyncCommentsRequest.md +docs/SyncCommentsResponse.md +docs/SyncRawEmailsRequest.md +docs/SyncRawEmailsResponse.md +docs/SyncStatus.md +docs/TaggedIxpModelVersion.md +docs/TaggedUserModelVersion.md +docs/TaggedUserModelVersionName.md +docs/TaggedUserModelVersionUpdate.md +docs/TaxonomyExtractionPrivate.md +docs/Tenant.md +docs/TenantNew.md +docs/TenantUpdate.md +docs/TenantsApi.md +docs/TextConfig.md +docs/TextFieldDataPrivate.md +docs/TextFieldDataType.md +docs/TextFieldFlag.md +docs/TextFormat.md +docs/TextImageInputConfig.md +docs/TextSpan.md +docs/Theme.md +docs/ThemeComment.md +docs/ThemeCommentInterpretation.md +docs/ThemeSet.md +docs/ThemesApi.md +docs/ThreadHistogramBinningCustom.md +docs/ThreadHistogramBinningCustomContainer.md +docs/ThreadHistogramBinningFixed.md +docs/ThreadHistogramBinningFixedContainer.md +docs/ThreadHistogramBinningVariable.md +docs/ThreadHistogramBinningVariableContainer.md +docs/ThreadHistogramCounts.md +docs/ThreadHistogramCountsByProperty.md +docs/ThreadHistogramSettings.md +docs/ThreadHistogramSettingsByProperty.md +docs/ThreadProperties.md +docs/ThreadPropertyFilter.md +docs/ThreadTheme.md +docs/ThreadThemesApi.md +docs/Threshold.md +docs/Threshold1.md +docs/ThresholdEnum.md +docs/TimePeriodComparison.md +docs/TimeResolution.md +docs/TimestampRangeFilter.md +docs/TrainView.md +docs/TrainingAction.md +docs/TrainingActionCompleteness.md +docs/Translation.md +docs/Trigger.md +docs/TriggerException.md +docs/TriggerExceptionsSummary.md +docs/TriggerLabelThreshold.md +docs/TriggerNew.md +docs/TriggerUpdate.md +docs/TriggerUserModel.md +docs/TriggersApi.md +docs/Ui.md +docs/UiAnnotationMetadata.md +docs/UiPathCvTableOnlyConfig.md +docs/UiPathProvisionCreateProperties.md +docs/UiPathProvisionCreateRequest.md +docs/UiPathProvisionCreateResponse.md +docs/UiPathProvisionDeleteRequest.md +docs/UiPathProvisionDeleteResponse.md +docs/UiPathProvisionRestoreRequest.md +docs/UiPathProvisionRestoreResponse.md +docs/UiPathProvisionUpdateProperties.md +docs/UiPathProvisionUpdateRequest.md +docs/UiPathProvisionUpdateResponse.md +docs/UiPathTenantServiceStatus.md +docs/UipathProvisioningApi.md +docs/UnaryLabelHealthAction.md +docs/UnaryLabelHealthActionKind.md +docs/UnaryLabelHealthWarning.md +docs/UnaryLabelHealthWarningKind.md +docs/UninformativeLabel.md +docs/UninformativeMode.md +docs/UnpinModelResponse.md +docs/UpdateAlertRequest.md +docs/UpdateAlertResponse.md +docs/UpdateApplianceConfigResponse.md +docs/UpdateBucketRequest.md +docs/UpdateBucketResponse.md +docs/UpdateCommentLabellingRequest.md +docs/UpdateCommentLabellingResponse.md +docs/UpdateDashboardRequest.md +docs/UpdateDashboardResponse.md +docs/UpdateDatasetRequest.md +docs/UpdateDatasetResponse.md +docs/UpdateIntegrationRequest.md +docs/UpdateIntegrationResponse.md +docs/UpdateIssueStatusRequest.md +docs/UpdateIssueStatusResponse.md +docs/UpdateLabelDefResponse.md +docs/UpdateModelRequest.md +docs/UpdateModelResponse.md +docs/UpdateModelTagRequest.md +docs/UpdateModelTagResponse.md +docs/UpdateProjectRequest.md +docs/UpdateProjectResponse.md +docs/UpdateSourceRequest.md +docs/UpdateSourceResponse.md +docs/UpdateTenantClientSubnetsRequest.md +docs/UpdateTenantClientSubnetsResponse.md +docs/UpdateTenantDefaultProjectPermissionsRequest.md +docs/UpdateTenantDefaultProjectPermissionsResponse.md +docs/UpdateTenantDomainsRequest.md +docs/UpdateTenantDomainsResponse.md +docs/UpdateTenantEntityDefIdsRequest.md +docs/UpdateTenantEntityDefIdsResponse.md +docs/UpdateTenantRequest.md +docs/UpdateTenantResponse.md +docs/UpdateTriggerRequest.md +docs/UpdateTriggerResponse.md +docs/UpdateUserRequest.md +docs/UpdateUserResponse.md +docs/UploadAttachmentResponse.md +docs/UploadDocumentResponse.md +docs/UploadFilesResponse.md +docs/User.md +docs/UserAccessModel.md +docs/UserAccessModelKind.md +docs/UserLicense.md +docs/UserLicenseCheck.md +docs/UserModel.md +docs/UserModelMetadata.md +docs/UserModelMetadataFlag.md +docs/UserModelMetadataSettings.md +docs/UserNew.md +docs/UserPropertiesSummary.md +docs/UserPropertiesValue.md +docs/UserUpdate.md +docs/UserV1.md +docs/UserWithLicenseCheck.md +docs/UsersApi.md +docs/ValidateExchangeCredentialsRequest.md +docs/ValidateExchangeCredentialsResponse.md +docs/ValidationSummary.md +docs/ValidationSummaryV1.md +docs/VariationKind.md +docs/Vertex.md +git_push.sh +src/apis/alerts_api.rs +src/apis/analytics_api.rs +src/apis/appliance_configs_api.rs +src/apis/attachments_api.rs +src/apis/audit_events_api.rs +src/apis/buckets_api.rs +src/apis/comments_api.rs +src/apis/configuration.rs +src/apis/conversational_filter_api.rs +src/apis/dashboards_api.rs +src/apis/datasets_api.rs +src/apis/deployment_api.rs +src/apis/deprecation_api.rs +src/apis/discover_api.rs +src/apis/documents_api.rs +src/apis/emails_api.rs +src/apis/files_api.rs +src/apis/integrations_api.rs +src/apis/ixp_datasets_api.rs +src/apis/ixp_models_api.rs +src/apis/ixp_projects_api.rs +src/apis/label_defs_api.rs +src/apis/label_groups_api.rs +src/apis/metadata_api.rs +src/apis/mod.rs +src/apis/model_family_api.rs +src/apis/models_api.rs +src/apis/permissions_api.rs +src/apis/projects_api.rs +src/apis/quotas_api.rs +src/apis/reports_api.rs +src/apis/search_api.rs +src/apis/sources_api.rs +src/apis/streams_api.rs +src/apis/tenants_api.rs +src/apis/themes_api.rs +src/apis/thread_themes_api.rs +src/apis/triggers_api.rs +src/apis/uipath_provisioning_api.rs +src/apis/users_api.rs +src/lib.rs +src/models/_audit_events_dataset.rs +src/models/_audit_events_project.rs +src/models/_audit_events_source.rs +src/models/_audit_events_tenant.rs +src/models/_audit_events_trigger.rs +src/models/_audit_events_user.rs +src/models/_bucket_statistics.rs +src/models/_by_labels_include_container.rs +src/models/_by_labels_top_container.rs +src/models/_dataset_string_summary_value.rs +src/models/_dataset_user_properties_summary_number.rs +src/models/_dataset_user_properties_summary_string.rs +src/models/_entity_summary_v1.rs +src/models/_exact_bucket_count.rs +src/models/_label_summary_v1.rs +src/models/_lower_bound_bucket_count.rs +src/models/_query_comments_order_any_label.rs +src/models/_query_comments_order_attachment_text_search.rs +src/models/_query_comments_order_by_label.rs +src/models/_query_comments_order_check.rs +src/models/_query_comments_order_diagnostic.rs +src/models/_query_comments_order_label_property.rs +src/models/_query_comments_order_learning.rs +src/models/_query_comments_order_missed.rs +src/models/_query_comments_order_recent.rs +src/models/_query_comments_order_sample.rs +src/models/_query_comments_order_text_search.rs +src/models/_query_dataset_user_property_values_filter.rs +src/models/_raw_email_body.rs +src/models/_raw_email_headers_parsed.rs +src/models/_raw_email_headers_raw.rs +src/models/_source_statistics.rs +src/models/_thread_histogram_binning_custom_container.rs +src/models/_thread_histogram_binning_fixed_container.rs +src/models/_thread_histogram_binning_variable_container.rs +src/models/access.rs +src/models/add_comments_request.rs +src/models/add_comments_response.rs +src/models/add_emails_to_bucket_request.rs +src/models/add_emails_to_bucket_response.rs +src/models/add_support_tenant_request.rs +src/models/add_support_tenant_response.rs +src/models/advance_stream_request.rs +src/models/advance_stream_response.rs +src/models/advance_trigger_request.rs +src/models/advance_trigger_response.rs +src/models/alert.rs +src/models/alert_config.rs +src/models/alert_config_kind.rs +src/models/alert_filter.rs +src/models/alert_issues_response.rs +src/models/alert_metric.rs +src/models/alert_new.rs +src/models/alert_process_threshold.rs +src/models/alert_process_variation.rs +src/models/alert_subscription.rs +src/models/alert_update.rs +src/models/amount_field_data_private.rs +src/models/annotated_comment.rs +src/models/annotation.rs +src/models/annotation_label.rs +src/models/annotation_metadata.rs +src/models/annotation_metadata_count.rs +src/models/annotations.rs +src/models/app_access_model.rs +src/models/app_access_model_kind.rs +src/models/application.rs +src/models/assigned_predicted_present_filter.rs +src/models/assignment_method.rs +src/models/attachment.rs +src/models/attribute.rs +src/models/attribute_filter.rs +src/models/attribute_filter_attribute.rs +src/models/attribution_method.rs +src/models/audit_event.rs +src/models/binary_label_health_action.rs +src/models/binary_label_health_action_kind.rs +src/models/binary_label_health_warning.rs +src/models/binary_label_health_warning_kind.rs +src/models/binning.rs +src/models/bool_field_data_private.rs +src/models/bool_field_data_type.rs +src/models/breakdown.rs +src/models/bucket.rs +src/models/bucket_new.rs +src/models/bucket_sync_state.rs +src/models/bucket_update.rs +src/models/bucket_updated_by.rs +src/models/builtin_label_def.rs +src/models/builtin_label_def_name.rs +src/models/builtin_label_def_request.rs +src/models/business_rule.rs +src/models/business_rule_comparison_operator.rs +src/models/business_rule_logical_operator.rs +src/models/business_rule_set.rs +src/models/business_rule_set_criticality.rs +src/models/business_rule_type.rs +src/models/by_labels.rs +src/models/by_labels_include.rs +src/models/by_labels_top.rs +src/models/capture_threshold.rs +src/models/choice_field_data_private.rs +src/models/choice_field_data_type.rs +src/models/client_secret_application_model.rs +src/models/client_secret_application_model_kind.rs +src/models/cm_model_config.rs +src/models/comment.rs +src/models/comment_extractions_predictions.rs +src/models/comment_filter.rs +src/models/comment_new.rs +src/models/comment_prediction.rs +src/models/comment_sentiment.rs +src/models/comment_span_new_char.rs +src/models/comment_span_new_utf16.rs +src/models/comment_thread.rs +src/models/comparison.rs +src/models/connection_model.rs +src/models/content_part.rs +src/models/contribution.rs +src/models/contributor.rs +src/models/contributor_kind.rs +src/models/conversational_filter_request.rs +src/models/conversational_filter_response.rs +src/models/coocurrence.rs +src/models/coocurrence_labels.rs +src/models/count.rs +src/models/create_alert_request.rs +src/models/create_alert_response.rs +src/models/create_bucket_request.rs +src/models/create_bucket_response.rs +src/models/create_dashboard_request.rs +src/models/create_dashboard_response.rs +src/models/create_dataset_request.rs +src/models/create_dataset_response.rs +src/models/create_integration_request.rs +src/models/create_integration_response.rs +src/models/create_ixp_dataset_request.rs +src/models/create_ixp_dataset_response.rs +src/models/create_label_defs_bulk_response.rs +src/models/create_label_group_request.rs +src/models/create_label_group_response.rs +src/models/create_or_update_label_defs_bulk_request.rs +src/models/create_or_update_label_defs_bulk_request_label_defs_inner.rs +src/models/create_page_view_request.rs +src/models/create_page_view_response.rs +src/models/create_project_request.rs +src/models/create_project_response.rs +src/models/create_project_setup_created_response.rs +src/models/create_project_setup_request.rs +src/models/create_project_setup_response.rs +src/models/create_source_request.rs +src/models/create_source_response.rs +src/models/create_stream_request.rs +src/models/create_stream_response.rs +src/models/create_tenant_request.rs +src/models/create_tenant_response.rs +src/models/create_trigger_request.rs +src/models/create_trigger_response.rs +src/models/create_user_request.rs +src/models/create_user_response.rs +src/models/custom_action.rs +src/models/custom_training_action.rs +src/models/dashboard.rs +src/models/dashboard_update.rs +src/models/data.rs +src/models/data_type.rs +src/models/data_type_date.rs +src/models/data_type_money.rs +src/models/data_type_number.rs +src/models/data_type_text.rs +src/models/dataset.rs +src/models/dataset_flag.rs +src/models/dataset_new.rs +src/models/dataset_operation.rs +src/models/dataset_quality.rs +src/models/dataset_status.rs +src/models/dataset_summary.rs +src/models/dataset_training_action.rs +src/models/dataset_update.rs +src/models/dataset_update_entity_defs_inner.rs +src/models/dataset_user_properties_summary.rs +src/models/date_field_data_private.rs +src/models/date_field_data_type.rs +src/models/delete_alert_response.rs +src/models/delete_alert_subscription_reponse.rs +src/models/delete_bucket_response.rs +src/models/delete_comment_response.rs +src/models/delete_dashboard_response.rs +src/models/delete_dataset_by_id_response.rs +src/models/delete_dataset_response.rs +src/models/delete_integration_response.rs +src/models/delete_ixp_dataset_response.rs +src/models/delete_keyed_sync_state_response.rs +src/models/delete_label_def_response.rs +src/models/delete_label_group_response.rs +src/models/delete_model_tag_response.rs +src/models/delete_project_response.rs +src/models/delete_source_response.rs +src/models/delete_stream_exception_response.rs +src/models/delete_stream_response.rs +src/models/delete_tenant_default_project_permissions_response.rs +src/models/delete_tenant_response.rs +src/models/delete_trigger_response.rs +src/models/delete_user_response.rs +src/models/deprecated_user_model_metadata.rs +src/models/diagnostic.rs +src/models/diagnostic_kind.rs +src/models/direction.rs +src/models/disable_integration_action.rs +src/models/disable_mailbox_action.rs +src/models/doc_path_ixp_model_config.rs +src/models/document_label_property_prediction.rs +src/models/document_search_result.rs +src/models/document_span.rs +src/models/email.rs +src/models/email_metadata.rs +src/models/email_metadata_new.rs +src/models/email_new.rs +src/models/email_properties_summary.rs +src/models/email_properties_summary_by_property.rs +src/models/email_properties_summary_value.rs +src/models/email_property_counts.rs +src/models/email_property_counts_by_property.rs +src/models/email_property_counts_settings.rs +src/models/email_property_counts_settings_by_property.rs +src/models/email_transform_tag_info.rs +src/models/entities.rs +src/models/entities_new.rs +src/models/entities_pr_stats.rs +src/models/entities_rules.rs +src/models/entities_rules_presence_inner.rs +src/models/entity.rs +src/models/entity_average_stats.rs +src/models/entity_def.rs +src/models/entity_def_flag.rs +src/models/entity_def_id_stat.rs +src/models/entity_def_new.rs +src/models/entity_def_summary.rs +src/models/entity_def_update.rs +src/models/entity_def_update_inherits_from_inner.rs +src/models/entity_health.rs +src/models/entity_health_action.rs +src/models/entity_health_action_kind.rs +src/models/entity_health_smart.rs +src/models/entity_health_warning.rs +src/models/entity_health_warning_kind.rs +src/models/entity_kind.rs +src/models/entity_new.rs +src/models/entity_new_spans_inner.rs +src/models/entity_presence_filter.rs +src/models/entity_presence_filter_with_kind.rs +src/models/entity_rule_set_api.rs +src/models/entity_rule_set_new_api.rs +src/models/entity_rule_set_update_api.rs +src/models/entity_rule_set_update_api_choices_inner.rs +src/models/entity_template_properties_api.rs +src/models/entity_templates_properties_api.rs +src/models/error_action.rs +src/models/error_response.rs +src/models/ews_api_model.rs +src/models/ews_api_model_kind.rs +src/models/exception_model.rs +src/models/export_dataset_request.rs +src/models/export_dataset_response.rs +src/models/exported_annotations.rs +src/models/exported_comment.rs +src/models/exported_label.rs +src/models/exported_labels.rs +src/models/exported_predictions.rs +src/models/extraction_field_definition.rs +src/models/extraction_prediction.rs +src/models/fetch_from_gx_stream_request.rs +src/models/fetch_from_gx_stream_response.rs +src/models/fetch_from_stream_request.rs +src/models/fetch_from_stream_response.rs +src/models/field_annotation_private.rs +src/models/field_choice_api.rs +src/models/field_choice_new_api.rs +src/models/field_group_annotation_private.rs +src/models/field_group_prediction_private.rs +src/models/field_group_snapshot.rs +src/models/field_group_version_entry.rs +src/models/field_prediction_private.rs +src/models/field_snapshot.rs +src/models/field_type.rs +src/models/field_uipath_context_model.rs +src/models/field_value_private.rs +src/models/field_version_entry.rs +src/models/filter.rs +src/models/freshness.rs +src/models/full_participant_filter.rs +src/models/gemini_table_only_config.rs +src/models/general_field_def.rs +src/models/general_field_def_new.rs +src/models/general_field_def_update.rs +src/models/general_field_definition.rs +src/models/get_alert_response.rs +src/models/get_alert_subscriptions_response.rs +src/models/get_all_alerts_response.rs +src/models/get_all_buckets_response.rs +src/models/get_all_dashboards_in_dataset_response.rs +src/models/get_all_dashboards_in_project_response.rs +src/models/get_all_datasets_in_project_response.rs +src/models/get_all_datasets_response.rs +src/models/get_all_integrations_in_project_response.rs +src/models/get_all_integrations_response.rs +src/models/get_all_ixp_models_in_project_response.rs +src/models/get_all_ixp_projects_response.rs +src/models/get_all_label_groups_response.rs +src/models/get_all_models_in_dataset_request.rs +src/models/get_all_models_in_dataset_response.rs +src/models/get_all_projects_response.rs +src/models/get_all_projects_v1_response.rs +src/models/get_all_sources_in_project_response.rs +src/models/get_all_sources_response.rs +src/models/get_all_streams_response.rs +src/models/get_all_triggers_in_dataset_response.rs +src/models/get_bucket_by_id_response.rs +src/models/get_bucket_emails_request.rs +src/models/get_bucket_emails_response.rs +src/models/get_bucket_response.rs +src/models/get_bucket_statistics_response.rs +src/models/get_bucket_sync_state_response.rs +src/models/get_buckets_by_owner_response.rs +src/models/get_comment_predictions_request.rs +src/models/get_comment_predictions_response.rs +src/models/get_comment_response.rs +src/models/get_comparison_request.rs +src/models/get_comparison_response.rs +src/models/get_dashboard_response.rs +src/models/get_dataset_response.rs +src/models/get_dataset_statistics_request.rs +src/models/get_dataset_statistics_response.rs +src/models/get_dataset_status_response.rs +src/models/get_dataset_summary_request.rs +src/models/get_dataset_summary_response.rs +src/models/get_dataset_user_properties_summary_response.rs +src/models/get_deprecated_user_models_response.rs +src/models/get_derived_permission_response.rs +src/models/get_derived_permissions_request.rs +src/models/get_document_metadata_response.rs +src/models/get_document_search_response.rs +src/models/get_email_from_bucket_by_id_response.rs +src/models/get_email_transform_tag_info_response.rs +src/models/get_field_group_history_response.rs +src/models/get_field_history_response.rs +src/models/get_integration_by_id_response.rs +src/models/get_integration_errors_response.rs +src/models/get_integration_response.rs +src/models/get_issue_response.rs +src/models/get_ixp_consumability_info_response.rs +src/models/get_ixp_project_response.rs +src/models/get_keyed_sync_state_response.rs +src/models/get_label_def_response.rs +src/models/get_label_group_response.rs +src/models/get_label_validation_request.rs +src/models/get_label_validation_response.rs +src/models/get_labellings_response.rs +src/models/get_model_tags_response.rs +src/models/get_page_selections_response.rs +src/models/get_pretrained_labels_response.rs +src/models/get_project_resource_counts_response.rs +src/models/get_project_response.rs +src/models/get_qualified_login_url_request.rs +src/models/get_qualified_login_url_response.rs +src/models/get_quotas_for_tenant_response.rs +src/models/get_reduced_permissions_request.rs +src/models/get_reduced_permissions_response.rs +src/models/get_reduced_permissions_response_permissions_inner.rs +src/models/get_source_by_id_response.rs +src/models/get_source_comments_response.rs +src/models/get_source_comments_response_thread_properties_inner.rs +src/models/get_source_response.rs +src/models/get_source_statistics_request.rs +src/models/get_source_statistics_response.rs +src/models/get_stream_by_name_response.rs +src/models/get_stream_results_response.rs +src/models/get_subdomain_response.rs +src/models/get_tenant_client_subnets_response.rs +src/models/get_tenant_default_project_permissions_response.rs +src/models/get_tenant_domains_response.rs +src/models/get_tenant_entity_def_ids_response.rs +src/models/get_tenant_quota_response.rs +src/models/get_tenants_response.rs +src/models/get_themes_response.rs +src/models/get_thread_themes_request.rs +src/models/get_thread_themes_response.rs +src/models/get_threads_by_source_response.rs +src/models/get_training_actions_comment_uids_response.rs +src/models/get_training_actions_labels_response.rs +src/models/get_training_actions_labels_response_training_actions_labels_inner.rs +src/models/get_trigger_response.rs +src/models/get_user_by_id_response.rs +src/models/get_users_response.rs +src/models/get_users_v1_response.rs +src/models/get_validation_response.rs +src/models/get_validation_v1_response.rs +src/models/global_permission.rs +src/models/gpt_ixp_flag.rs +src/models/gpt_ixp_model_config.rs +src/models/gpt_model_version.rs +src/models/graph_api_model.rs +src/models/graph_api_model_kind.rs +src/models/group_labellings_request.rs +src/models/group_predictions.rs +src/models/headers.rs +src/models/highlight.rs +src/models/histogram_bin.rs +src/models/image_input_config.rs +src/models/import_taxonomy_request.rs +src/models/import_taxonomy_response.rs +src/models/inference_stats.rs +src/models/inherits_from.rs +src/models/input_config.rs +src/models/integration.rs +src/models/integration_disabled_reason.rs +src/models/integration_error.rs +src/models/integration_error_details.rs +src/models/integration_new.rs +src/models/integration_type.rs +src/models/integration_update.rs +src/models/integrations_o_auth2_authenticate_response.rs +src/models/intent_threshold.rs +src/models/intent_validation.rs +src/models/intent_validation_summary.rs +src/models/intents_value.rs +src/models/interpretation_span.rs +src/models/issue.rs +src/models/issue_detail.rs +src/models/issue_status.rs +src/models/iterative_config.rs +src/models/ixp_confidence.rs +src/models/ixp_dataset_new.rs +src/models/ixp_extraction_status.rs +src/models/ixp_field.rs +src/models/ixp_field_group.rs +src/models/ixp_field_type.rs +src/models/ixp_model_metadata.rs +src/models/ixp_predict_extractions_response.rs +src/models/ixp_project.rs +src/models/ixp_relative_urls.rs +src/models/ixp_taxonomy.rs +src/models/ixp_taxonomy_extraction.rs +src/models/ixp_upload_document_response.rs +src/models/ixp_uploaded_document.rs +src/models/keyed_folder_sync_state.rs +src/models/keyed_folder_sync_state_update.rs +src/models/keyed_mailbox_sync_state.rs +src/models/keyed_mailbox_sync_state_update.rs +src/models/keyed_sync_state.rs +src/models/keyed_sync_state_1.rs +src/models/label.rs +src/models/label_action.rs +src/models/label_collection.rs +src/models/label_comparison.rs +src/models/label_counts.rs +src/models/label_def.rs +src/models/label_def_flag.rs +src/models/label_def_new.rs +src/models/label_def_property.rs +src/models/label_def_update.rs +src/models/label_def_update_moon_form_inner.rs +src/models/label_def_update_request.rs +src/models/label_definition.rs +src/models/label_group.rs +src/models/label_group_new.rs +src/models/label_health.rs +src/models/label_health_action.rs +src/models/label_health_smart.rs +src/models/label_health_warning.rs +src/models/label_metrics.rs +src/models/label_name_only_response.rs +src/models/label_properties_digest.rs +src/models/label_property.rs +src/models/label_property_digest.rs +src/models/label_property_id.rs +src/models/label_property_name.rs +src/models/label_property_summary.rs +src/models/label_property_summary_label.rs +src/models/label_property_time_series_row.rs +src/models/label_sentiment.rs +src/models/label_suggestion_reasoning.rs +src/models/label_timeseries_entry.rs +src/models/label_training_action.rs +src/models/label_validation_summary.rs +src/models/labelling_group.rs +src/models/language.rs +src/models/legacy_entity_pattern_api.rs +src/models/list_keyed_sync_states_response.rs +src/models/list_keyed_sync_states_response_keyed_sync_states_inner.rs +src/models/locales.rs +src/models/locales_preferences.rs +src/models/markup_break.rs +src/models/markup_break_kind.rs +src/models/markup_image.rs +src/models/markup_link.rs +src/models/markup_list.rs +src/models/markup_list_item.rs +src/models/markup_list_kind.rs +src/models/markup_paragraph.rs +src/models/markup_paragraph_kind.rs +src/models/markup_style.rs +src/models/markup_style_kind.rs +src/models/markup_table.rs +src/models/markup_table_caption.rs +src/models/markup_table_cell.rs +src/models/markup_table_cell_children_inner.rs +src/models/markup_table_cell_kind.rs +src/models/markup_table_row.rs +src/models/markup_table_section_kind.rs +src/models/markup_text.rs +src/models/matched_field_group_extractions.rs +src/models/mean_pr_curve.rs +src/models/message.rs +src/models/message_filter.rs +src/models/message_rich_text.rs +src/models/message_rich_text_text_markup_inner.rs +src/models/message_span.rs +src/models/message_text.rs +src/models/metadata.rs +src/models/microsoft_api.rs +src/models/mod.rs +src/models/model_config.rs +src/models/model_definition.rs +src/models/model_error.rs +src/models/model_error_kind.rs +src/models/model_family.rs +src/models/model_name.rs +src/models/model_rating.rs +src/models/model_rating_action.rs +src/models/model_rating_factor.rs +src/models/model_rating_factor_kind.rs +src/models/model_taxonomy.rs +src/models/monetary_field_data_private.rs +src/models/monetary_quantity_field_data_type.rs +src/models/moon_form_capture_fields_annotation.rs +src/models/moon_form_capture_fields_annotation_new.rs +src/models/moon_form_capture_fields_prediction.rs +src/models/moon_form_dismissed_update.rs +src/models/moon_form_field_annotation.rs +src/models/moon_form_field_annotation_new.rs +src/models/moon_form_field_def.rs +src/models/moon_form_field_def_new.rs +src/models/moon_form_field_def_update.rs +src/models/moon_form_field_prediction.rs +src/models/moon_form_group.rs +src/models/moon_form_group_update.rs +src/models/moon_form_label_annotation.rs +src/models/moon_form_label_annotation_update.rs +src/models/moon_form_label_prediction.rs +src/models/moon_intent_fields_metrics.rs +src/models/moon_intent_validation_request.rs +src/models/moon_summary_metrics.rs +src/models/moon_validation.rs +src/models/name.rs +src/models/new_dashboard.rs +src/models/no_ui_metadata_reason.rs +src/models/nps_summary.rs +src/models/ntlm_application_model.rs +src/models/ntlm_application_model_kind.rs +src/models/nullable_string_array_filter.rs +src/models/number_field_data_type.rs +src/models/number_one_of_filter.rs +src/models/number_range_filter.rs +src/models/number_range_filter_with_kind.rs +src/models/number_user_property_summary.rs +src/models/o_auth2_salesforce_callback_request.rs +src/models/o_auth2_salesforce_callback_response.rs +src/models/optimal_threshold.rs +src/models/order.rs +src/models/page_dimensions.rs +src/models/page_metadata.rs +src/models/page_polygon.rs +src/models/page_selection.rs +src/models/parse_email_new_comment.rs +src/models/parsed_value.rs +src/models/period.rs +src/models/pin_model_response.rs +src/models/poll_trigger_request.rs +src/models/poll_trigger_response.rs +src/models/pr_curve.rs +src/models/predict_document.rs +src/models/predict_extractions_request.rs +src/models/predict_extractions_response.rs +src/models/predict_latest_request.rs +src/models/predict_latest_response.rs +src/models/predict_raw_emails_request.rs +src/models/predict_raw_emails_response.rs +src/models/predict_request.rs +src/models/predict_response.rs +src/models/predicted_entity.rs +src/models/predicted_label.rs +src/models/predicted_label_property.rs +src/models/predictions_model.rs +src/models/preference.rs +src/models/preferred_locale.rs +src/models/preview_alert_request.rs +src/models/preview_alert_response.rs +src/models/private_key_application_model.rs +src/models/private_key_application_model_kind.rs +src/models/process.rs +src/models/project.rs +src/models/project_new.rs +src/models/project_permission.rs +src/models/project_setup_existing_source.rs +src/models/project_setup_new_dataset.rs +src/models/project_setup_new_project.rs +src/models/project_setup_new_source.rs +src/models/project_setup_new_stream.rs +src/models/project_setup_new_users.rs +src/models/project_v1.rs +src/models/put_comment_as_seen_request.rs +src/models/put_comment_as_seen_response.rs +src/models/query_audit_events_filter.rs +src/models/query_audit_events_request.rs +src/models/query_audit_events_response.rs +src/models/query_comments_request.rs +src/models/query_comments_response.rs +src/models/query_dataset_user_property_values_request.rs +src/models/query_dataset_user_property_values_response.rs +src/models/query_issues_request.rs +src/models/query_issues_response.rs +src/models/query_keyed_sync_state_ids_request.rs +src/models/query_keyed_sync_state_ids_response.rs +src/models/query_result_counts.rs +src/models/quota.rs +src/models/quota_kind.rs +src/models/raw_email.rs +src/models/raw_email_document.rs +src/models/regex.rs +src/models/remove_support_tenant_request.rs +src/models/remove_support_tenant_response.rs +src/models/reset_annotations_to_previous_pinned_model_request.rs +src/models/reset_annotations_to_previous_pinned_model_response.rs +src/models/reset_stream_request.rs +src/models/reset_stream_response.rs +src/models/reset_tenant_quota_response.rs +src/models/reset_trigger_request.rs +src/models/reset_trigger_response.rs +src/models/response_status_error.rs +src/models/retrieval_method.rs +src/models/reviewable_block.rs +src/models/reviewable_block_group.rs +src/models/reviewed.rs +src/models/reviewed_filter_rule.rs +src/models/rich_diagnostic_kind.rs +src/models/send_welcome_email_response.rs +src/models/sentiment.rs +src/models/set_comment_audio_response.rs +src/models/set_quota_for_tenant_request.rs +src/models/set_quota_for_tenant_response.rs +src/models/set_tenant_quota_request.rs +src/models/set_tenant_quota_response.rs +src/models/set_tenant_state_request.rs +src/models/set_tenant_state_response.rs +src/models/significance.rs +src/models/significance_value.rs +src/models/single_label_summary.rs +src/models/single_tenants_response.rs +src/models/sniff_csv_response.rs +src/models/source.rs +src/models/source_1.rs +src/models/source_counts.rs +src/models/source_counts_settings.rs +src/models/source_kind.rs +src/models/source_update.rs +src/models/span.rs +src/models/statistics.rs +src/models/store_bucket_sync_state_request.rs +src/models/store_bucket_sync_state_response.rs +src/models/store_exception_request.rs +src/models/store_exception_response.rs +src/models/store_keyed_sync_state_request.rs +src/models/store_keyed_sync_state_response.rs +src/models/stream_comment_extractions_result.rs +src/models/stream_comment_prediction.rs +src/models/stream_comment_result.rs +src/models/stream_confidence.rs +src/models/stream_extraction_field_prediction.rs +src/models/stream_field_value.rs +src/models/stream_general_field_prediction.rs +src/models/stream_label_prediction.rs +src/models/stream_result.rs +src/models/stream_score_prediction.rs +src/models/stream_taxonomy_prediction.rs +src/models/stream_text_span.rs +src/models/string_any_of_filter.rs +src/models/string_array_filter.rs +src/models/string_none_of_filter.rs +src/models/string_one_of_filter.rs +src/models/string_search_filter.rs +src/models/string_user_property_count.rs +src/models/string_user_property_count_single.rs +src/models/string_user_property_counts_settings.rs +src/models/string_user_property_summary.rs +src/models/suggest_taxonomy_request.rs +src/models/suggest_taxonomy_response.rs +src/models/suggested_label.rs +src/models/suggested_taxonomy.rs +src/models/sync_annotations_request.rs +src/models/sync_annotations_response.rs +src/models/sync_comments_from_csv_response.rs +src/models/sync_comments_request.rs +src/models/sync_comments_response.rs +src/models/sync_raw_emails_request.rs +src/models/sync_raw_emails_response.rs +src/models/sync_status.rs +src/models/tagged_ixp_model_version.rs +src/models/tagged_user_model_version.rs +src/models/tagged_user_model_version_name.rs +src/models/tagged_user_model_version_update.rs +src/models/taxonomy_extraction_private.rs +src/models/tenant.rs +src/models/tenant_new.rs +src/models/tenant_update.rs +src/models/text_config.rs +src/models/text_field_data_private.rs +src/models/text_field_data_type.rs +src/models/text_field_flag.rs +src/models/text_format.rs +src/models/text_image_input_config.rs +src/models/text_span.rs +src/models/theme.rs +src/models/theme_comment.rs +src/models/theme_comment_interpretation.rs +src/models/theme_set.rs +src/models/thread_histogram_binning_custom.rs +src/models/thread_histogram_binning_fixed.rs +src/models/thread_histogram_binning_variable.rs +src/models/thread_histogram_counts.rs +src/models/thread_histogram_counts_by_property.rs +src/models/thread_histogram_settings.rs +src/models/thread_histogram_settings_by_property.rs +src/models/thread_properties.rs +src/models/thread_property_filter.rs +src/models/thread_theme.rs +src/models/threshold.rs +src/models/threshold_1.rs +src/models/threshold_enum.rs +src/models/time_period_comparison.rs +src/models/time_resolution.rs +src/models/timestamp_range_filter.rs +src/models/train_view.rs +src/models/training_action.rs +src/models/training_action_completeness.rs +src/models/translation.rs +src/models/trigger.rs +src/models/trigger_exception.rs +src/models/trigger_exceptions_summary.rs +src/models/trigger_label_threshold.rs +src/models/trigger_new.rs +src/models/trigger_update.rs +src/models/trigger_user_model.rs +src/models/ui.rs +src/models/ui_annotation_metadata.rs +src/models/ui_path_cv_table_only_config.rs +src/models/ui_path_provision_create_properties.rs +src/models/ui_path_provision_create_request.rs +src/models/ui_path_provision_create_response.rs +src/models/ui_path_provision_delete_request.rs +src/models/ui_path_provision_delete_response.rs +src/models/ui_path_provision_restore_request.rs +src/models/ui_path_provision_restore_response.rs +src/models/ui_path_provision_update_properties.rs +src/models/ui_path_provision_update_request.rs +src/models/ui_path_provision_update_response.rs +src/models/ui_path_tenant_service_status.rs +src/models/unary_label_health_action.rs +src/models/unary_label_health_action_kind.rs +src/models/unary_label_health_warning.rs +src/models/unary_label_health_warning_kind.rs +src/models/uninformative_label.rs +src/models/uninformative_mode.rs +src/models/unpin_model_response.rs +src/models/update_alert_request.rs +src/models/update_alert_response.rs +src/models/update_appliance_config_response.rs +src/models/update_bucket_request.rs +src/models/update_bucket_response.rs +src/models/update_comment_labelling_request.rs +src/models/update_comment_labelling_response.rs +src/models/update_dashboard_request.rs +src/models/update_dashboard_response.rs +src/models/update_dataset_request.rs +src/models/update_dataset_response.rs +src/models/update_integration_request.rs +src/models/update_integration_response.rs +src/models/update_issue_status_request.rs +src/models/update_issue_status_response.rs +src/models/update_label_def_response.rs +src/models/update_model_request.rs +src/models/update_model_response.rs +src/models/update_model_tag_request.rs +src/models/update_model_tag_response.rs +src/models/update_project_request.rs +src/models/update_project_response.rs +src/models/update_source_request.rs +src/models/update_source_response.rs +src/models/update_tenant_client_subnets_request.rs +src/models/update_tenant_client_subnets_response.rs +src/models/update_tenant_default_project_permissions_request.rs +src/models/update_tenant_default_project_permissions_response.rs +src/models/update_tenant_domains_request.rs +src/models/update_tenant_domains_response.rs +src/models/update_tenant_entity_def_ids_request.rs +src/models/update_tenant_entity_def_ids_response.rs +src/models/update_tenant_request.rs +src/models/update_tenant_response.rs +src/models/update_trigger_request.rs +src/models/update_trigger_response.rs +src/models/update_user_request.rs +src/models/update_user_response.rs +src/models/upload_attachment_response.rs +src/models/upload_document_response.rs +src/models/upload_files_response.rs +src/models/user.rs +src/models/user_access_model.rs +src/models/user_access_model_kind.rs +src/models/user_license.rs +src/models/user_license_check.rs +src/models/user_model.rs +src/models/user_model_metadata.rs +src/models/user_model_metadata_flag.rs +src/models/user_model_metadata_settings.rs +src/models/user_new.rs +src/models/user_properties_summary.rs +src/models/user_properties_value.rs +src/models/user_update.rs +src/models/user_v1.rs +src/models/user_with_license_check.rs +src/models/validate_exchange_credentials_request.rs +src/models/validate_exchange_credentials_response.rs +src/models/validation_summary.rs +src/models/validation_summary_v1.rs +src/models/variation_kind.rs +src/models/vertex.rs diff --git a/api/.openapi-generator/VERSION b/api/.openapi-generator/VERSION new file mode 100644 index 00000000..09a6d308 --- /dev/null +++ b/api/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.8.0 diff --git a/api/.travis.yml b/api/.travis.yml new file mode 100644 index 00000000..22761ba7 --- /dev/null +++ b/api/.travis.yml @@ -0,0 +1 @@ +language: rust diff --git a/api/Cargo.toml b/api/Cargo.toml index e14527aa..14970b62 100644 --- a/api/Cargo.toml +++ b/api/Cargo.toml @@ -1,30 +1,17 @@ [package] -name = "reinfer-client" -version = "0.38.10" -description = "API client for Re:infer, the conversational data intelligence platform" -homepage = "https://github.com/reinfer/cli" -readme = "README.md" -authors = ["reinfer Ltd. "] -license = "Apache-2.0" +name = "openapi" +version = "0.1.0" +authors = ["OpenAPI Generator team and contributors"] +description = "# Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. " +# Override this license by providing a License Object in the OpenAPI. +license = "Unlicense" edition = "2021" -[lib] -name = "reinfer_client" - [dependencies] -chrono = { version = "0.4.22", features = ["serde"] } -http = "0.2.9" -log = "0.4.17" -matches = "0.1.10" -once_cell = "1.16.0" -ordered-float = { version = "3.9.1", features = ["serde"] } -regex = "1.6.0" -reqwest = { version = "0.11.12", default-features = false, features = ["blocking", "gzip", "json", "multipart", "native-tls-vendored"] } -serde = { version = "1.0.147", features = ["derive"] } -serde_json = "1.0.87" -serde_with = "2.0.1" -thiserror = "1.0.37" -url = "2.3.1" - -[dev-dependencies] -mockito = "0.31.0" +serde = { version = "^1.0", features = ["derive"] } +serde_with = { version = "^3.8", default-features = false, features = ["base64", "std", "macros"] } +serde_json = "^1.0" +serde_repr = "^0.1" +url = "^2.5" +uuid = { version = "^1.8", features = ["serde", "v4"] } +reqwest = { version = "^0.12", features = ["json", "blocking", "multipart"] } diff --git a/api/README.md b/api/README.md index f351e194..ff8ac060 100644 --- a/api/README.md +++ b/api/README.md @@ -1,3 +1,1183 @@ -# API Library for reinfer +# Rust API client for openapi + +# Overview + +Welcome to the Communications Mining API. We strive to make the API predictable, easy to use +and painless to integrate. + +Other resources: +- [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) +- [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) + +## API Endpoint + +All API requests are sent to Communications Mining as JSON objects to an endpoint over +HTTPS. + +### Development and production environments + +In Communications Mining, development and production data and workflows are separated by +placing them in separate projects, each of which is permissioned +separately (so that developers can have admin access in the development +projects while having stricter access controls in production). Both +development and production data are accessed over the same API URL. + +## Authentication + +All API requests require authentication to identify the user making the +request. Authentication is provided through an access token. The developer +access token can be obtained from your Manage Account page. + +You need to include the following HTTP header for every API call you make, +where `$API_TOKEN` is your Communications Mining API token. + +```txt +Authorization: Bearer $API_TOKEN +``` + +## Permissions + +Each API endpoint lists its required +permissions. You can view the permissions you have by going to your Manage +Account page. + +## Errors + +We use conventional HTTP response codes to indicate success or failure of an +API request. In general, codes in the `2xx` range indicate success, codes in +the `4xx` range indicate an error that resulted from the provided request and +codes in the `5xx` range indicate a problem with the Communications Mining platform. + +Requests that error will also return a body with a `status` value of `error` +instead of `ok`, and an error message describing the error. + +```json +{ + \"message\": \"404 Not Found\", + \"status\": \"error\" +} +``` + +Note that your request can fail due to issues in your network before it reaches +Communications Mining. In such cases the response you receive will look different from the +Communications Mining error response described above. + +## Performance Timing + +We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) +to communicate the time taken for requests to our API to be processed. We +include a single metric, `total`, which you can use to measure how long our +platform took to process your request free from latency of the network request. + +An example of the header as it will be seen in a response: + +```txt +Server-Timing: total;dur=37.7 +``` + +`Server-Timing` values are always in milliseconds, so in this case the API +request with this header value took 37.7 milliseconds to process on our +platform. + + + +## Overview + +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. + +- API version: 0.1.0 +- Package version: 0.1.0 +- Generator version: 7.8.0 +- Build package: `org.openapitools.codegen.languages.RustClientCodegen` + +## Installation + +Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`: + +``` +openapi = { path = "./openapi" } +``` + +## Documentation for API Endpoints + +All URIs are relative to *https://cloud.uipath.com/demo/demo/reinfer_* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AlertsApi* | [**alert_issues**](docs/AlertsApi.md#alert_issues) | **GET** /api/_private/alerts/{owner}/{raw_alert_name}/issues | Get issues for an alert +*AlertsApi* | [**create_alert**](docs/AlertsApi.md#create_alert) | **PUT** /api/_private/alerts/{owner}/{raw_alert_name} | Create an alert +*AlertsApi* | [**delete_alert**](docs/AlertsApi.md#delete_alert) | **DELETE** /api/_private/alerts/id:{raw_alert_id} | Delete a alert +*AlertsApi* | [**delete_alert_subscription**](docs/AlertsApi.md#delete_alert_subscription) | **DELETE** /api/_private/alerts/subscriptions/{raw_alert_id} | Unsubscribes the user from an alert +*AlertsApi* | [**get_alert**](docs/AlertsApi.md#get_alert) | **GET** /api/_private/alerts/{owner}/{raw_alert_name} | Get a alert by project and name +*AlertsApi* | [**get_alert_subscriptions**](docs/AlertsApi.md#get_alert_subscriptions) | **GET** /api/_private/alerts/subscriptions | Get all alerts that the user is subscribed to +*AlertsApi* | [**get_all_alerts**](docs/AlertsApi.md#get_all_alerts) | **GET** /api/_private/alerts | Get all alerts for a user +*AlertsApi* | [**get_issue**](docs/AlertsApi.md#get_issue) | **GET** /api/_private/issues/{hex_issue_id} | Get an issue +*AlertsApi* | [**preview_alert**](docs/AlertsApi.md#preview_alert) | **POST** /api/_private/alerts/{owner}/{raw_alert_name}/preview | Preview an alert +*AlertsApi* | [**query_issues**](docs/AlertsApi.md#query_issues) | **POST** /api/_private/issues/query | Query issues for the current user +*AlertsApi* | [**update_alert**](docs/AlertsApi.md#update_alert) | **POST** /api/_private/alerts/{owner}/{raw_alert_name} | Update a alert +*AlertsApi* | [**update_issue_status**](docs/AlertsApi.md#update_issue_status) | **POST** /api/_private/issues/{hex_issue_id}/status | Update the status of the issue +*AnalyticsApi* | [**create_page_view**](docs/AnalyticsApi.md#create_page_view) | **PUT** /api/_private/analytics/pageview | Create a pageview +*ApplianceConfigsApi* | [**get_appliance_config**](docs/ApplianceConfigsApi.md#get_appliance_config) | **GET** /api/_private/appliance-configs/{owner}/{config_key} | Get an appliance config +*ApplianceConfigsApi* | [**update_appliance_config**](docs/ApplianceConfigsApi.md#update_appliance_config) | **PUT** /api/_private/appliance-configs/{owner}/{config_key} | Update an appliance config +*AttachmentsApi* | [**get_attachment**](docs/AttachmentsApi.md#get_attachment) | **GET** /api/v1/attachments/{attachment_reference} | Get an attachment's content. +*AttachmentsApi* | [**get_document_metadata**](docs/AttachmentsApi.md#get_document_metadata) | **GET** /api/_private/attachments/{attachment_reference}/render | Get the metadata for all pages in a document +*AttachmentsApi* | [**get_document_search**](docs/AttachmentsApi.md#get_document_search) | **GET** /api/_private/attachments/{attachment_reference}/selections/search | Get the search result selections for a given query +*AttachmentsApi* | [**get_page_image**](docs/AttachmentsApi.md#get_page_image) | **GET** /api/_private/attachments/{attachment_reference}/render/pages/{page_index} | Get the image for a given page +*AttachmentsApi* | [**get_page_selections**](docs/AttachmentsApi.md#get_page_selections) | **GET** /api/_private/attachments/{attachment_reference}/selections/pages/{page_index} | Get the OCR selections for a given page +*AttachmentsApi* | [**get_page_thumbnail**](docs/AttachmentsApi.md#get_page_thumbnail) | **GET** /api/_private/attachments/{attachment_reference}/thumbnail/pages/{page_index} | Get the thumbnail for a given page +*AttachmentsApi* | [**upload_comment_attachment**](docs/AttachmentsApi.md#upload_comment_attachment) | **PUT** /api/_private/sources/id:{source_id}/comments/{comment_id}/attachments/{attachment_index} | Upload an attachment for a comment. +*AttachmentsApi* | [**upload_email_attachment**](docs/AttachmentsApi.md#upload_email_attachment) | **PUT** /api/_private/buckets/id:{bucket_id}/emails/{email_id}/attachments/{attachment_index} | Upload an attachment for a email. +*AuditEventsApi* | [**query_audit_events**](docs/AuditEventsApi.md#query_audit_events) | **POST** /api/v1/audit_events/query | Query audit events +*BucketsApi* | [**create_bucket**](docs/BucketsApi.md#create_bucket) | **PUT** /api/_private/buckets/{owner}/{bucket_name} | Create a bucket +*BucketsApi* | [**delete_bucket**](docs/BucketsApi.md#delete_bucket) | **DELETE** /api/_private/buckets/id:{raw_bucket_id} | Delete a bucket +*BucketsApi* | [**delete_keyed_sync_state**](docs/BucketsApi.md#delete_keyed_sync_state) | **DELETE** /api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key} | Delete a keyed sync state by bucket Id. +*BucketsApi* | [**get_all_buckets**](docs/BucketsApi.md#get_all_buckets) | **GET** /api/_private/buckets | Get all buckets +*BucketsApi* | [**get_bucket**](docs/BucketsApi.md#get_bucket) | **GET** /api/_private/buckets/{owner}/{bucket_name} | Get a bucket +*BucketsApi* | [**get_bucket_by_id**](docs/BucketsApi.md#get_bucket_by_id) | **GET** /api/_private/buckets/id:{bucket_id} | Get a bucket by ID +*BucketsApi* | [**get_bucket_statistics**](docs/BucketsApi.md#get_bucket_statistics) | **GET** /api/_private/buckets/{owner}/{bucket_name}/statistics | Get bucket statistics +*BucketsApi* | [**get_bucket_sync_state**](docs/BucketsApi.md#get_bucket_sync_state) | **GET** /api/_private/bucket-sync-state/{owner}/{bucket_name} | Get bucket sync state +*BucketsApi* | [**get_buckets_by_owner**](docs/BucketsApi.md#get_buckets_by_owner) | **GET** /api/_private/buckets/{owner} | Get buckets by owner +*BucketsApi* | [**get_keyed_sync_state**](docs/BucketsApi.md#get_keyed_sync_state) | **GET** /api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key} | Get a keyed sync state by bucket Id. +*BucketsApi* | [**list_keyed_sync_states**](docs/BucketsApi.md#list_keyed_sync_states) | **GET** /api/_private/buckets/id:{raw_bucket_id}/keyed-sync-states/ | List keyed sync states for a bucket. +*BucketsApi* | [**query_keyed_sync_state_ids**](docs/BucketsApi.md#query_keyed_sync_state_ids) | **POST** /api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state-ids | Query keyed sync state ids for a bucket. +*BucketsApi* | [**store_bucket_sync_state**](docs/BucketsApi.md#store_bucket_sync_state) | **PUT** /api/_private/bucket-sync-state/{owner}/{bucket_name} | Store bucket sync state +*BucketsApi* | [**store_keyed_sync_state**](docs/BucketsApi.md#store_keyed_sync_state) | **PUT** /api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key} | Store a keyed sync state by bucket Id. +*BucketsApi* | [**update_bucket**](docs/BucketsApi.md#update_bucket) | **POST** /api/_private/buckets/{owner}/{bucket_name} | Update a bucket +*CommentsApi* | [**add_comments**](docs/CommentsApi.md#add_comments) | **PUT** /api/_private/sources/{owner}/{source_name}/comments | Add a batch of comments +*CommentsApi* | [**delete_comment**](docs/CommentsApi.md#delete_comment) | **DELETE** /api/v1/sources/{owner}/{source_name}/comments | Delete a comment by ID +*CommentsApi* | [**get_comment**](docs/CommentsApi.md#get_comment) | **GET** /api/v1/sources/{owner}/{source_name}/comments/{comment_id} | Get a comment by ID +*CommentsApi* | [**get_comment_audio**](docs/CommentsApi.md#get_comment_audio) | **GET** /api/_private/sources/id:{source_id}/comments/{comment_id}/audio | Get the audio for a comment +*CommentsApi* | [**get_source_comments**](docs/CommentsApi.md#get_source_comments) | **GET** /api/_private/sources/{owner}/{source_name}/comments | Get comments from a source +*CommentsApi* | [**query_comments**](docs/CommentsApi.md#query_comments) | **POST** /api/_private/datasets/{owner}/{dataset_name}/query | Query comments in a dataset +*CommentsApi* | [**set_comment_audio**](docs/CommentsApi.md#set_comment_audio) | **PUT** /api/_private/sources/id:{raw_source_id}/comments/{raw_comment_id}/audio | Set the audio for a comment +*CommentsApi* | [**sniff_csv**](docs/CommentsApi.md#sniff_csv) | **PUT** /api/_private/sources/sniff-csv | Sniff a CSV file +*CommentsApi* | [**sync_comments**](docs/CommentsApi.md#sync_comments) | **POST** /api/v1/sources/{owner}/{source_name}/sync | Sync a batch of comments +*CommentsApi* | [**sync_comments_from_csv**](docs/CommentsApi.md#sync_comments_from_csv) | **PUT** /api/_private/sources/{owner}/{source_name}/sync-csv | Sync comments from a CSV file +*CommentsApi* | [**sync_raw_emails**](docs/CommentsApi.md#sync_raw_emails) | **POST** /api/v1/sources/{owner}/{source_name}/sync-raw-emails | Sync a batch of raw emails +*CommentsApi* | [**upload_comment_attachment**](docs/CommentsApi.md#upload_comment_attachment) | **PUT** /api/_private/sources/id:{source_id}/comments/{comment_id}/attachments/{attachment_index} | Upload an attachment for a comment. +*ConversationalFilterApi* | [**query_conversational_filter**](docs/ConversationalFilterApi.md#query_conversational_filter) | **POST** /api/_private/datasets/{owner}/{dataset_name}/conversational-filter-query | Query comments in a dataset with an LLM +*DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **PUT** /api/_private/dashboards/{owner}/{dashboard_name} | Create a new dashboard +*DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /api/_private/dashboards/{owner}/{dashboard_name} | Delete a dashboard +*DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /api/_private/dashboards/{owner}/{dashboard_name} | Get a dashboard by project and name +*DashboardsApi* | [**get_dashboards_in_dataset**](docs/DashboardsApi.md#get_dashboards_in_dataset) | **GET** /api/_private/datasets/{owner}/{dataset_name}/dashboards | Get all dashboards in dataset +*DashboardsApi* | [**get_dashboards_in_project**](docs/DashboardsApi.md#get_dashboards_in_project) | **GET** /api/_private/dashboards/{owner} | Get all dashboards in project +*DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **POST** /api/_private/dashboards/{owner}/{dashboard_name} | Get a dashboard by project and name +*DatasetsApi* | [**create_dataset**](docs/DatasetsApi.md#create_dataset) | **PUT** /api/v1/datasets/{owner}/{dataset_name} | Create a dataset +*DatasetsApi* | [**delete_dataset_by_id**](docs/DatasetsApi.md#delete_dataset_by_id) | **DELETE** /api/v1/datasets/id:{dataset_id} | Delete a dataset by id +*DatasetsApi* | [**delete_dataset_v1**](docs/DatasetsApi.md#delete_dataset_v1) | **DELETE** /api/v1/datasets/{owner}/{dataset_name} | Delete a dataset +*DatasetsApi* | [**export_dataset**](docs/DatasetsApi.md#export_dataset) | **POST** /api/v1/datasets/{owner}/{dataset_name}/export | Export dataset +*DatasetsApi* | [**get_all_datasets**](docs/DatasetsApi.md#get_all_datasets) | **GET** /api/v1/datasets | Get all datasets +*DatasetsApi* | [**get_all_datasets_in_project**](docs/DatasetsApi.md#get_all_datasets_in_project) | **GET** /api/v1/datasets/{owner} | Get all datasets in a project +*DatasetsApi* | [**get_comparison**](docs/DatasetsApi.md#get_comparison) | **POST** /api/_private/datasets/{owner}/{dataset_name}/compare | Get comparison for two filtered groups of verbatims +*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /api/v1/datasets/{owner}/{dataset_name} | Get a dataset by project and name +*DatasetsApi* | [**get_dataset_statistics**](docs/DatasetsApi.md#get_dataset_statistics) | **POST** /api/_private/datasets/{owner}/{dataset_name}/statistics | Get dataset statistics +*DatasetsApi* | [**get_dataset_status**](docs/DatasetsApi.md#get_dataset_status) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labellers/status | Get dataset status +*DatasetsApi* | [**get_dataset_summary**](docs/DatasetsApi.md#get_dataset_summary) | **POST** /api/_private/datasets/{owner}/{dataset_name}/summary | Get dataset summary +*DatasetsApi* | [**get_dataset_user_properties_summary**](docs/DatasetsApi.md#get_dataset_user_properties_summary) | **GET** /api/_private/datasets/{owner}/{dataset_name}/user-properties | Get user property summary for a dataset +*DatasetsApi* | [**get_labellings**](docs/DatasetsApi.md#get_labellings) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labellings | Get labellings in a dataset +*DatasetsApi* | [**query_dataset_user_property_values**](docs/DatasetsApi.md#query_dataset_user_property_values) | **POST** /api/_private/datasets/{owner}/{dataset_name}/user-properties/values | Query user property values for a dataset +*DatasetsApi* | [**reset_annotations_to_previous_pinned_model**](docs/DatasetsApi.md#reset_annotations_to_previous_pinned_model) | **POST** /api/_private/datasets/{owner}/{dataset_name}/reset-annotations | Reset annotations to the previous pinned model +*DatasetsApi* | [**sync_annotations**](docs/DatasetsApi.md#sync_annotations) | **POST** /api/v1/datasets/{owner}/{dataset_name}/sync-annotations | Sync annotations +*DatasetsApi* | [**update_comment_labelling**](docs/DatasetsApi.md#update_comment_labelling) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labellings/{labelling_id} | Update the labelling of a comment +*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **POST** /api/v1/datasets/{owner}/{dataset_name} | Update a dataset +*DeploymentApi* | [**get_qualified_login_url**](docs/DeploymentApi.md#get_qualified_login_url) | **POST** /api/_private/deployment/login-location | Get the fully qualified login url for an email address. +*DeploymentApi* | [**get_subdomain**](docs/DeploymentApi.md#get_subdomain) | **GET** /api/_private/deployment/subdomain | Whether the request was made from a tenant subdomain. +*DeprecationApi* | [**get_deprecated_user_models**](docs/DeprecationApi.md#get_deprecated_user_models) | **GET** /api/_private/deprecated-user-models | Get all deprecated user models +*DiscoverApi* | [**get_themes**](docs/DiscoverApi.md#get_themes) | **GET** /api/_private/datasets/{owner}/{dataset_name}/themes | Get a themes by project and name +*DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /api/_private/sources/id:{source_id}/documents/{comment_id} | Get an unstructured document. +*DocumentsApi* | [**upload_document**](docs/DocumentsApi.md#upload_document) | **PUT** /api/_private/sources/id:{source_id}/documents | Upload an unstructured document. +*EmailsApi* | [**add_emails_to_bucket**](docs/EmailsApi.md#add_emails_to_bucket) | **PUT** /api/_private/buckets/{owner}/{bucket_name}/emails | Add emails to bucket +*EmailsApi* | [**get_bucket_emails**](docs/EmailsApi.md#get_bucket_emails) | **POST** /api/_private/buckets/{owner}/{bucket_name}/emails | Get emails from a bucket +*EmailsApi* | [**get_email_from_bucket_by_id**](docs/EmailsApi.md#get_email_from_bucket_by_id) | **GET** /api/_private/buckets/{owner}/{bucket_name}/emails | Get email from bucket +*EmailsApi* | [**upload_email_attachment**](docs/EmailsApi.md#upload_email_attachment) | **PUT** /api/_private/buckets/id:{bucket_id}/emails/{email_id}/attachments/{attachment_index} | Upload an attachment for a email. +*FilesApi* | [**upload_files**](docs/FilesApi.md#upload_files) | **POST** /api/_private/files/upload | Upload files +*IntegrationsApi* | [**create_integration**](docs/IntegrationsApi.md#create_integration) | **PUT** /api/_private/integrations/{owner}/{integration_name} | Create a integration +*IntegrationsApi* | [**delete_integration**](docs/IntegrationsApi.md#delete_integration) | **DELETE** /api/_private/integrations/id:{integration_id} | Delete a integration +*IntegrationsApi* | [**get_all_integrations**](docs/IntegrationsApi.md#get_all_integrations) | **GET** /api/_private/integrations | Get all integrations +*IntegrationsApi* | [**get_all_integrations_in_project**](docs/IntegrationsApi.md#get_all_integrations_in_project) | **GET** /api/_private/integrations/{owner} | Get all integrations in a project +*IntegrationsApi* | [**get_integration**](docs/IntegrationsApi.md#get_integration) | **GET** /api/_private/integrations/{owner}/{integration_name} | Get a integration by project and name +*IntegrationsApi* | [**get_integration_by_id**](docs/IntegrationsApi.md#get_integration_by_id) | **GET** /api/_private/integrations/id:{integration_id} | Get a integration by ID +*IntegrationsApi* | [**get_integration_errors**](docs/IntegrationsApi.md#get_integration_errors) | **GET** /api/_private/integrations/{owner}/{integration_name}/errors | Get integration sync errors +*IntegrationsApi* | [**integrations_o_auth2_authenticate**](docs/IntegrationsApi.md#integrations_o_auth2_authenticate) | **GET** /api/_private/integrations/{owner}/{integration_name}/oauth2/authenticate | OAuth2 `authenticate` endpoint +*IntegrationsApi* | [**o_auth2_salesforce_callback**](docs/IntegrationsApi.md#o_auth2_salesforce_callback) | **PUT** /api/_private/salesforce/oauth2/callback | Salesforce OAuth2 `callback` endpoint +*IntegrationsApi* | [**update_integration**](docs/IntegrationsApi.md#update_integration) | **POST** /api/_private/integrations/{owner}/{integration_name} | Update a integration +*IntegrationsApi* | [**validate_exchange_credentials**](docs/IntegrationsApi.md#validate_exchange_credentials) | **PUT** /api/_private/validate-exchange-credentials | Validate Exchange credentials +*IxpDatasetsApi* | [**create_ixp_dataset**](docs/IxpDatasetsApi.md#create_ixp_dataset) | **PUT** /api/_private/ixp/datasets | Create a new IXP dataset +*IxpDatasetsApi* | [**delete_ixp_dataset**](docs/IxpDatasetsApi.md#delete_ixp_dataset) | **DELETE** /api/_private/ixp/datasets/{dataset_id} | Delete an IXP dataset +*IxpModelsApi* | [**get_ixp_consumability**](docs/IxpModelsApi.md#get_ixp_consumability) | **GET** /api/_private/ixp/consumability | Get IXP consumability information for the tenant +*IxpModelsApi* | [**get_ixp_models**](docs/IxpModelsApi.md#get_ixp_models) | **GET** /api/_private/ixp/projects/{project_uuid}/models | Get all pinned IXP models in a Project +*IxpModelsApi* | [**get_ixp_predictions**](docs/IxpModelsApi.md#get_ixp_predictions) | **GET** /api/_private/ixp/projects/{project_uuid}/models/{model_version}/documents/{document_id}/extractions | Get IXP Document Predictions +*IxpModelsApi* | [**upload_ixp_document**](docs/IxpModelsApi.md#upload_ixp_document) | **PUT** /api/_private/ixp/projects/{project_uuid}/models/{model_version}/documents | Upload IXP Document for Runtime Predictions +*IxpProjectsApi* | [**get_ixp_project**](docs/IxpProjectsApi.md#get_ixp_project) | **GET** /api/_private/ixp/projects/{project_uuid} | Get an IXP project +*IxpProjectsApi* | [**get_ixp_projects**](docs/IxpProjectsApi.md#get_ixp_projects) | **GET** /api/_private/ixp/projects | Get all IXP projects +*IxpProjectsApi* | [**import_taxonomy**](docs/IxpProjectsApi.md#import_taxonomy) | **POST** /api/_private/ixp/projects/{owner}/{dataset_name}/import-taxonomy | Import an IXP Taxonomy using a Dataset JSON file +*IxpProjectsApi* | [**suggest_taxonomy**](docs/IxpProjectsApi.md#suggest_taxonomy) | **POST** /api/_private/ixp/projects/{owner}/{dataset_name}/suggest-taxonomy | Suggest an IXP Taxonomy from context +*LabelDefsApi* | [**create_label_defs_bulk**](docs/LabelDefsApi.md#create_label_defs_bulk) | **PUT** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name} | Label Group Bulk Create +*LabelDefsApi* | [**delete_label_def**](docs/LabelDefsApi.md#delete_label_def) | **DELETE** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name} | Delete Label Def +*LabelDefsApi* | [**get_field_group_history**](docs/LabelDefsApi.md#get_field_group_history) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}/{label_name}/history | Get history for a field group +*LabelDefsApi* | [**get_field_history**](docs/LabelDefsApi.md#get_field_history) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}/{label_name}/fields/{field_id}/history | Get history for a field +*LabelDefsApi* | [**get_label_def**](docs/LabelDefsApi.md#get_label_def) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name} | Get Label Def +*LabelDefsApi* | [**update_label_def**](docs/LabelDefsApi.md#update_label_def) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name} | Update label def +*LabelGroupsApi* | [**create_label_group**](docs/LabelGroupsApi.md#create_label_group) | **POST** /api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name} | Create a label group +*LabelGroupsApi* | [**delete_label_group**](docs/LabelGroupsApi.md#delete_label_group) | **DELETE** /api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name} | Delete a label group +*LabelGroupsApi* | [**get_all_label_groups**](docs/LabelGroupsApi.md#get_all_label_groups) | **GET** /api/_private/datasets/{owner}/{dataset_name}/label-groups | Get all label groups +*LabelGroupsApi* | [**get_label_group**](docs/LabelGroupsApi.md#get_label_group) | **GET** /api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name} | Get a label group +*MetadataApi* | [**get_document_metadata**](docs/MetadataApi.md#get_document_metadata) | **GET** /api/_private/attachments/{attachment_reference}/render | Get the metadata for all pages in a document +*MetadataApi* | [**get_page_image**](docs/MetadataApi.md#get_page_image) | **GET** /api/_private/attachments/{attachment_reference}/render/pages/{page_index} | Get the image for a given page +*MetadataApi* | [**get_page_selections**](docs/MetadataApi.md#get_page_selections) | **GET** /api/_private/attachments/{attachment_reference}/selections/pages/{page_index} | Get the OCR selections for a given page +*MetadataApi* | [**get_page_thumbnail**](docs/MetadataApi.md#get_page_thumbnail) | **GET** /api/_private/attachments/{attachment_reference}/thumbnail/pages/{page_index} | Get the thumbnail for a given page +*ModelFamilyApi* | [**get_pretrained_labels**](docs/ModelFamilyApi.md#get_pretrained_labels) | **GET** /api/_private/model-family/{model_family}/pretrained-labels | Get pretrained labels +*ModelsApi* | [**delete_model_tag**](docs/ModelsApi.md#delete_model_tag) | **DELETE** /api/_private/datasets/{owner}/{dataset_name}/model-tags/{tag_name} | Delete a model tag +*ModelsApi* | [**get_all_models_in_dataset**](docs/ModelsApi.md#get_all_models_in_dataset) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labellers | Get all the models for a dataset +*ModelsApi* | [**get_comment_predictions**](docs/ModelsApi.md#get_comment_predictions) | **POST** /api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-comments | Get predictions for a list of comments +*ModelsApi* | [**get_label_validation**](docs/ModelsApi.md#get_label_validation) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/label-validation | Get label validation for a dataset +*ModelsApi* | [**get_model_tags**](docs/ModelsApi.md#get_model_tags) | **GET** /api/v1/datasets/{owner}/{dataset_name}/model-tags | Get model tags +*ModelsApi* | [**get_training_action_ordered_comment_uids**](docs/ModelsApi.md#get_training_action_ordered_comment_uids) | **GET** /api/_private/datasets/{owner}/{dataset_name}/{training_action_id}/training-action-comment-uids | Get ordered comment uids for training action +*ModelsApi* | [**get_training_actions_labels**](docs/ModelsApi.md#get_training_actions_labels) | **GET** /api/_private/datasets/{owner}/{dataset_name}/{model_version}/training-actions/labels | Get ordered training actions for labels +*ModelsApi* | [**get_validation**](docs/ModelsApi.md#get_validation) | **GET** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/validation | Get validation for a dataset +*ModelsApi* | [**get_validation_v1**](docs/ModelsApi.md#get_validation_v1) | **GET** /api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/validation | Get validation for a dataset +*ModelsApi* | [**pin_model**](docs/ModelsApi.md#pin_model) | **PUT** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/pin | Pin a model +*ModelsApi* | [**predict**](docs/ModelsApi.md#predict) | **POST** /api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict | Get predictions from a specific version of a pinned model +*ModelsApi* | [**predict_extractions**](docs/ModelsApi.md#predict_extractions) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-extractions | Get extraction predictions from a specific version of a pinned model +*ModelsApi* | [**predict_latest**](docs/ModelsApi.md#predict_latest) | **POST** /api/_private/datasets/{owner}/{dataset_name}/labellers/predict | Get predictions from the latest model +*ModelsApi* | [**predict_raw_emails**](docs/ModelsApi.md#predict_raw_emails) | **POST** /api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-raw-emails | Get predictions on raw emails from a specific model version +*ModelsApi* | [**put_training_comment_seen**](docs/ModelsApi.md#put_training_comment_seen) | **PUT** /api/_private/datasets/{owner}/{dataset_name}/{training_action_id}/{comment_uid}/seen-training-comment | Put a training comment as seen +*ModelsApi* | [**unpin_model**](docs/ModelsApi.md#unpin_model) | **DELETE** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/pin | Unpin a model +*ModelsApi* | [**update_model**](docs/ModelsApi.md#update_model) | **PATCH** /api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version} | Update a model +*ModelsApi* | [**update_model_tag**](docs/ModelsApi.md#update_model_tag) | **PUT** /api/_private/datasets/{owner}/{dataset_name}/model-tags/{tag_name} | Update a model tag +*PermissionsApi* | [**get_derived_permissions**](docs/PermissionsApi.md#get_derived_permissions) | **POST** /api/_private/permissions/derived | Get the derived permissions for a user. +*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **PUT** /api/_private/projects/{name} | Create a project +*ProjectsApi* | [**create_project_setup**](docs/ProjectsApi.md#create_project_setup) | **PUT** /api/_private/solution-accelerator-project-setup/{name} | Create and set up a project +*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/_private/projects/{name} | Delete a project +*ProjectsApi* | [**get_all_projects**](docs/ProjectsApi.md#get_all_projects) | **GET** /api/_private/projects | Get all projects +*ProjectsApi* | [**get_all_projects_v1**](docs/ProjectsApi.md#get_all_projects_v1) | **GET** /api/v1/projects | Get all projects +*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/_private/projects/{name} | Get a project by name +*ProjectsApi* | [**get_project_resource_counts**](docs/ProjectsApi.md#get_project_resource_counts) | **GET** /api/_private/projects/{name}/resource_counts | Get resource counts for a Project +*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **POST** /api/_private/projects/{name} | Update a project +*QuotasApi* | [**get_quotas_for_tenant**](docs/QuotasApi.md#get_quotas_for_tenant) | **GET** /api/_private/quotas/{target_tenant_id} | Get quotas for tenant +*QuotasApi* | [**get_tenant_quota**](docs/QuotasApi.md#get_tenant_quota) | **GET** /api/_private/quotas | Get quotas +*QuotasApi* | [**reset_tenant_quota**](docs/QuotasApi.md#reset_tenant_quota) | **DELETE** /api/_private/quotas/{target_tenant_id}/{quota_kind} | Reset tenant quota +*QuotasApi* | [**set_quota_for_tenant**](docs/QuotasApi.md#set_quota_for_tenant) | **POST** /api/_private/quotas/{target_tenant_id}/{quota_kind} | Set quota for tenant +*QuotasApi* | [**set_tenant_quota**](docs/QuotasApi.md#set_tenant_quota) | **POST** /api/_private/quotas/{quota_kind} | Set tenant quota +*ReportsApi* | [**create_dashboard**](docs/ReportsApi.md#create_dashboard) | **PUT** /api/_private/dashboards/{owner}/{dashboard_name} | Create a new dashboard +*ReportsApi* | [**delete_dashboard**](docs/ReportsApi.md#delete_dashboard) | **DELETE** /api/_private/dashboards/{owner}/{dashboard_name} | Delete a dashboard +*ReportsApi* | [**get_dashboard**](docs/ReportsApi.md#get_dashboard) | **GET** /api/_private/dashboards/{owner}/{dashboard_name} | Get a dashboard by project and name +*ReportsApi* | [**get_dashboards_in_dataset**](docs/ReportsApi.md#get_dashboards_in_dataset) | **GET** /api/_private/datasets/{owner}/{dataset_name}/dashboards | Get all dashboards in dataset +*ReportsApi* | [**get_dashboards_in_project**](docs/ReportsApi.md#get_dashboards_in_project) | **GET** /api/_private/dashboards/{owner} | Get all dashboards in project +*ReportsApi* | [**update_dashboard**](docs/ReportsApi.md#update_dashboard) | **POST** /api/_private/dashboards/{owner}/{dashboard_name} | Get a dashboard by project and name +*SearchApi* | [**get_document_search**](docs/SearchApi.md#get_document_search) | **GET** /api/_private/attachments/{attachment_reference}/selections/search | Get the search result selections for a given query +*SourcesApi* | [**create_source**](docs/SourcesApi.md#create_source) | **PUT** /api/v1/sources/{owner}/{source_name} | Create a source +*SourcesApi* | [**delete_source**](docs/SourcesApi.md#delete_source) | **DELETE** /api/v1/sources/id:{source_id} | Delete a source +*SourcesApi* | [**get_all_sources**](docs/SourcesApi.md#get_all_sources) | **GET** /api/v1/sources | Get all sources +*SourcesApi* | [**get_all_sources_in_project**](docs/SourcesApi.md#get_all_sources_in_project) | **GET** /api/v1/sources/{owner} | Get all sources in a project +*SourcesApi* | [**get_email_transform_tag_info**](docs/SourcesApi.md#get_email_transform_tag_info) | **GET** /api/_private/sources/email-transform/tag:{transform_tag} | Get info about email transform +*SourcesApi* | [**get_source**](docs/SourcesApi.md#get_source) | **GET** /api/v1/sources/{owner}/{source_name} | Get a source by project and name +*SourcesApi* | [**get_source_by_id**](docs/SourcesApi.md#get_source_by_id) | **GET** /api/v1/sources/id:{source_id} | Get a source by ID +*SourcesApi* | [**get_source_statistics**](docs/SourcesApi.md#get_source_statistics) | **POST** /api/v1/sources/{owner}/{source_name}/statistics | Get source statistics +*SourcesApi* | [**get_threads_by_source**](docs/SourcesApi.md#get_threads_by_source) | **GET** /api/v1/sources/{owner}/{source_name}/threads | Get threads by source +*SourcesApi* | [**update_source**](docs/SourcesApi.md#update_source) | **POST** /api/v1/sources/{owner}/{source_name} | Update a source +*StreamsApi* | [**advance_stream**](docs/StreamsApi.md#advance_stream) | **POST** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/advance | Advance stream +*StreamsApi* | [**create_stream**](docs/StreamsApi.md#create_stream) | **PUT** /api/v1/datasets/{owner}/{dataset_name}/streams | Create stream +*StreamsApi* | [**delete_exception**](docs/StreamsApi.md#delete_exception) | **DELETE** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/exceptions | Delete exception +*StreamsApi* | [**delete_stream**](docs/StreamsApi.md#delete_stream) | **DELETE** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name} | Delete stream +*StreamsApi* | [**fetch_from_gx_stream**](docs/StreamsApi.md#fetch_from_gx_stream) | **POST** /api/preview/datasets/{owner}/{dataset_name}/streams/{stream_name}/gx-fetch | Fetch from GX stream +*StreamsApi* | [**fetch_from_stream**](docs/StreamsApi.md#fetch_from_stream) | **POST** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/fetch | Fetch from stream +*StreamsApi* | [**get_all_streams**](docs/StreamsApi.md#get_all_streams) | **GET** /api/v1/datasets/{owner}/{dataset_name}/streams | Get all streams +*StreamsApi* | [**get_stream_by_name**](docs/StreamsApi.md#get_stream_by_name) | **GET** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name} | Get stream by name +*StreamsApi* | [**get_stream_results**](docs/StreamsApi.md#get_stream_results) | **GET** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/results | Get new comments from stream +*StreamsApi* | [**get_stream_results_preview**](docs/StreamsApi.md#get_stream_results_preview) | **GET** /api/preview/datasets/{owner}/{dataset_name}/streams/{stream_name}/results | Get new comments from stream +*StreamsApi* | [**reset_stream**](docs/StreamsApi.md#reset_stream) | **POST** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/reset | Reset stream +*StreamsApi* | [**store_exception**](docs/StreamsApi.md#store_exception) | **PUT** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/exceptions | Store exception +*StreamsApi* | [**update_stream**](docs/StreamsApi.md#update_stream) | **POST** /api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name} | Update stream +*TenantsApi* | [**create_tenant**](docs/TenantsApi.md#create_tenant) | **PUT** /api/_private/tenants/{name} | Create a new tenant +*TenantsApi* | [**delete_tenant**](docs/TenantsApi.md#delete_tenant) | **DELETE** /api/_private/tenants/{name} | Delete a tenant by name +*TenantsApi* | [**delete_tenant_default_project_permissions**](docs/TenantsApi.md#delete_tenant_default_project_permissions) | **DELETE** /api/_private/tenants/{name}/default_project_permissions | Clear default project permissions for a tenant +*TenantsApi* | [**get_tenant**](docs/TenantsApi.md#get_tenant) | **GET** /api/_private/tenants/{name} | Get a single tenant by name +*TenantsApi* | [**get_tenant_client_subnets**](docs/TenantsApi.md#get_tenant_client_subnets) | **GET** /api/_private/tenants/{name}/client_subnets | Get client subnets for a tenant +*TenantsApi* | [**get_tenant_default_project_permissions**](docs/TenantsApi.md#get_tenant_default_project_permissions) | **GET** /api/_private/tenants/{name}/default_project_permissions | Get default project permissions for a tenant +*TenantsApi* | [**get_tenant_domains**](docs/TenantsApi.md#get_tenant_domains) | **GET** /api/_private/tenants/{name}/domains | Get domains for a tenant +*TenantsApi* | [**get_tenant_entity_def_ids**](docs/TenantsApi.md#get_tenant_entity_def_ids) | **GET** /api/_private/tenants/{name}/entity_def_ids | Get entity_def_ids for a tenant +*TenantsApi* | [**get_tenants**](docs/TenantsApi.md#get_tenants) | **GET** /api/_private/tenants | Get tenants +*TenantsApi* | [**set_tenant_state**](docs/TenantsApi.md#set_tenant_state) | **POST** /api/_private/tenants/{name}/state | Sets the enabled or disabled state for a tenant +*TenantsApi* | [**update_tenant**](docs/TenantsApi.md#update_tenant) | **POST** /api/_private/tenants/{name} | Update a tenant +*TenantsApi* | [**update_tenant_client_subnets**](docs/TenantsApi.md#update_tenant_client_subnets) | **POST** /api/_private/tenants/{name}/client_subnets | Update client subnets for a tenant +*TenantsApi* | [**update_tenant_default_project_permissions**](docs/TenantsApi.md#update_tenant_default_project_permissions) | **POST** /api/_private/tenants/{name}/default_project_permissions | Update default project permissions for a tenant +*TenantsApi* | [**update_tenant_domains**](docs/TenantsApi.md#update_tenant_domains) | **POST** /api/_private/tenants/{name}/domains | Update domains for a tenant +*TenantsApi* | [**update_tenant_entity_def_ids**](docs/TenantsApi.md#update_tenant_entity_def_ids) | **POST** /api/_private/tenants/{name}/entity_def_ids | Update entity_def_ids for a tenant +*ThemesApi* | [**get_themes**](docs/ThemesApi.md#get_themes) | **GET** /api/_private/datasets/{owner}/{dataset_name}/themes | Get a themes by project and name +*ThreadThemesApi* | [**get_thread_themes**](docs/ThreadThemesApi.md#get_thread_themes) | **POST** /api/preview/datasets/{owner}/{dataset_name}/thread-themes | Get description of a thread +*TriggersApi* | [**advance_trigger**](docs/TriggersApi.md#advance_trigger) | **POST** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/advance | Advance a trigger +*TriggersApi* | [**create_trigger**](docs/TriggersApi.md#create_trigger) | **PUT** /api/v1/datasets/{owner}/{dataset_name}/triggers | Create a trigger +*TriggersApi* | [**delete_trigger**](docs/TriggersApi.md#delete_trigger) | **DELETE** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name} | Delete a trigger +*TriggersApi* | [**delete_trigger_exception**](docs/TriggersApi.md#delete_trigger_exception) | **DELETE** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/exceptions | Delete trigger exception +*TriggersApi* | [**get_all_triggers_in_dataset**](docs/TriggersApi.md#get_all_triggers_in_dataset) | **GET** /api/v1/datasets/{owner}/{dataset_name}/triggers | Get the available triggers for a dataset +*TriggersApi* | [**get_trigger**](docs/TriggersApi.md#get_trigger) | **GET** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name} | Get a trigger +*TriggersApi* | [**poll_trigger**](docs/TriggersApi.md#poll_trigger) | **POST** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/fetch | Fetch new messages from a trigger +*TriggersApi* | [**reset_trigger**](docs/TriggersApi.md#reset_trigger) | **POST** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/reset | Reset a trigger +*TriggersApi* | [**store_trigger_exception**](docs/TriggersApi.md#store_trigger_exception) | **PUT** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/exceptions | Store trigger exception +*TriggersApi* | [**update_trigger**](docs/TriggersApi.md#update_trigger) | **POST** /api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name} | Update a trigger +*UipathProvisioningApi* | [**uipath_provision_create**](docs/UipathProvisioningApi.md#uipath_provision_create) | **POST** /api/tenantserviceinstances | Create resources for a Uipath tenant +*UipathProvisioningApi* | [**uipath_provision_delete**](docs/UipathProvisioningApi.md#uipath_provision_delete) | **DELETE** /api/tenantserviceinstances/{service_type}/{tenant_id} | Delete resources for a Uipath tenant +*UipathProvisioningApi* | [**uipath_provision_restore**](docs/UipathProvisioningApi.md#uipath_provision_restore) | **POST** /api/tenantserviceinstances/{service_type}/{tenant_id}/restore | Restore resources for a Uipath tenant +*UipathProvisioningApi* | [**uipath_provision_update**](docs/UipathProvisioningApi.md#uipath_provision_update) | **PATCH** /api/tenantserviceinstances/{service_type}/{tenant_id} | Update resources for a Uipath tenant +*UsersApi* | [**add_support_tenant**](docs/UsersApi.md#add_support_tenant) | **POST** /api/_private/users/support-tenants/add | Add a support tenant +*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **PUT** /api/_private/users | Create a user +*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /api/_private/users/{user_id} | Delete a user +*UsersApi* | [**get_reduced_permissions**](docs/UsersApi.md#get_reduced_permissions) | **POST** /api/_private/permissions/reduced | Get the reduced permissions for a user +*UsersApi* | [**get_user_by_id**](docs/UsersApi.md#get_user_by_id) | **GET** /api/_private/users/{user_id} | Get a user by id +*UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /api/_private/users | Get all users +*UsersApi* | [**get_users_v1**](docs/UsersApi.md#get_users_v1) | **GET** /api/v1/users | Get all users. +*UsersApi* | [**remove_support_tenant**](docs/UsersApi.md#remove_support_tenant) | **POST** /api/_private/users/support-tenants/remove | Remove a support tenant +*UsersApi* | [**send_welcome_email**](docs/UsersApi.md#send_welcome_email) | **POST** /api/_private/users/{user_id}/welcome-email | Send a welcome email +*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **POST** /api/_private/users/{user_id} | Update a user + + +## Documentation For Models + + - [Access](docs/Access.md) + - [AddCommentsRequest](docs/AddCommentsRequest.md) + - [AddCommentsResponse](docs/AddCommentsResponse.md) + - [AddEmailsToBucketRequest](docs/AddEmailsToBucketRequest.md) + - [AddEmailsToBucketResponse](docs/AddEmailsToBucketResponse.md) + - [AddSupportTenantRequest](docs/AddSupportTenantRequest.md) + - [AddSupportTenantResponse](docs/AddSupportTenantResponse.md) + - [AdvanceStreamRequest](docs/AdvanceStreamRequest.md) + - [AdvanceStreamResponse](docs/AdvanceStreamResponse.md) + - [AdvanceTriggerRequest](docs/AdvanceTriggerRequest.md) + - [AdvanceTriggerResponse](docs/AdvanceTriggerResponse.md) + - [Alert](docs/Alert.md) + - [AlertConfig](docs/AlertConfig.md) + - [AlertConfigKind](docs/AlertConfigKind.md) + - [AlertFilter](docs/AlertFilter.md) + - [AlertIssuesResponse](docs/AlertIssuesResponse.md) + - [AlertMetric](docs/AlertMetric.md) + - [AlertNew](docs/AlertNew.md) + - [AlertProcessThreshold](docs/AlertProcessThreshold.md) + - [AlertProcessVariation](docs/AlertProcessVariation.md) + - [AlertSubscription](docs/AlertSubscription.md) + - [AlertUpdate](docs/AlertUpdate.md) + - [AmountFieldDataPrivate](docs/AmountFieldDataPrivate.md) + - [AnnotatedComment](docs/AnnotatedComment.md) + - [Annotation](docs/Annotation.md) + - [AnnotationLabel](docs/AnnotationLabel.md) + - [AnnotationMetadata](docs/AnnotationMetadata.md) + - [AnnotationMetadataCount](docs/AnnotationMetadataCount.md) + - [Annotations](docs/Annotations.md) + - [AppAccessModel](docs/AppAccessModel.md) + - [AppAccessModelKind](docs/AppAccessModelKind.md) + - [Application](docs/Application.md) + - [AssignedPredictedPresentFilter](docs/AssignedPredictedPresentFilter.md) + - [AssignmentMethod](docs/AssignmentMethod.md) + - [Attachment](docs/Attachment.md) + - [Attribute](docs/Attribute.md) + - [AttributeFilter](docs/AttributeFilter.md) + - [AttributeFilterAttribute](docs/AttributeFilterAttribute.md) + - [AttributionMethod](docs/AttributionMethod.md) + - [AuditEvent](docs/AuditEvent.md) + - [AuditEventsDataset](docs/AuditEventsDataset.md) + - [AuditEventsProject](docs/AuditEventsProject.md) + - [AuditEventsSource](docs/AuditEventsSource.md) + - [AuditEventsTenant](docs/AuditEventsTenant.md) + - [AuditEventsTrigger](docs/AuditEventsTrigger.md) + - [AuditEventsUser](docs/AuditEventsUser.md) + - [BinaryLabelHealthAction](docs/BinaryLabelHealthAction.md) + - [BinaryLabelHealthActionKind](docs/BinaryLabelHealthActionKind.md) + - [BinaryLabelHealthWarning](docs/BinaryLabelHealthWarning.md) + - [BinaryLabelHealthWarningKind](docs/BinaryLabelHealthWarningKind.md) + - [Binning](docs/Binning.md) + - [BoolFieldDataPrivate](docs/BoolFieldDataPrivate.md) + - [BoolFieldDataType](docs/BoolFieldDataType.md) + - [Breakdown](docs/Breakdown.md) + - [Bucket](docs/Bucket.md) + - [BucketNew](docs/BucketNew.md) + - [BucketStatistics](docs/BucketStatistics.md) + - [BucketSyncState](docs/BucketSyncState.md) + - [BucketUpdate](docs/BucketUpdate.md) + - [BucketUpdatedBy](docs/BucketUpdatedBy.md) + - [BuiltinLabelDef](docs/BuiltinLabelDef.md) + - [BuiltinLabelDefName](docs/BuiltinLabelDefName.md) + - [BuiltinLabelDefRequest](docs/BuiltinLabelDefRequest.md) + - [BusinessRule](docs/BusinessRule.md) + - [BusinessRuleComparisonOperator](docs/BusinessRuleComparisonOperator.md) + - [BusinessRuleLogicalOperator](docs/BusinessRuleLogicalOperator.md) + - [BusinessRuleSet](docs/BusinessRuleSet.md) + - [BusinessRuleSetCriticality](docs/BusinessRuleSetCriticality.md) + - [BusinessRuleType](docs/BusinessRuleType.md) + - [ByLabels](docs/ByLabels.md) + - [ByLabelsInclude](docs/ByLabelsInclude.md) + - [ByLabelsIncludeContainer](docs/ByLabelsIncludeContainer.md) + - [ByLabelsTop](docs/ByLabelsTop.md) + - [ByLabelsTopContainer](docs/ByLabelsTopContainer.md) + - [CaptureThreshold](docs/CaptureThreshold.md) + - [ChoiceFieldDataPrivate](docs/ChoiceFieldDataPrivate.md) + - [ChoiceFieldDataType](docs/ChoiceFieldDataType.md) + - [ClientSecretApplicationModel](docs/ClientSecretApplicationModel.md) + - [ClientSecretApplicationModelKind](docs/ClientSecretApplicationModelKind.md) + - [CmModelConfig](docs/CmModelConfig.md) + - [Comment](docs/Comment.md) + - [CommentExtractionsPredictions](docs/CommentExtractionsPredictions.md) + - [CommentFilter](docs/CommentFilter.md) + - [CommentNew](docs/CommentNew.md) + - [CommentPrediction](docs/CommentPrediction.md) + - [CommentSentiment](docs/CommentSentiment.md) + - [CommentSpanNewChar](docs/CommentSpanNewChar.md) + - [CommentSpanNewUtf16](docs/CommentSpanNewUtf16.md) + - [CommentThread](docs/CommentThread.md) + - [Comparison](docs/Comparison.md) + - [ConnectionModel](docs/ConnectionModel.md) + - [ContentPart](docs/ContentPart.md) + - [Contribution](docs/Contribution.md) + - [Contributor](docs/Contributor.md) + - [ContributorKind](docs/ContributorKind.md) + - [ConversationalFilterRequest](docs/ConversationalFilterRequest.md) + - [ConversationalFilterResponse](docs/ConversationalFilterResponse.md) + - [Coocurrence](docs/Coocurrence.md) + - [CoocurrenceLabels](docs/CoocurrenceLabels.md) + - [Count](docs/Count.md) + - [CreateAlertRequest](docs/CreateAlertRequest.md) + - [CreateAlertResponse](docs/CreateAlertResponse.md) + - [CreateBucketRequest](docs/CreateBucketRequest.md) + - [CreateBucketResponse](docs/CreateBucketResponse.md) + - [CreateDashboardRequest](docs/CreateDashboardRequest.md) + - [CreateDashboardResponse](docs/CreateDashboardResponse.md) + - [CreateDatasetRequest](docs/CreateDatasetRequest.md) + - [CreateDatasetResponse](docs/CreateDatasetResponse.md) + - [CreateIntegrationRequest](docs/CreateIntegrationRequest.md) + - [CreateIntegrationResponse](docs/CreateIntegrationResponse.md) + - [CreateIxpDatasetRequest](docs/CreateIxpDatasetRequest.md) + - [CreateIxpDatasetResponse](docs/CreateIxpDatasetResponse.md) + - [CreateLabelDefsBulkResponse](docs/CreateLabelDefsBulkResponse.md) + - [CreateLabelGroupRequest](docs/CreateLabelGroupRequest.md) + - [CreateLabelGroupResponse](docs/CreateLabelGroupResponse.md) + - [CreateOrUpdateLabelDefsBulkRequest](docs/CreateOrUpdateLabelDefsBulkRequest.md) + - [CreateOrUpdateLabelDefsBulkRequestLabelDefsInner](docs/CreateOrUpdateLabelDefsBulkRequestLabelDefsInner.md) + - [CreatePageViewRequest](docs/CreatePageViewRequest.md) + - [CreatePageViewResponse](docs/CreatePageViewResponse.md) + - [CreateProjectRequest](docs/CreateProjectRequest.md) + - [CreateProjectResponse](docs/CreateProjectResponse.md) + - [CreateProjectSetupCreatedResponse](docs/CreateProjectSetupCreatedResponse.md) + - [CreateProjectSetupRequest](docs/CreateProjectSetupRequest.md) + - [CreateProjectSetupResponse](docs/CreateProjectSetupResponse.md) + - [CreateSourceRequest](docs/CreateSourceRequest.md) + - [CreateSourceResponse](docs/CreateSourceResponse.md) + - [CreateStreamRequest](docs/CreateStreamRequest.md) + - [CreateStreamResponse](docs/CreateStreamResponse.md) + - [CreateTenantRequest](docs/CreateTenantRequest.md) + - [CreateTenantResponse](docs/CreateTenantResponse.md) + - [CreateTriggerRequest](docs/CreateTriggerRequest.md) + - [CreateTriggerResponse](docs/CreateTriggerResponse.md) + - [CreateUserRequest](docs/CreateUserRequest.md) + - [CreateUserResponse](docs/CreateUserResponse.md) + - [CustomAction](docs/CustomAction.md) + - [CustomTrainingAction](docs/CustomTrainingAction.md) + - [Dashboard](docs/Dashboard.md) + - [DashboardUpdate](docs/DashboardUpdate.md) + - [Data](docs/Data.md) + - [DataType](docs/DataType.md) + - [DataTypeDate](docs/DataTypeDate.md) + - [DataTypeMoney](docs/DataTypeMoney.md) + - [DataTypeNumber](docs/DataTypeNumber.md) + - [DataTypeText](docs/DataTypeText.md) + - [Dataset](docs/Dataset.md) + - [DatasetFlag](docs/DatasetFlag.md) + - [DatasetNew](docs/DatasetNew.md) + - [DatasetOperation](docs/DatasetOperation.md) + - [DatasetQuality](docs/DatasetQuality.md) + - [DatasetStatus](docs/DatasetStatus.md) + - [DatasetStringSummaryValue](docs/DatasetStringSummaryValue.md) + - [DatasetSummary](docs/DatasetSummary.md) + - [DatasetTrainingAction](docs/DatasetTrainingAction.md) + - [DatasetUpdate](docs/DatasetUpdate.md) + - [DatasetUpdateEntityDefsInner](docs/DatasetUpdateEntityDefsInner.md) + - [DatasetUserPropertiesSummary](docs/DatasetUserPropertiesSummary.md) + - [DatasetUserPropertiesSummaryNumber](docs/DatasetUserPropertiesSummaryNumber.md) + - [DatasetUserPropertiesSummaryString](docs/DatasetUserPropertiesSummaryString.md) + - [DateFieldDataPrivate](docs/DateFieldDataPrivate.md) + - [DateFieldDataType](docs/DateFieldDataType.md) + - [DeleteAlertResponse](docs/DeleteAlertResponse.md) + - [DeleteAlertSubscriptionReponse](docs/DeleteAlertSubscriptionReponse.md) + - [DeleteBucketResponse](docs/DeleteBucketResponse.md) + - [DeleteCommentResponse](docs/DeleteCommentResponse.md) + - [DeleteDashboardResponse](docs/DeleteDashboardResponse.md) + - [DeleteDatasetByIdResponse](docs/DeleteDatasetByIdResponse.md) + - [DeleteDatasetResponse](docs/DeleteDatasetResponse.md) + - [DeleteIntegrationResponse](docs/DeleteIntegrationResponse.md) + - [DeleteIxpDatasetResponse](docs/DeleteIxpDatasetResponse.md) + - [DeleteKeyedSyncStateResponse](docs/DeleteKeyedSyncStateResponse.md) + - [DeleteLabelDefResponse](docs/DeleteLabelDefResponse.md) + - [DeleteLabelGroupResponse](docs/DeleteLabelGroupResponse.md) + - [DeleteModelTagResponse](docs/DeleteModelTagResponse.md) + - [DeleteProjectResponse](docs/DeleteProjectResponse.md) + - [DeleteSourceResponse](docs/DeleteSourceResponse.md) + - [DeleteStreamExceptionResponse](docs/DeleteStreamExceptionResponse.md) + - [DeleteStreamResponse](docs/DeleteStreamResponse.md) + - [DeleteTenantDefaultProjectPermissionsResponse](docs/DeleteTenantDefaultProjectPermissionsResponse.md) + - [DeleteTenantResponse](docs/DeleteTenantResponse.md) + - [DeleteTriggerResponse](docs/DeleteTriggerResponse.md) + - [DeleteUserResponse](docs/DeleteUserResponse.md) + - [DeprecatedUserModelMetadata](docs/DeprecatedUserModelMetadata.md) + - [Diagnostic](docs/Diagnostic.md) + - [DiagnosticKind](docs/DiagnosticKind.md) + - [Direction](docs/Direction.md) + - [DisableIntegrationAction](docs/DisableIntegrationAction.md) + - [DisableMailboxAction](docs/DisableMailboxAction.md) + - [DocPathIxpModelConfig](docs/DocPathIxpModelConfig.md) + - [DocumentLabelPropertyPrediction](docs/DocumentLabelPropertyPrediction.md) + - [DocumentSearchResult](docs/DocumentSearchResult.md) + - [DocumentSpan](docs/DocumentSpan.md) + - [Email](docs/Email.md) + - [EmailMetadata](docs/EmailMetadata.md) + - [EmailMetadataNew](docs/EmailMetadataNew.md) + - [EmailNew](docs/EmailNew.md) + - [EmailPropertiesSummary](docs/EmailPropertiesSummary.md) + - [EmailPropertiesSummaryByProperty](docs/EmailPropertiesSummaryByProperty.md) + - [EmailPropertiesSummaryValue](docs/EmailPropertiesSummaryValue.md) + - [EmailPropertyCounts](docs/EmailPropertyCounts.md) + - [EmailPropertyCountsByProperty](docs/EmailPropertyCountsByProperty.md) + - [EmailPropertyCountsSettings](docs/EmailPropertyCountsSettings.md) + - [EmailPropertyCountsSettingsByProperty](docs/EmailPropertyCountsSettingsByProperty.md) + - [EmailTransformTagInfo](docs/EmailTransformTagInfo.md) + - [Entities](docs/Entities.md) + - [EntitiesNew](docs/EntitiesNew.md) + - [EntitiesPrStats](docs/EntitiesPrStats.md) + - [EntitiesRules](docs/EntitiesRules.md) + - [EntitiesRulesPresenceInner](docs/EntitiesRulesPresenceInner.md) + - [Entity](docs/Entity.md) + - [EntityAverageStats](docs/EntityAverageStats.md) + - [EntityDef](docs/EntityDef.md) + - [EntityDefFlag](docs/EntityDefFlag.md) + - [EntityDefIdStat](docs/EntityDefIdStat.md) + - [EntityDefNew](docs/EntityDefNew.md) + - [EntityDefSummary](docs/EntityDefSummary.md) + - [EntityDefUpdate](docs/EntityDefUpdate.md) + - [EntityDefUpdateInheritsFromInner](docs/EntityDefUpdateInheritsFromInner.md) + - [EntityHealth](docs/EntityHealth.md) + - [EntityHealthAction](docs/EntityHealthAction.md) + - [EntityHealthActionKind](docs/EntityHealthActionKind.md) + - [EntityHealthSmart](docs/EntityHealthSmart.md) + - [EntityHealthWarning](docs/EntityHealthWarning.md) + - [EntityHealthWarningKind](docs/EntityHealthWarningKind.md) + - [EntityKind](docs/EntityKind.md) + - [EntityNew](docs/EntityNew.md) + - [EntityNewSpansInner](docs/EntityNewSpansInner.md) + - [EntityPresenceFilter](docs/EntityPresenceFilter.md) + - [EntityPresenceFilterWithKind](docs/EntityPresenceFilterWithKind.md) + - [EntityRuleSetApi](docs/EntityRuleSetApi.md) + - [EntityRuleSetNewApi](docs/EntityRuleSetNewApi.md) + - [EntityRuleSetUpdateApi](docs/EntityRuleSetUpdateApi.md) + - [EntityRuleSetUpdateApiChoicesInner](docs/EntityRuleSetUpdateApiChoicesInner.md) + - [EntitySummaryV1](docs/EntitySummaryV1.md) + - [EntityTemplatePropertiesApi](docs/EntityTemplatePropertiesApi.md) + - [EntityTemplatesPropertiesApi](docs/EntityTemplatesPropertiesApi.md) + - [ErrorAction](docs/ErrorAction.md) + - [ErrorResponse](docs/ErrorResponse.md) + - [EwsApiModel](docs/EwsApiModel.md) + - [EwsApiModelKind](docs/EwsApiModelKind.md) + - [ExactBucketCount](docs/ExactBucketCount.md) + - [ExceptionModel](docs/ExceptionModel.md) + - [ExportDatasetRequest](docs/ExportDatasetRequest.md) + - [ExportDatasetResponse](docs/ExportDatasetResponse.md) + - [ExportedAnnotations](docs/ExportedAnnotations.md) + - [ExportedComment](docs/ExportedComment.md) + - [ExportedLabel](docs/ExportedLabel.md) + - [ExportedLabels](docs/ExportedLabels.md) + - [ExportedPredictions](docs/ExportedPredictions.md) + - [ExtractionFieldDefinition](docs/ExtractionFieldDefinition.md) + - [ExtractionPrediction](docs/ExtractionPrediction.md) + - [FetchFromGxStreamRequest](docs/FetchFromGxStreamRequest.md) + - [FetchFromGxStreamResponse](docs/FetchFromGxStreamResponse.md) + - [FetchFromStreamRequest](docs/FetchFromStreamRequest.md) + - [FetchFromStreamResponse](docs/FetchFromStreamResponse.md) + - [FieldAnnotationPrivate](docs/FieldAnnotationPrivate.md) + - [FieldChoiceApi](docs/FieldChoiceApi.md) + - [FieldChoiceNewApi](docs/FieldChoiceNewApi.md) + - [FieldGroupAnnotationPrivate](docs/FieldGroupAnnotationPrivate.md) + - [FieldGroupPredictionPrivate](docs/FieldGroupPredictionPrivate.md) + - [FieldGroupSnapshot](docs/FieldGroupSnapshot.md) + - [FieldGroupVersionEntry](docs/FieldGroupVersionEntry.md) + - [FieldPredictionPrivate](docs/FieldPredictionPrivate.md) + - [FieldSnapshot](docs/FieldSnapshot.md) + - [FieldType](docs/FieldType.md) + - [FieldUipathContextModel](docs/FieldUipathContextModel.md) + - [FieldValuePrivate](docs/FieldValuePrivate.md) + - [FieldVersionEntry](docs/FieldVersionEntry.md) + - [Filter](docs/Filter.md) + - [Freshness](docs/Freshness.md) + - [FullParticipantFilter](docs/FullParticipantFilter.md) + - [GeminiTableOnlyConfig](docs/GeminiTableOnlyConfig.md) + - [GeneralFieldDef](docs/GeneralFieldDef.md) + - [GeneralFieldDefNew](docs/GeneralFieldDefNew.md) + - [GeneralFieldDefUpdate](docs/GeneralFieldDefUpdate.md) + - [GeneralFieldDefinition](docs/GeneralFieldDefinition.md) + - [GetAlertResponse](docs/GetAlertResponse.md) + - [GetAlertSubscriptionsResponse](docs/GetAlertSubscriptionsResponse.md) + - [GetAllAlertsResponse](docs/GetAllAlertsResponse.md) + - [GetAllBucketsResponse](docs/GetAllBucketsResponse.md) + - [GetAllDashboardsInDatasetResponse](docs/GetAllDashboardsInDatasetResponse.md) + - [GetAllDashboardsInProjectResponse](docs/GetAllDashboardsInProjectResponse.md) + - [GetAllDatasetsInProjectResponse](docs/GetAllDatasetsInProjectResponse.md) + - [GetAllDatasetsResponse](docs/GetAllDatasetsResponse.md) + - [GetAllIntegrationsInProjectResponse](docs/GetAllIntegrationsInProjectResponse.md) + - [GetAllIntegrationsResponse](docs/GetAllIntegrationsResponse.md) + - [GetAllIxpModelsInProjectResponse](docs/GetAllIxpModelsInProjectResponse.md) + - [GetAllIxpProjectsResponse](docs/GetAllIxpProjectsResponse.md) + - [GetAllLabelGroupsResponse](docs/GetAllLabelGroupsResponse.md) + - [GetAllModelsInDatasetRequest](docs/GetAllModelsInDatasetRequest.md) + - [GetAllModelsInDatasetResponse](docs/GetAllModelsInDatasetResponse.md) + - [GetAllProjectsResponse](docs/GetAllProjectsResponse.md) + - [GetAllProjectsV1Response](docs/GetAllProjectsV1Response.md) + - [GetAllSourcesInProjectResponse](docs/GetAllSourcesInProjectResponse.md) + - [GetAllSourcesResponse](docs/GetAllSourcesResponse.md) + - [GetAllStreamsResponse](docs/GetAllStreamsResponse.md) + - [GetAllTriggersInDatasetResponse](docs/GetAllTriggersInDatasetResponse.md) + - [GetBucketByIdResponse](docs/GetBucketByIdResponse.md) + - [GetBucketEmailsRequest](docs/GetBucketEmailsRequest.md) + - [GetBucketEmailsResponse](docs/GetBucketEmailsResponse.md) + - [GetBucketResponse](docs/GetBucketResponse.md) + - [GetBucketStatisticsResponse](docs/GetBucketStatisticsResponse.md) + - [GetBucketSyncStateResponse](docs/GetBucketSyncStateResponse.md) + - [GetBucketsByOwnerResponse](docs/GetBucketsByOwnerResponse.md) + - [GetCommentPredictionsRequest](docs/GetCommentPredictionsRequest.md) + - [GetCommentPredictionsResponse](docs/GetCommentPredictionsResponse.md) + - [GetCommentResponse](docs/GetCommentResponse.md) + - [GetComparisonRequest](docs/GetComparisonRequest.md) + - [GetComparisonResponse](docs/GetComparisonResponse.md) + - [GetDashboardResponse](docs/GetDashboardResponse.md) + - [GetDatasetResponse](docs/GetDatasetResponse.md) + - [GetDatasetStatisticsRequest](docs/GetDatasetStatisticsRequest.md) + - [GetDatasetStatisticsResponse](docs/GetDatasetStatisticsResponse.md) + - [GetDatasetStatusResponse](docs/GetDatasetStatusResponse.md) + - [GetDatasetSummaryRequest](docs/GetDatasetSummaryRequest.md) + - [GetDatasetSummaryResponse](docs/GetDatasetSummaryResponse.md) + - [GetDatasetUserPropertiesSummaryResponse](docs/GetDatasetUserPropertiesSummaryResponse.md) + - [GetDeprecatedUserModelsResponse](docs/GetDeprecatedUserModelsResponse.md) + - [GetDerivedPermissionResponse](docs/GetDerivedPermissionResponse.md) + - [GetDerivedPermissionsRequest](docs/GetDerivedPermissionsRequest.md) + - [GetDocumentMetadataResponse](docs/GetDocumentMetadataResponse.md) + - [GetDocumentSearchResponse](docs/GetDocumentSearchResponse.md) + - [GetEmailFromBucketByIdResponse](docs/GetEmailFromBucketByIdResponse.md) + - [GetEmailTransformTagInfoResponse](docs/GetEmailTransformTagInfoResponse.md) + - [GetFieldGroupHistoryResponse](docs/GetFieldGroupHistoryResponse.md) + - [GetFieldHistoryResponse](docs/GetFieldHistoryResponse.md) + - [GetIntegrationByIdResponse](docs/GetIntegrationByIdResponse.md) + - [GetIntegrationErrorsResponse](docs/GetIntegrationErrorsResponse.md) + - [GetIntegrationResponse](docs/GetIntegrationResponse.md) + - [GetIssueResponse](docs/GetIssueResponse.md) + - [GetIxpConsumabilityInfoResponse](docs/GetIxpConsumabilityInfoResponse.md) + - [GetIxpProjectResponse](docs/GetIxpProjectResponse.md) + - [GetKeyedSyncStateResponse](docs/GetKeyedSyncStateResponse.md) + - [GetLabelDefResponse](docs/GetLabelDefResponse.md) + - [GetLabelGroupResponse](docs/GetLabelGroupResponse.md) + - [GetLabelValidationRequest](docs/GetLabelValidationRequest.md) + - [GetLabelValidationResponse](docs/GetLabelValidationResponse.md) + - [GetLabellingsResponse](docs/GetLabellingsResponse.md) + - [GetModelTagsResponse](docs/GetModelTagsResponse.md) + - [GetPageSelectionsResponse](docs/GetPageSelectionsResponse.md) + - [GetPretrainedLabelsResponse](docs/GetPretrainedLabelsResponse.md) + - [GetProjectResourceCountsResponse](docs/GetProjectResourceCountsResponse.md) + - [GetProjectResponse](docs/GetProjectResponse.md) + - [GetQualifiedLoginUrlRequest](docs/GetQualifiedLoginUrlRequest.md) + - [GetQualifiedLoginUrlResponse](docs/GetQualifiedLoginUrlResponse.md) + - [GetQuotasForTenantResponse](docs/GetQuotasForTenantResponse.md) + - [GetReducedPermissionsRequest](docs/GetReducedPermissionsRequest.md) + - [GetReducedPermissionsResponse](docs/GetReducedPermissionsResponse.md) + - [GetReducedPermissionsResponsePermissionsInner](docs/GetReducedPermissionsResponsePermissionsInner.md) + - [GetSourceByIdResponse](docs/GetSourceByIdResponse.md) + - [GetSourceCommentsResponse](docs/GetSourceCommentsResponse.md) + - [GetSourceCommentsResponseThreadPropertiesInner](docs/GetSourceCommentsResponseThreadPropertiesInner.md) + - [GetSourceResponse](docs/GetSourceResponse.md) + - [GetSourceStatisticsRequest](docs/GetSourceStatisticsRequest.md) + - [GetSourceStatisticsResponse](docs/GetSourceStatisticsResponse.md) + - [GetStreamByNameResponse](docs/GetStreamByNameResponse.md) + - [GetStreamResultsResponse](docs/GetStreamResultsResponse.md) + - [GetSubdomainResponse](docs/GetSubdomainResponse.md) + - [GetTenantClientSubnetsResponse](docs/GetTenantClientSubnetsResponse.md) + - [GetTenantDefaultProjectPermissionsResponse](docs/GetTenantDefaultProjectPermissionsResponse.md) + - [GetTenantDomainsResponse](docs/GetTenantDomainsResponse.md) + - [GetTenantEntityDefIdsResponse](docs/GetTenantEntityDefIdsResponse.md) + - [GetTenantQuotaResponse](docs/GetTenantQuotaResponse.md) + - [GetTenantsResponse](docs/GetTenantsResponse.md) + - [GetThemesResponse](docs/GetThemesResponse.md) + - [GetThreadThemesRequest](docs/GetThreadThemesRequest.md) + - [GetThreadThemesResponse](docs/GetThreadThemesResponse.md) + - [GetThreadsBySourceResponse](docs/GetThreadsBySourceResponse.md) + - [GetTrainingActionsCommentUidsResponse](docs/GetTrainingActionsCommentUidsResponse.md) + - [GetTrainingActionsLabelsResponse](docs/GetTrainingActionsLabelsResponse.md) + - [GetTrainingActionsLabelsResponseTrainingActionsLabelsInner](docs/GetTrainingActionsLabelsResponseTrainingActionsLabelsInner.md) + - [GetTriggerResponse](docs/GetTriggerResponse.md) + - [GetUserByIdResponse](docs/GetUserByIdResponse.md) + - [GetUsersResponse](docs/GetUsersResponse.md) + - [GetUsersV1Response](docs/GetUsersV1Response.md) + - [GetValidationResponse](docs/GetValidationResponse.md) + - [GetValidationV1Response](docs/GetValidationV1Response.md) + - [GlobalPermission](docs/GlobalPermission.md) + - [GptIxpFlag](docs/GptIxpFlag.md) + - [GptIxpModelConfig](docs/GptIxpModelConfig.md) + - [GptModelVersion](docs/GptModelVersion.md) + - [GraphApiModel](docs/GraphApiModel.md) + - [GraphApiModelKind](docs/GraphApiModelKind.md) + - [GroupLabellingsRequest](docs/GroupLabellingsRequest.md) + - [GroupPredictions](docs/GroupPredictions.md) + - [Headers](docs/Headers.md) + - [Highlight](docs/Highlight.md) + - [HistogramBin](docs/HistogramBin.md) + - [ImageInputConfig](docs/ImageInputConfig.md) + - [ImportTaxonomyRequest](docs/ImportTaxonomyRequest.md) + - [ImportTaxonomyResponse](docs/ImportTaxonomyResponse.md) + - [InferenceStats](docs/InferenceStats.md) + - [InheritsFrom](docs/InheritsFrom.md) + - [InputConfig](docs/InputConfig.md) + - [Integration](docs/Integration.md) + - [IntegrationDisabledReason](docs/IntegrationDisabledReason.md) + - [IntegrationError](docs/IntegrationError.md) + - [IntegrationErrorDetails](docs/IntegrationErrorDetails.md) + - [IntegrationNew](docs/IntegrationNew.md) + - [IntegrationType](docs/IntegrationType.md) + - [IntegrationUpdate](docs/IntegrationUpdate.md) + - [IntegrationsOAuth2AuthenticateResponse](docs/IntegrationsOAuth2AuthenticateResponse.md) + - [IntentThreshold](docs/IntentThreshold.md) + - [IntentValidation](docs/IntentValidation.md) + - [IntentValidationSummary](docs/IntentValidationSummary.md) + - [IntentsValue](docs/IntentsValue.md) + - [InterpretationSpan](docs/InterpretationSpan.md) + - [Issue](docs/Issue.md) + - [IssueDetail](docs/IssueDetail.md) + - [IssueStatus](docs/IssueStatus.md) + - [IterativeConfig](docs/IterativeConfig.md) + - [IxpConfidence](docs/IxpConfidence.md) + - [IxpDatasetNew](docs/IxpDatasetNew.md) + - [IxpExtractionStatus](docs/IxpExtractionStatus.md) + - [IxpField](docs/IxpField.md) + - [IxpFieldGroup](docs/IxpFieldGroup.md) + - [IxpFieldType](docs/IxpFieldType.md) + - [IxpModelMetadata](docs/IxpModelMetadata.md) + - [IxpPredictExtractionsResponse](docs/IxpPredictExtractionsResponse.md) + - [IxpProject](docs/IxpProject.md) + - [IxpRelativeUrls](docs/IxpRelativeUrls.md) + - [IxpTaxonomy](docs/IxpTaxonomy.md) + - [IxpTaxonomyExtraction](docs/IxpTaxonomyExtraction.md) + - [IxpUploadDocumentResponse](docs/IxpUploadDocumentResponse.md) + - [IxpUploadedDocument](docs/IxpUploadedDocument.md) + - [KeyedFolderSyncState](docs/KeyedFolderSyncState.md) + - [KeyedFolderSyncStateUpdate](docs/KeyedFolderSyncStateUpdate.md) + - [KeyedMailboxSyncState](docs/KeyedMailboxSyncState.md) + - [KeyedMailboxSyncStateUpdate](docs/KeyedMailboxSyncStateUpdate.md) + - [KeyedSyncState](docs/KeyedSyncState.md) + - [KeyedSyncState1](docs/KeyedSyncState1.md) + - [Label](docs/Label.md) + - [LabelAction](docs/LabelAction.md) + - [LabelCollection](docs/LabelCollection.md) + - [LabelComparison](docs/LabelComparison.md) + - [LabelCounts](docs/LabelCounts.md) + - [LabelDef](docs/LabelDef.md) + - [LabelDefFlag](docs/LabelDefFlag.md) + - [LabelDefNew](docs/LabelDefNew.md) + - [LabelDefProperty](docs/LabelDefProperty.md) + - [LabelDefUpdate](docs/LabelDefUpdate.md) + - [LabelDefUpdateMoonFormInner](docs/LabelDefUpdateMoonFormInner.md) + - [LabelDefUpdateRequest](docs/LabelDefUpdateRequest.md) + - [LabelDefinition](docs/LabelDefinition.md) + - [LabelGroup](docs/LabelGroup.md) + - [LabelGroupNew](docs/LabelGroupNew.md) + - [LabelHealth](docs/LabelHealth.md) + - [LabelHealthAction](docs/LabelHealthAction.md) + - [LabelHealthSmart](docs/LabelHealthSmart.md) + - [LabelHealthWarning](docs/LabelHealthWarning.md) + - [LabelMetrics](docs/LabelMetrics.md) + - [LabelNameOnlyResponse](docs/LabelNameOnlyResponse.md) + - [LabelPropertiesDigest](docs/LabelPropertiesDigest.md) + - [LabelProperty](docs/LabelProperty.md) + - [LabelPropertyDigest](docs/LabelPropertyDigest.md) + - [LabelPropertyId](docs/LabelPropertyId.md) + - [LabelPropertyName](docs/LabelPropertyName.md) + - [LabelPropertySummary](docs/LabelPropertySummary.md) + - [LabelPropertySummaryLabel](docs/LabelPropertySummaryLabel.md) + - [LabelPropertyTimeSeriesRow](docs/LabelPropertyTimeSeriesRow.md) + - [LabelSentiment](docs/LabelSentiment.md) + - [LabelSuggestionReasoning](docs/LabelSuggestionReasoning.md) + - [LabelSummaryV1](docs/LabelSummaryV1.md) + - [LabelTimeseriesEntry](docs/LabelTimeseriesEntry.md) + - [LabelTrainingAction](docs/LabelTrainingAction.md) + - [LabelValidationSummary](docs/LabelValidationSummary.md) + - [LabellingGroup](docs/LabellingGroup.md) + - [Language](docs/Language.md) + - [LegacyEntityPatternApi](docs/LegacyEntityPatternApi.md) + - [ListKeyedSyncStatesResponse](docs/ListKeyedSyncStatesResponse.md) + - [ListKeyedSyncStatesResponseKeyedSyncStatesInner](docs/ListKeyedSyncStatesResponseKeyedSyncStatesInner.md) + - [Locales](docs/Locales.md) + - [LocalesPreferences](docs/LocalesPreferences.md) + - [LowerBoundBucketCount](docs/LowerBoundBucketCount.md) + - [MarkupBreak](docs/MarkupBreak.md) + - [MarkupBreakKind](docs/MarkupBreakKind.md) + - [MarkupImage](docs/MarkupImage.md) + - [MarkupLink](docs/MarkupLink.md) + - [MarkupList](docs/MarkupList.md) + - [MarkupListItem](docs/MarkupListItem.md) + - [MarkupListKind](docs/MarkupListKind.md) + - [MarkupParagraph](docs/MarkupParagraph.md) + - [MarkupParagraphKind](docs/MarkupParagraphKind.md) + - [MarkupStyle](docs/MarkupStyle.md) + - [MarkupStyleKind](docs/MarkupStyleKind.md) + - [MarkupTable](docs/MarkupTable.md) + - [MarkupTableCaption](docs/MarkupTableCaption.md) + - [MarkupTableCell](docs/MarkupTableCell.md) + - [MarkupTableCellChildrenInner](docs/MarkupTableCellChildrenInner.md) + - [MarkupTableCellKind](docs/MarkupTableCellKind.md) + - [MarkupTableRow](docs/MarkupTableRow.md) + - [MarkupTableSectionKind](docs/MarkupTableSectionKind.md) + - [MarkupText](docs/MarkupText.md) + - [MatchedFieldGroupExtractions](docs/MatchedFieldGroupExtractions.md) + - [MeanPrCurve](docs/MeanPrCurve.md) + - [Message](docs/Message.md) + - [MessageFilter](docs/MessageFilter.md) + - [MessageRichText](docs/MessageRichText.md) + - [MessageRichTextTextMarkupInner](docs/MessageRichTextTextMarkupInner.md) + - [MessageSpan](docs/MessageSpan.md) + - [MessageText](docs/MessageText.md) + - [Metadata](docs/Metadata.md) + - [MicrosoftApi](docs/MicrosoftApi.md) + - [ModelConfig](docs/ModelConfig.md) + - [ModelDefinition](docs/ModelDefinition.md) + - [ModelError](docs/ModelError.md) + - [ModelErrorKind](docs/ModelErrorKind.md) + - [ModelFamily](docs/ModelFamily.md) + - [ModelName](docs/ModelName.md) + - [ModelRating](docs/ModelRating.md) + - [ModelRatingAction](docs/ModelRatingAction.md) + - [ModelRatingFactor](docs/ModelRatingFactor.md) + - [ModelRatingFactorKind](docs/ModelRatingFactorKind.md) + - [ModelTaxonomy](docs/ModelTaxonomy.md) + - [MonetaryFieldDataPrivate](docs/MonetaryFieldDataPrivate.md) + - [MonetaryQuantityFieldDataType](docs/MonetaryQuantityFieldDataType.md) + - [MoonFormCaptureFieldsAnnotation](docs/MoonFormCaptureFieldsAnnotation.md) + - [MoonFormCaptureFieldsAnnotationNew](docs/MoonFormCaptureFieldsAnnotationNew.md) + - [MoonFormCaptureFieldsPrediction](docs/MoonFormCaptureFieldsPrediction.md) + - [MoonFormDismissedUpdate](docs/MoonFormDismissedUpdate.md) + - [MoonFormFieldAnnotation](docs/MoonFormFieldAnnotation.md) + - [MoonFormFieldAnnotationNew](docs/MoonFormFieldAnnotationNew.md) + - [MoonFormFieldDef](docs/MoonFormFieldDef.md) + - [MoonFormFieldDefNew](docs/MoonFormFieldDefNew.md) + - [MoonFormFieldDefUpdate](docs/MoonFormFieldDefUpdate.md) + - [MoonFormFieldPrediction](docs/MoonFormFieldPrediction.md) + - [MoonFormGroup](docs/MoonFormGroup.md) + - [MoonFormGroupUpdate](docs/MoonFormGroupUpdate.md) + - [MoonFormLabelAnnotation](docs/MoonFormLabelAnnotation.md) + - [MoonFormLabelAnnotationUpdate](docs/MoonFormLabelAnnotationUpdate.md) + - [MoonFormLabelPrediction](docs/MoonFormLabelPrediction.md) + - [MoonIntentFieldsMetrics](docs/MoonIntentFieldsMetrics.md) + - [MoonIntentValidationRequest](docs/MoonIntentValidationRequest.md) + - [MoonSummaryMetrics](docs/MoonSummaryMetrics.md) + - [MoonValidation](docs/MoonValidation.md) + - [Name](docs/Name.md) + - [NewDashboard](docs/NewDashboard.md) + - [NoUiMetadataReason](docs/NoUiMetadataReason.md) + - [NpsSummary](docs/NpsSummary.md) + - [NtlmApplicationModel](docs/NtlmApplicationModel.md) + - [NtlmApplicationModelKind](docs/NtlmApplicationModelKind.md) + - [NullableStringArrayFilter](docs/NullableStringArrayFilter.md) + - [NumberFieldDataType](docs/NumberFieldDataType.md) + - [NumberOneOfFilter](docs/NumberOneOfFilter.md) + - [NumberRangeFilter](docs/NumberRangeFilter.md) + - [NumberRangeFilterWithKind](docs/NumberRangeFilterWithKind.md) + - [NumberUserPropertySummary](docs/NumberUserPropertySummary.md) + - [OAuth2SalesforceCallbackRequest](docs/OAuth2SalesforceCallbackRequest.md) + - [OAuth2SalesforceCallbackResponse](docs/OAuth2SalesforceCallbackResponse.md) + - [OptimalThreshold](docs/OptimalThreshold.md) + - [Order](docs/Order.md) + - [PageDimensions](docs/PageDimensions.md) + - [PageMetadata](docs/PageMetadata.md) + - [PagePolygon](docs/PagePolygon.md) + - [PageSelection](docs/PageSelection.md) + - [ParseEmailNewComment](docs/ParseEmailNewComment.md) + - [ParsedValue](docs/ParsedValue.md) + - [Period](docs/Period.md) + - [PinModelResponse](docs/PinModelResponse.md) + - [PollTriggerRequest](docs/PollTriggerRequest.md) + - [PollTriggerResponse](docs/PollTriggerResponse.md) + - [PrCurve](docs/PrCurve.md) + - [PredictDocument](docs/PredictDocument.md) + - [PredictExtractionsRequest](docs/PredictExtractionsRequest.md) + - [PredictExtractionsResponse](docs/PredictExtractionsResponse.md) + - [PredictLatestRequest](docs/PredictLatestRequest.md) + - [PredictLatestResponse](docs/PredictLatestResponse.md) + - [PredictRawEmailsRequest](docs/PredictRawEmailsRequest.md) + - [PredictRawEmailsResponse](docs/PredictRawEmailsResponse.md) + - [PredictRequest](docs/PredictRequest.md) + - [PredictResponse](docs/PredictResponse.md) + - [PredictedEntity](docs/PredictedEntity.md) + - [PredictedLabel](docs/PredictedLabel.md) + - [PredictedLabelProperty](docs/PredictedLabelProperty.md) + - [PredictionsModel](docs/PredictionsModel.md) + - [Preference](docs/Preference.md) + - [PreferredLocale](docs/PreferredLocale.md) + - [PreviewAlertRequest](docs/PreviewAlertRequest.md) + - [PreviewAlertResponse](docs/PreviewAlertResponse.md) + - [PrivateKeyApplicationModel](docs/PrivateKeyApplicationModel.md) + - [PrivateKeyApplicationModelKind](docs/PrivateKeyApplicationModelKind.md) + - [Process](docs/Process.md) + - [Project](docs/Project.md) + - [ProjectNew](docs/ProjectNew.md) + - [ProjectPermission](docs/ProjectPermission.md) + - [ProjectSetupExistingSource](docs/ProjectSetupExistingSource.md) + - [ProjectSetupNewDataset](docs/ProjectSetupNewDataset.md) + - [ProjectSetupNewProject](docs/ProjectSetupNewProject.md) + - [ProjectSetupNewSource](docs/ProjectSetupNewSource.md) + - [ProjectSetupNewStream](docs/ProjectSetupNewStream.md) + - [ProjectSetupNewUsers](docs/ProjectSetupNewUsers.md) + - [ProjectV1](docs/ProjectV1.md) + - [PutCommentAsSeenRequest](docs/PutCommentAsSeenRequest.md) + - [PutCommentAsSeenResponse](docs/PutCommentAsSeenResponse.md) + - [QueryAuditEventsFilter](docs/QueryAuditEventsFilter.md) + - [QueryAuditEventsRequest](docs/QueryAuditEventsRequest.md) + - [QueryAuditEventsResponse](docs/QueryAuditEventsResponse.md) + - [QueryCommentsOrderAnyLabel](docs/QueryCommentsOrderAnyLabel.md) + - [QueryCommentsOrderAttachmentTextSearch](docs/QueryCommentsOrderAttachmentTextSearch.md) + - [QueryCommentsOrderByLabel](docs/QueryCommentsOrderByLabel.md) + - [QueryCommentsOrderCheck](docs/QueryCommentsOrderCheck.md) + - [QueryCommentsOrderDiagnostic](docs/QueryCommentsOrderDiagnostic.md) + - [QueryCommentsOrderLabelProperty](docs/QueryCommentsOrderLabelProperty.md) + - [QueryCommentsOrderLearning](docs/QueryCommentsOrderLearning.md) + - [QueryCommentsOrderMissed](docs/QueryCommentsOrderMissed.md) + - [QueryCommentsOrderRecent](docs/QueryCommentsOrderRecent.md) + - [QueryCommentsOrderSample](docs/QueryCommentsOrderSample.md) + - [QueryCommentsOrderTextSearch](docs/QueryCommentsOrderTextSearch.md) + - [QueryCommentsRequest](docs/QueryCommentsRequest.md) + - [QueryCommentsResponse](docs/QueryCommentsResponse.md) + - [QueryDatasetUserPropertyValuesFilter](docs/QueryDatasetUserPropertyValuesFilter.md) + - [QueryDatasetUserPropertyValuesRequest](docs/QueryDatasetUserPropertyValuesRequest.md) + - [QueryDatasetUserPropertyValuesResponse](docs/QueryDatasetUserPropertyValuesResponse.md) + - [QueryIssuesRequest](docs/QueryIssuesRequest.md) + - [QueryIssuesResponse](docs/QueryIssuesResponse.md) + - [QueryKeyedSyncStateIdsRequest](docs/QueryKeyedSyncStateIdsRequest.md) + - [QueryKeyedSyncStateIdsResponse](docs/QueryKeyedSyncStateIdsResponse.md) + - [QueryResultCounts](docs/QueryResultCounts.md) + - [Quota](docs/Quota.md) + - [QuotaKind](docs/QuotaKind.md) + - [RawEmail](docs/RawEmail.md) + - [RawEmailBody](docs/RawEmailBody.md) + - [RawEmailDocument](docs/RawEmailDocument.md) + - [RawEmailHeadersParsed](docs/RawEmailHeadersParsed.md) + - [RawEmailHeadersRaw](docs/RawEmailHeadersRaw.md) + - [Regex](docs/Regex.md) + - [RemoveSupportTenantRequest](docs/RemoveSupportTenantRequest.md) + - [RemoveSupportTenantResponse](docs/RemoveSupportTenantResponse.md) + - [ResetAnnotationsToPreviousPinnedModelRequest](docs/ResetAnnotationsToPreviousPinnedModelRequest.md) + - [ResetAnnotationsToPreviousPinnedModelResponse](docs/ResetAnnotationsToPreviousPinnedModelResponse.md) + - [ResetStreamRequest](docs/ResetStreamRequest.md) + - [ResetStreamResponse](docs/ResetStreamResponse.md) + - [ResetTenantQuotaResponse](docs/ResetTenantQuotaResponse.md) + - [ResetTriggerRequest](docs/ResetTriggerRequest.md) + - [ResetTriggerResponse](docs/ResetTriggerResponse.md) + - [ResponseStatusError](docs/ResponseStatusError.md) + - [RetrievalMethod](docs/RetrievalMethod.md) + - [ReviewableBlock](docs/ReviewableBlock.md) + - [ReviewableBlockGroup](docs/ReviewableBlockGroup.md) + - [Reviewed](docs/Reviewed.md) + - [ReviewedFilterRule](docs/ReviewedFilterRule.md) + - [RichDiagnosticKind](docs/RichDiagnosticKind.md) + - [SendWelcomeEmailResponse](docs/SendWelcomeEmailResponse.md) + - [Sentiment](docs/Sentiment.md) + - [SetCommentAudioResponse](docs/SetCommentAudioResponse.md) + - [SetQuotaForTenantRequest](docs/SetQuotaForTenantRequest.md) + - [SetQuotaForTenantResponse](docs/SetQuotaForTenantResponse.md) + - [SetTenantQuotaRequest](docs/SetTenantQuotaRequest.md) + - [SetTenantQuotaResponse](docs/SetTenantQuotaResponse.md) + - [SetTenantStateRequest](docs/SetTenantStateRequest.md) + - [SetTenantStateResponse](docs/SetTenantStateResponse.md) + - [Significance](docs/Significance.md) + - [SignificanceValue](docs/SignificanceValue.md) + - [SingleLabelSummary](docs/SingleLabelSummary.md) + - [SingleTenantsResponse](docs/SingleTenantsResponse.md) + - [SniffCsvResponse](docs/SniffCsvResponse.md) + - [Source](docs/Source.md) + - [Source1](docs/Source1.md) + - [SourceCounts](docs/SourceCounts.md) + - [SourceCountsSettings](docs/SourceCountsSettings.md) + - [SourceKind](docs/SourceKind.md) + - [SourceStatistics](docs/SourceStatistics.md) + - [SourceUpdate](docs/SourceUpdate.md) + - [Span](docs/Span.md) + - [Statistics](docs/Statistics.md) + - [StoreBucketSyncStateRequest](docs/StoreBucketSyncStateRequest.md) + - [StoreBucketSyncStateResponse](docs/StoreBucketSyncStateResponse.md) + - [StoreExceptionRequest](docs/StoreExceptionRequest.md) + - [StoreExceptionResponse](docs/StoreExceptionResponse.md) + - [StoreKeyedSyncStateRequest](docs/StoreKeyedSyncStateRequest.md) + - [StoreKeyedSyncStateResponse](docs/StoreKeyedSyncStateResponse.md) + - [StreamCommentExtractionsResult](docs/StreamCommentExtractionsResult.md) + - [StreamCommentPrediction](docs/StreamCommentPrediction.md) + - [StreamCommentResult](docs/StreamCommentResult.md) + - [StreamConfidence](docs/StreamConfidence.md) + - [StreamExtractionFieldPrediction](docs/StreamExtractionFieldPrediction.md) + - [StreamFieldValue](docs/StreamFieldValue.md) + - [StreamGeneralFieldPrediction](docs/StreamGeneralFieldPrediction.md) + - [StreamLabelPrediction](docs/StreamLabelPrediction.md) + - [StreamResult](docs/StreamResult.md) + - [StreamScorePrediction](docs/StreamScorePrediction.md) + - [StreamTaxonomyPrediction](docs/StreamTaxonomyPrediction.md) + - [StreamTextSpan](docs/StreamTextSpan.md) + - [StringAnyOfFilter](docs/StringAnyOfFilter.md) + - [StringArrayFilter](docs/StringArrayFilter.md) + - [StringNoneOfFilter](docs/StringNoneOfFilter.md) + - [StringOneOfFilter](docs/StringOneOfFilter.md) + - [StringSearchFilter](docs/StringSearchFilter.md) + - [StringUserPropertyCount](docs/StringUserPropertyCount.md) + - [StringUserPropertyCountSingle](docs/StringUserPropertyCountSingle.md) + - [StringUserPropertyCountsSettings](docs/StringUserPropertyCountsSettings.md) + - [StringUserPropertySummary](docs/StringUserPropertySummary.md) + - [SuggestTaxonomyRequest](docs/SuggestTaxonomyRequest.md) + - [SuggestTaxonomyResponse](docs/SuggestTaxonomyResponse.md) + - [SuggestedLabel](docs/SuggestedLabel.md) + - [SuggestedTaxonomy](docs/SuggestedTaxonomy.md) + - [SyncAnnotationsRequest](docs/SyncAnnotationsRequest.md) + - [SyncAnnotationsResponse](docs/SyncAnnotationsResponse.md) + - [SyncCommentsFromCsvResponse](docs/SyncCommentsFromCsvResponse.md) + - [SyncCommentsRequest](docs/SyncCommentsRequest.md) + - [SyncCommentsResponse](docs/SyncCommentsResponse.md) + - [SyncRawEmailsRequest](docs/SyncRawEmailsRequest.md) + - [SyncRawEmailsResponse](docs/SyncRawEmailsResponse.md) + - [SyncStatus](docs/SyncStatus.md) + - [TaggedIxpModelVersion](docs/TaggedIxpModelVersion.md) + - [TaggedUserModelVersion](docs/TaggedUserModelVersion.md) + - [TaggedUserModelVersionName](docs/TaggedUserModelVersionName.md) + - [TaggedUserModelVersionUpdate](docs/TaggedUserModelVersionUpdate.md) + - [TaxonomyExtractionPrivate](docs/TaxonomyExtractionPrivate.md) + - [Tenant](docs/Tenant.md) + - [TenantNew](docs/TenantNew.md) + - [TenantUpdate](docs/TenantUpdate.md) + - [TextConfig](docs/TextConfig.md) + - [TextFieldDataPrivate](docs/TextFieldDataPrivate.md) + - [TextFieldDataType](docs/TextFieldDataType.md) + - [TextFieldFlag](docs/TextFieldFlag.md) + - [TextFormat](docs/TextFormat.md) + - [TextImageInputConfig](docs/TextImageInputConfig.md) + - [TextSpan](docs/TextSpan.md) + - [Theme](docs/Theme.md) + - [ThemeComment](docs/ThemeComment.md) + - [ThemeCommentInterpretation](docs/ThemeCommentInterpretation.md) + - [ThemeSet](docs/ThemeSet.md) + - [ThreadHistogramBinningCustom](docs/ThreadHistogramBinningCustom.md) + - [ThreadHistogramBinningCustomContainer](docs/ThreadHistogramBinningCustomContainer.md) + - [ThreadHistogramBinningFixed](docs/ThreadHistogramBinningFixed.md) + - [ThreadHistogramBinningFixedContainer](docs/ThreadHistogramBinningFixedContainer.md) + - [ThreadHistogramBinningVariable](docs/ThreadHistogramBinningVariable.md) + - [ThreadHistogramBinningVariableContainer](docs/ThreadHistogramBinningVariableContainer.md) + - [ThreadHistogramCounts](docs/ThreadHistogramCounts.md) + - [ThreadHistogramCountsByProperty](docs/ThreadHistogramCountsByProperty.md) + - [ThreadHistogramSettings](docs/ThreadHistogramSettings.md) + - [ThreadHistogramSettingsByProperty](docs/ThreadHistogramSettingsByProperty.md) + - [ThreadProperties](docs/ThreadProperties.md) + - [ThreadPropertyFilter](docs/ThreadPropertyFilter.md) + - [ThreadTheme](docs/ThreadTheme.md) + - [Threshold](docs/Threshold.md) + - [Threshold1](docs/Threshold1.md) + - [ThresholdEnum](docs/ThresholdEnum.md) + - [TimePeriodComparison](docs/TimePeriodComparison.md) + - [TimeResolution](docs/TimeResolution.md) + - [TimestampRangeFilter](docs/TimestampRangeFilter.md) + - [TrainView](docs/TrainView.md) + - [TrainingAction](docs/TrainingAction.md) + - [TrainingActionCompleteness](docs/TrainingActionCompleteness.md) + - [Translation](docs/Translation.md) + - [Trigger](docs/Trigger.md) + - [TriggerException](docs/TriggerException.md) + - [TriggerExceptionsSummary](docs/TriggerExceptionsSummary.md) + - [TriggerLabelThreshold](docs/TriggerLabelThreshold.md) + - [TriggerNew](docs/TriggerNew.md) + - [TriggerUpdate](docs/TriggerUpdate.md) + - [TriggerUserModel](docs/TriggerUserModel.md) + - [Ui](docs/Ui.md) + - [UiAnnotationMetadata](docs/UiAnnotationMetadata.md) + - [UiPathCvTableOnlyConfig](docs/UiPathCvTableOnlyConfig.md) + - [UiPathProvisionCreateProperties](docs/UiPathProvisionCreateProperties.md) + - [UiPathProvisionCreateRequest](docs/UiPathProvisionCreateRequest.md) + - [UiPathProvisionCreateResponse](docs/UiPathProvisionCreateResponse.md) + - [UiPathProvisionDeleteRequest](docs/UiPathProvisionDeleteRequest.md) + - [UiPathProvisionDeleteResponse](docs/UiPathProvisionDeleteResponse.md) + - [UiPathProvisionRestoreRequest](docs/UiPathProvisionRestoreRequest.md) + - [UiPathProvisionRestoreResponse](docs/UiPathProvisionRestoreResponse.md) + - [UiPathProvisionUpdateProperties](docs/UiPathProvisionUpdateProperties.md) + - [UiPathProvisionUpdateRequest](docs/UiPathProvisionUpdateRequest.md) + - [UiPathProvisionUpdateResponse](docs/UiPathProvisionUpdateResponse.md) + - [UiPathTenantServiceStatus](docs/UiPathTenantServiceStatus.md) + - [UnaryLabelHealthAction](docs/UnaryLabelHealthAction.md) + - [UnaryLabelHealthActionKind](docs/UnaryLabelHealthActionKind.md) + - [UnaryLabelHealthWarning](docs/UnaryLabelHealthWarning.md) + - [UnaryLabelHealthWarningKind](docs/UnaryLabelHealthWarningKind.md) + - [UninformativeLabel](docs/UninformativeLabel.md) + - [UninformativeMode](docs/UninformativeMode.md) + - [UnpinModelResponse](docs/UnpinModelResponse.md) + - [UpdateAlertRequest](docs/UpdateAlertRequest.md) + - [UpdateAlertResponse](docs/UpdateAlertResponse.md) + - [UpdateApplianceConfigResponse](docs/UpdateApplianceConfigResponse.md) + - [UpdateBucketRequest](docs/UpdateBucketRequest.md) + - [UpdateBucketResponse](docs/UpdateBucketResponse.md) + - [UpdateCommentLabellingRequest](docs/UpdateCommentLabellingRequest.md) + - [UpdateCommentLabellingResponse](docs/UpdateCommentLabellingResponse.md) + - [UpdateDashboardRequest](docs/UpdateDashboardRequest.md) + - [UpdateDashboardResponse](docs/UpdateDashboardResponse.md) + - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md) + - [UpdateDatasetResponse](docs/UpdateDatasetResponse.md) + - [UpdateIntegrationRequest](docs/UpdateIntegrationRequest.md) + - [UpdateIntegrationResponse](docs/UpdateIntegrationResponse.md) + - [UpdateIssueStatusRequest](docs/UpdateIssueStatusRequest.md) + - [UpdateIssueStatusResponse](docs/UpdateIssueStatusResponse.md) + - [UpdateLabelDefResponse](docs/UpdateLabelDefResponse.md) + - [UpdateModelRequest](docs/UpdateModelRequest.md) + - [UpdateModelResponse](docs/UpdateModelResponse.md) + - [UpdateModelTagRequest](docs/UpdateModelTagRequest.md) + - [UpdateModelTagResponse](docs/UpdateModelTagResponse.md) + - [UpdateProjectRequest](docs/UpdateProjectRequest.md) + - [UpdateProjectResponse](docs/UpdateProjectResponse.md) + - [UpdateSourceRequest](docs/UpdateSourceRequest.md) + - [UpdateSourceResponse](docs/UpdateSourceResponse.md) + - [UpdateTenantClientSubnetsRequest](docs/UpdateTenantClientSubnetsRequest.md) + - [UpdateTenantClientSubnetsResponse](docs/UpdateTenantClientSubnetsResponse.md) + - [UpdateTenantDefaultProjectPermissionsRequest](docs/UpdateTenantDefaultProjectPermissionsRequest.md) + - [UpdateTenantDefaultProjectPermissionsResponse](docs/UpdateTenantDefaultProjectPermissionsResponse.md) + - [UpdateTenantDomainsRequest](docs/UpdateTenantDomainsRequest.md) + - [UpdateTenantDomainsResponse](docs/UpdateTenantDomainsResponse.md) + - [UpdateTenantEntityDefIdsRequest](docs/UpdateTenantEntityDefIdsRequest.md) + - [UpdateTenantEntityDefIdsResponse](docs/UpdateTenantEntityDefIdsResponse.md) + - [UpdateTenantRequest](docs/UpdateTenantRequest.md) + - [UpdateTenantResponse](docs/UpdateTenantResponse.md) + - [UpdateTriggerRequest](docs/UpdateTriggerRequest.md) + - [UpdateTriggerResponse](docs/UpdateTriggerResponse.md) + - [UpdateUserRequest](docs/UpdateUserRequest.md) + - [UpdateUserResponse](docs/UpdateUserResponse.md) + - [UploadAttachmentResponse](docs/UploadAttachmentResponse.md) + - [UploadDocumentResponse](docs/UploadDocumentResponse.md) + - [UploadFilesResponse](docs/UploadFilesResponse.md) + - [User](docs/User.md) + - [UserAccessModel](docs/UserAccessModel.md) + - [UserAccessModelKind](docs/UserAccessModelKind.md) + - [UserLicense](docs/UserLicense.md) + - [UserLicenseCheck](docs/UserLicenseCheck.md) + - [UserModel](docs/UserModel.md) + - [UserModelMetadata](docs/UserModelMetadata.md) + - [UserModelMetadataFlag](docs/UserModelMetadataFlag.md) + - [UserModelMetadataSettings](docs/UserModelMetadataSettings.md) + - [UserNew](docs/UserNew.md) + - [UserPropertiesSummary](docs/UserPropertiesSummary.md) + - [UserPropertiesValue](docs/UserPropertiesValue.md) + - [UserUpdate](docs/UserUpdate.md) + - [UserV1](docs/UserV1.md) + - [UserWithLicenseCheck](docs/UserWithLicenseCheck.md) + - [ValidateExchangeCredentialsRequest](docs/ValidateExchangeCredentialsRequest.md) + - [ValidateExchangeCredentialsResponse](docs/ValidateExchangeCredentialsResponse.md) + - [ValidationSummary](docs/ValidationSummary.md) + - [ValidationSummaryV1](docs/ValidationSummaryV1.md) + - [VariationKind](docs/VariationKind.md) + - [Vertex](docs/Vertex.md) + + +To get access to the crate's generated documentation, use: + +``` +cargo doc --open +``` + +## Author + + -A Rust library for the reinfer API. diff --git a/api/src/apis/alerts_api.rs b/api/src/apis/alerts_api.rs new file mode 100644 index 00000000..78101d6a --- /dev/null +++ b/api/src/apis/alerts_api.rs @@ -0,0 +1,563 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`alert_issues`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AlertIssuesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`create_alert`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateAlertError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_alert`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteAlertError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_alert_subscription`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteAlertSubscriptionError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_alert`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAlertError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_alert_subscriptions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAlertSubscriptionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_alerts`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllAlertsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_issue`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIssueError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`preview_alert`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PreviewAlertError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`query_issues`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryIssuesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_alert`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateAlertError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_issue_status`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateIssueStatusError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get issues for an alert +pub fn alert_issues(configuration: &configuration::Configuration, owner: &str, raw_alert_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/{owner}/{raw_alert_name}/issues", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), raw_alert_name=crate::apis::urlencode(raw_alert_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Create an alert +pub fn create_alert(configuration: &configuration::Configuration, owner: &str, raw_alert_name: &str, create_alert_request: models::CreateAlertRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/{owner}/{raw_alert_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), raw_alert_name=crate::apis::urlencode(raw_alert_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_alert_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a alert +pub fn delete_alert(configuration: &configuration::Configuration, raw_alert_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/id:{raw_alert_id}", local_var_configuration.base_path, raw_alert_id=crate::apis::urlencode(raw_alert_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Unsubscribes the user from an alert +pub fn delete_alert_subscription(configuration: &configuration::Configuration, raw_alert_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/subscriptions/{raw_alert_id}", local_var_configuration.base_path, raw_alert_id=crate::apis::urlencode(raw_alert_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a alert by project and name +pub fn get_alert(configuration: &configuration::Configuration, owner: &str, raw_alert_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/{owner}/{raw_alert_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), raw_alert_name=crate::apis::urlencode(raw_alert_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all alerts that the user is subscribed to +pub fn get_alert_subscriptions(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/subscriptions", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all alerts for a user +pub fn get_all_alerts(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get an issue +pub fn get_issue(configuration: &configuration::Configuration, hex_issue_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/issues/{hex_issue_id}", local_var_configuration.base_path, hex_issue_id=crate::apis::urlencode(hex_issue_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Preview an alert +pub fn preview_alert(configuration: &configuration::Configuration, owner: &str, raw_alert_name: &str, preview_alert_request: models::PreviewAlertRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/{owner}/{raw_alert_name}/preview", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), raw_alert_name=crate::apis::urlencode(raw_alert_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&preview_alert_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Query issues for the current user +pub fn query_issues(configuration: &configuration::Configuration, query_issues_request: models::QueryIssuesRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/issues/query", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&query_issues_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a alert +pub fn update_alert(configuration: &configuration::Configuration, owner: &str, raw_alert_name: &str, update_alert_request: models::UpdateAlertRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/alerts/{owner}/{raw_alert_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), raw_alert_name=crate::apis::urlencode(raw_alert_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_alert_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update the status of the issue +pub fn update_issue_status(configuration: &configuration::Configuration, hex_issue_id: &str, update_issue_status_request: models::UpdateIssueStatusRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/issues/{hex_issue_id}/status", local_var_configuration.base_path, hex_issue_id=crate::apis::urlencode(hex_issue_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_issue_status_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/analytics_api.rs b/api/src/apis/analytics_api.rs new file mode 100644 index 00000000..dbdc2fd5 --- /dev/null +++ b/api/src/apis/analytics_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_page_view`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreatePageViewError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a pageview +pub fn create_page_view(configuration: &configuration::Configuration, create_page_view_request: models::CreatePageViewRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/analytics/pageview", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_page_view_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/appliance_configs_api.rs b/api/src/apis/appliance_configs_api.rs new file mode 100644 index 00000000..22f19077 --- /dev/null +++ b/api/src/apis/appliance_configs_api.rs @@ -0,0 +1,109 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_appliance_config`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetApplianceConfigError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_appliance_config`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateApplianceConfigError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get an appliance config +pub fn get_appliance_config(configuration: &configuration::Configuration, owner: &str, config_key: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/appliance-configs/{owner}/{config_key}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), config_key=crate::apis::urlencode(config_key)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update an appliance config +pub fn update_appliance_config(configuration: &configuration::Configuration, owner: &str, config_key: &str, body: std::path::PathBuf) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/appliance-configs/{owner}/{config_key}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), config_key=crate::apis::urlencode(config_key)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&body); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/attachments_api.rs b/api/src/apis/attachments_api.rs new file mode 100644 index 00000000..0ab98a9a --- /dev/null +++ b/api/src/apis/attachments_api.rs @@ -0,0 +1,389 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_attachment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAttachmentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_document_metadata`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDocumentMetadataError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_document_search`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDocumentSearchError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_image`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageImageError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_selections`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageSelectionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_thumbnail`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageThumbnailError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_comment_attachment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadCommentAttachmentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_email_attachment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadEmailAttachmentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get an attachment's content. +pub fn get_attachment(configuration: &configuration::Configuration, attachment_reference: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/attachments/{attachment_reference}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get metadata +pub fn get_document_metadata(configuration: &configuration::Configuration, attachment_reference: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/render", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get document search selections +pub fn get_document_search(configuration: &configuration::Configuration, attachment_reference: &str, query: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/selections/search", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("query", &query.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get page image +pub fn get_page_image(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/render/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get ocr selections +pub fn get_page_selections(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/selections/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get page thumbnail +pub fn get_page_thumbnail(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/thumbnail/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload an attachment for a comment. +pub fn upload_comment_attachment(configuration: &configuration::Configuration, source_id: &str, comment_id: &str, attachment_index: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{source_id}/comments/{comment_id}/attachments/{attachment_index}", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id), comment_id=crate::apis::urlencode(comment_id), attachment_index=crate::apis::urlencode(attachment_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload an attachment for a email. +pub fn upload_email_attachment(configuration: &configuration::Configuration, bucket_id: &str, email_id: &str, attachment_index: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{bucket_id}/emails/{email_id}/attachments/{attachment_index}", local_var_configuration.base_path, bucket_id=crate::apis::urlencode(bucket_id), email_id=crate::apis::urlencode(email_id), attachment_index=crate::apis::urlencode(attachment_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/audit_events_api.rs b/api/src/apis/audit_events_api.rs new file mode 100644 index 00000000..78a1fed0 --- /dev/null +++ b/api/src/apis/audit_events_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`query_audit_events`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryAuditEventsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Query audit events +pub fn query_audit_events(configuration: &configuration::Configuration, query_audit_events_request: models::QueryAuditEventsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/audit_events/query", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&query_audit_events_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/buckets_api.rs b/api/src/apis/buckets_api.rs new file mode 100644 index 00000000..9895c82c --- /dev/null +++ b/api/src/apis/buckets_api.rs @@ -0,0 +1,698 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_bucket`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateBucketError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_bucket`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteBucketError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_keyed_sync_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteKeyedSyncStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_buckets`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllBucketsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_bucket`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_bucket_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_bucket_statistics`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketStatisticsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_bucket_sync_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketSyncStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_buckets_by_owner`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketsByOwnerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_keyed_sync_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetKeyedSyncStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`list_keyed_sync_states`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ListKeyedSyncStatesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`query_keyed_sync_state_ids`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryKeyedSyncStateIdsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`store_bucket_sync_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum StoreBucketSyncStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`store_keyed_sync_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum StoreKeyedSyncStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_bucket`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateBucketError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a bucket +pub fn create_bucket(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, create_bucket_request: models::CreateBucketRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_bucket_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a bucket +pub fn delete_bucket(configuration: &configuration::Configuration, raw_bucket_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a keyed sync state by bucket Id. +pub fn delete_keyed_sync_state(configuration: &configuration::Configuration, raw_bucket_id: &str, sync_state_key: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key}", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id), sync_state_key=crate::apis::urlencode(sync_state_key)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all buckets +pub fn get_all_buckets(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a bucket +pub fn get_bucket(configuration: &configuration::Configuration, owner: &str, bucket_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a bucket by ID +pub fn get_bucket_by_id(configuration: &configuration::Configuration, bucket_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{bucket_id}", local_var_configuration.base_path, bucket_id=crate::apis::urlencode(bucket_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get bucket statistics +pub fn get_bucket_statistics(configuration: &configuration::Configuration, owner: &str, bucket_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}/statistics", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get bucket sync state +pub fn get_bucket_sync_state(configuration: &configuration::Configuration, owner: &str, bucket_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/bucket-sync-state/{owner}/{bucket_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get buckets by owner +pub fn get_buckets_by_owner(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a keyed sync state by bucket Id. +pub fn get_keyed_sync_state(configuration: &configuration::Configuration, raw_bucket_id: &str, sync_state_key: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key}", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id), sync_state_key=crate::apis::urlencode(sync_state_key)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// List keyed sync states for a bucket. +pub fn list_keyed_sync_states(configuration: &configuration::Configuration, raw_bucket_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}/keyed-sync-states/", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Query keyed sync state ids for a bucket. +pub fn query_keyed_sync_state_ids(configuration: &configuration::Configuration, raw_bucket_id: &str, query_keyed_sync_state_ids_request: models::QueryKeyedSyncStateIdsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state-ids", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&query_keyed_sync_state_ids_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Store bucket sync state +pub fn store_bucket_sync_state(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, store_bucket_sync_state_request: models::StoreBucketSyncStateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/bucket-sync-state/{owner}/{bucket_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&store_bucket_sync_state_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Store a keyed sync state by bucket Id. +pub fn store_keyed_sync_state(configuration: &configuration::Configuration, raw_bucket_id: &str, sync_state_key: &str, store_keyed_sync_state_request: models::StoreKeyedSyncStateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{raw_bucket_id}/keyed-sync-state/{sync_state_key}", local_var_configuration.base_path, raw_bucket_id=crate::apis::urlencode(raw_bucket_id), sync_state_key=crate::apis::urlencode(sync_state_key)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&store_keyed_sync_state_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a bucket +pub fn update_bucket(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, update_bucket_request: models::UpdateBucketRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_bucket_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/comments_api.rs b/api/src/apis/comments_api.rs new file mode 100644 index 00000000..4e7f8fff --- /dev/null +++ b/api/src/apis/comments_api.rs @@ -0,0 +1,618 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`add_comments`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AddCommentsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_comment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteCommentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_comment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetCommentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_comment_audio`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetCommentAudioError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_source_comments`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetSourceCommentsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`query_comments`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryCommentsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`set_comment_audio`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SetCommentAudioError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`sniff_csv`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SniffCsvError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`sync_comments`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SyncCommentsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`sync_comments_from_csv`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SyncCommentsFromCsvError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`sync_raw_emails`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SyncRawEmailsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_comment_attachment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadCommentAttachmentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Add a batch of comments. To overwrite existing comments, you need to specify the latest `context` field. +pub fn add_comments(configuration: &configuration::Configuration, owner: &str, source_name: &str, add_comments_request: models::AddCommentsRequest, no_charge: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/{owner}/{source_name}/comments", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = no_charge { + local_var_req_builder = local_var_req_builder.query(&[("no_charge", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&add_comments_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a comment by ID +pub fn delete_comment(configuration: &configuration::Configuration, owner: &str, source_name: &str, id: Option>, ids: Option<&str>) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/comments", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = id { + local_var_req_builder = match "csv" { + "multi" => local_var_req_builder.query(&local_var_str.iter().map(|p| ("id".to_owned(), p.to_string())).collect::>()), + _ => local_var_req_builder.query(&[("id", &local_var_str.iter().map(|p| p.to_string()).collect::>().join(",").to_string())]), + }; + } + if let Some(ref local_var_str) = ids { + local_var_req_builder = local_var_req_builder.query(&[("ids", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a comment by ID +pub fn get_comment(configuration: &configuration::Configuration, owner: &str, source_name: &str, comment_id: &str, include_markup: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/comments/{comment_id}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name), comment_id=crate::apis::urlencode(comment_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = include_markup { + local_var_req_builder = local_var_req_builder.query(&[("include_markup", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get the audio for a comment +pub fn get_comment_audio(configuration: &configuration::Configuration, source_id: &str, comment_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{source_id}/comments/{comment_id}/audio", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id), comment_id=crate::apis::urlencode(comment_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get comments from a source +pub fn get_source_comments(configuration: &configuration::Configuration, owner: &str, source_name: &str, after: Option<&str>, limit: Option, from_timestamp: Option<&str>, to_timestamp: Option<&str>, include_thread_properties: Option, include_markup: Option, direction: Option<&str>) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/{owner}/{source_name}/comments", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = after { + local_var_req_builder = local_var_req_builder.query(&[("after", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = limit { + local_var_req_builder = local_var_req_builder.query(&[("limit", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = from_timestamp { + local_var_req_builder = local_var_req_builder.query(&[("from_timestamp", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = to_timestamp { + local_var_req_builder = local_var_req_builder.query(&[("to_timestamp", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = include_thread_properties { + local_var_req_builder = local_var_req_builder.query(&[("include_thread_properties", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = include_markup { + local_var_req_builder = local_var_req_builder.query(&[("include_markup", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = direction { + local_var_req_builder = local_var_req_builder.query(&[("direction", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Query comments in a dataset +pub fn query_comments(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, query_comments_request: models::QueryCommentsRequest, limit: Option, continuation: Option<&str>) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/query", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = limit { + local_var_req_builder = local_var_req_builder.query(&[("limit", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = continuation { + local_var_req_builder = local_var_req_builder.query(&[("continuation", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&query_comments_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Set the audio for a comment +pub fn set_comment_audio(configuration: &configuration::Configuration, raw_source_id: &str, raw_comment_id: &str, body: std::path::PathBuf) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{raw_source_id}/comments/{raw_comment_id}/audio", local_var_configuration.base_path, raw_source_id=crate::apis::urlencode(raw_source_id), raw_comment_id=crate::apis::urlencode(raw_comment_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&body); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sniff a CSV file +pub fn sniff_csv(configuration: &configuration::Configuration, body: std::path::PathBuf) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/sniff-csv", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&body); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sync a batch of comments. Any comments with the same IDs in the source will be overwritten. +pub fn sync_comments(configuration: &configuration::Configuration, owner: &str, source_name: &str, sync_comments_request: models::SyncCommentsRequest, no_charge: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/sync", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = no_charge { + local_var_req_builder = local_var_req_builder.query(&[("no_charge", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&sync_comments_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sync comments from a CSV file +pub fn sync_comments_from_csv(configuration: &configuration::Configuration, owner: &str, source_name: &str, body: std::path::PathBuf) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/{owner}/{source_name}/sync-csv", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&body); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sync a batch of raw emails. Any comments with the same IDs in the source will be overwritten. +pub fn sync_raw_emails(configuration: &configuration::Configuration, owner: &str, source_name: &str, sync_raw_emails_request: models::SyncRawEmailsRequest, no_charge: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/sync-raw-emails", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = no_charge { + local_var_req_builder = local_var_req_builder.query(&[("no_charge", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&sync_raw_emails_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload an attachment for a comment. +pub fn upload_comment_attachment(configuration: &configuration::Configuration, source_id: &str, comment_id: &str, attachment_index: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{source_id}/comments/{comment_id}/attachments/{attachment_index}", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id), comment_id=crate::apis::urlencode(comment_id), attachment_index=crate::apis::urlencode(attachment_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/configuration.rs b/api/src/apis/configuration.rs new file mode 100644 index 00000000..23e33b92 --- /dev/null +++ b/api/src/apis/configuration.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + + +#[derive(Debug, Clone)] +pub struct Configuration { + pub base_path: String, + pub user_agent: Option, + pub client: reqwest::blocking::Client, + pub basic_auth: Option, + pub oauth_access_token: Option, + pub bearer_access_token: Option, + pub api_key: Option, + // TODO: take an oauth2 token source, similar to the go one +} + +pub type BasicAuth = (String, Option); + +#[derive(Debug, Clone)] +pub struct ApiKey { + pub prefix: Option, + pub key: String, +} + + +impl Configuration { + pub fn new() -> Configuration { + Configuration::default() + } +} + +impl Default for Configuration { + fn default() -> Self { + Configuration { + base_path: "https://cloud.uipath.com/demo/demo/reinfer_".to_owned(), + user_agent: Some("OpenAPI-Generator/0.1.0/rust".to_owned()), + client: reqwest::blocking::Client::new(), + basic_auth: None, + oauth_access_token: None, + bearer_access_token: None, + api_key: None, + + } + } +} diff --git a/api/src/apis/conversational_filter_api.rs b/api/src/apis/conversational_filter_api.rs new file mode 100644 index 00000000..a4ee1b0c --- /dev/null +++ b/api/src/apis/conversational_filter_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`query_conversational_filter`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryConversationalFilterError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Query comments in a dataset with an LLM +pub fn query_conversational_filter(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, conversational_filter_request: models::ConversationalFilterRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/conversational-filter-query", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&conversational_filter_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/dashboards_api.rs b/api/src/apis/dashboards_api.rs new file mode 100644 index 00000000..2915dcb7 --- /dev/null +++ b/api/src/apis/dashboards_api.rs @@ -0,0 +1,290 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboards_in_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardsInDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboards_in_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardsInProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a new dashboard +pub fn create_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str, create_dashboard_request: models::CreateDashboardRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_dashboard_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a dashboard +pub fn delete_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a dashboard by project and name +pub fn get_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all dashboards in dataset +pub fn get_dashboards_in_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/dashboards", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all dashboards in project +pub fn get_dashboards_in_project(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a dashboard by project and name +pub fn update_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str, update_dashboard_request: models::UpdateDashboardRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_dashboard_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/datasets_api.rs b/api/src/apis/datasets_api.rs new file mode 100644 index 00000000..1ac5bb27 --- /dev/null +++ b/api/src/apis/datasets_api.rs @@ -0,0 +1,865 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_dataset_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteDatasetByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_dataset_v1`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteDatasetV1Error { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`export_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ExportDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_datasets`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllDatasetsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_datasets_in_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllDatasetsInProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_comparison`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetComparisonError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dataset_statistics`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDatasetStatisticsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dataset_status`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDatasetStatusError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dataset_summary`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDatasetSummaryError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dataset_user_properties_summary`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDatasetUserPropertiesSummaryError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_labellings`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetLabellingsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`query_dataset_user_property_values`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum QueryDatasetUserPropertyValuesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`reset_annotations_to_previous_pinned_model`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ResetAnnotationsToPreviousPinnedModelError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`sync_annotations`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SyncAnnotationsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_comment_labelling`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateCommentLabellingError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a dataset +pub fn create_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, create_dataset_request: models::CreateDatasetRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_dataset_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a dataset by id +pub fn delete_dataset_by_id(configuration: &configuration::Configuration, dataset_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/id:{dataset_id}", local_var_configuration.base_path, dataset_id=crate::apis::urlencode(dataset_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a dataset +pub fn delete_dataset_v1(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Export dataset +pub fn export_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, export_dataset_request: models::ExportDatasetRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/export", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&export_dataset_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all datasets +pub fn get_all_datasets(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all datasets in a project +pub fn get_all_datasets_in_project(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get comparison for two filtered groups of verbatims +pub fn get_comparison(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, get_comparison_request: models::GetComparisonRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/compare", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_comparison_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a dataset by project and name +pub fn get_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get dataset statistics +pub fn get_dataset_statistics(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, get_dataset_statistics_request: models::GetDatasetStatisticsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/statistics", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_dataset_statistics_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get dataset status +pub fn get_dataset_status(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/status", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get dataset summary +pub fn get_dataset_summary(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, get_dataset_summary_request: models::GetDatasetSummaryRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/summary", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_dataset_summary_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get user property summary for a dataset +pub fn get_dataset_user_properties_summary(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/user-properties", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Gets labellings in a dataset for a given set of comment ids. Note: Calling this endpoint with `compute_moon_predictions` will be significantly slower. +pub fn get_labellings(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, id: Option>, ids: Option<&str>, allow_missing: Option<&str>, compute_moon_predictions: Option<&str>, source_id: Option<&str>, after: Option<&str>, limit: Option<&str>, return_predictions: Option<&str>) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellings", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = id { + local_var_req_builder = match "csv" { + "multi" => local_var_req_builder.query(&local_var_str.iter().map(|p| ("id".to_owned(), p.to_string())).collect::>()), + _ => local_var_req_builder.query(&[("id", &local_var_str.iter().map(|p| p.to_string()).collect::>().join(",").to_string())]), + }; + } + if let Some(ref local_var_str) = ids { + local_var_req_builder = local_var_req_builder.query(&[("ids", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = allow_missing { + local_var_req_builder = local_var_req_builder.query(&[("allow_missing", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = compute_moon_predictions { + local_var_req_builder = local_var_req_builder.query(&[("compute_moon_predictions", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = source_id { + local_var_req_builder = local_var_req_builder.query(&[("source_id", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = after { + local_var_req_builder = local_var_req_builder.query(&[("after", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = limit { + local_var_req_builder = local_var_req_builder.query(&[("limit", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = return_predictions { + local_var_req_builder = local_var_req_builder.query(&[("return_predictions", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Query user property values for a dataset +pub fn query_dataset_user_property_values(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, query_dataset_user_property_values_request: models::QueryDatasetUserPropertyValuesRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/user-properties/values", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&query_dataset_user_property_values_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Reset annotations to the previous pinned model +pub fn reset_annotations_to_previous_pinned_model(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, reset_annotations_to_previous_pinned_model_request: models::ResetAnnotationsToPreviousPinnedModelRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/reset-annotations", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&reset_annotations_to_previous_pinned_model_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sync annotations +pub fn sync_annotations(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, sync_annotations_request: models::SyncAnnotationsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/sync-annotations", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&sync_annotations_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update the labelling of a comment +pub fn update_comment_labelling(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, labelling_id: &str, update_comment_labelling_request: models::UpdateCommentLabellingRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellings/{labelling_id}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), labelling_id=crate::apis::urlencode(labelling_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_comment_labelling_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a dataset +pub fn update_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, update_dataset_request: models::UpdateDatasetRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_dataset_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/deployment_api.rs b/api/src/apis/deployment_api.rs new file mode 100644 index 00000000..d64eb89f --- /dev/null +++ b/api/src/apis/deployment_api.rs @@ -0,0 +1,109 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_qualified_login_url`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetQualifiedLoginUrlError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_subdomain`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetSubdomainError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get the fully qualified login url for an email address. +pub fn get_qualified_login_url(configuration: &configuration::Configuration, get_qualified_login_url_request: models::GetQualifiedLoginUrlRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/deployment/login-location", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_qualified_login_url_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Whether the request was made from a tenant subdomain. +pub fn get_subdomain(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/deployment/subdomain", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/deprecation_api.rs b/api/src/apis/deprecation_api.rs new file mode 100644 index 00000000..b0c364c2 --- /dev/null +++ b/api/src/apis/deprecation_api.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_deprecated_user_models`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDeprecatedUserModelsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get all deprecated user models +pub fn get_deprecated_user_models(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/deprecated-user-models", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/discover_api.rs b/api/src/apis/discover_api.rs new file mode 100644 index 00000000..72cc1713 --- /dev/null +++ b/api/src/apis/discover_api.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_themes`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetThemesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get a themes by project and name +pub fn get_themes(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/themes", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/documents_api.rs b/api/src/apis/documents_api.rs new file mode 100644 index 00000000..2405a588 --- /dev/null +++ b/api/src/apis/documents_api.rs @@ -0,0 +1,113 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_document`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDocumentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_document`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadDocumentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get an unstructured document. +pub fn get_document(configuration: &configuration::Configuration, source_id: &str, comment_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{source_id}/documents/{comment_id}", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id), comment_id=crate::apis::urlencode(comment_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload an unstructured document. +pub fn upload_document(configuration: &configuration::Configuration, source_id: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/id:{source_id}/documents", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/emails_api.rs b/api/src/apis/emails_api.rs new file mode 100644 index 00000000..06d15a9a --- /dev/null +++ b/api/src/apis/emails_api.rs @@ -0,0 +1,209 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`add_emails_to_bucket`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AddEmailsToBucketError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_bucket_emails`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetBucketEmailsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_email_from_bucket_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetEmailFromBucketByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_email_attachment`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadEmailAttachmentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Add emails to bucket +pub fn add_emails_to_bucket(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, add_emails_to_bucket_request: models::AddEmailsToBucketRequest, no_charge: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}/emails", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = no_charge { + local_var_req_builder = local_var_req_builder.query(&[("no_charge", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&add_emails_to_bucket_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get emails from a bucket +pub fn get_bucket_emails(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, get_bucket_emails_request: models::GetBucketEmailsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}/emails", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_bucket_emails_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get email from bucket +pub fn get_email_from_bucket_by_id(configuration: &configuration::Configuration, owner: &str, bucket_name: &str, id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/{owner}/{bucket_name}/emails", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), bucket_name=crate::apis::urlencode(bucket_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("id", &id.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload an attachment for a email. +pub fn upload_email_attachment(configuration: &configuration::Configuration, bucket_id: &str, email_id: &str, attachment_index: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/buckets/id:{bucket_id}/emails/{email_id}/attachments/{attachment_index}", local_var_configuration.base_path, bucket_id=crate::apis::urlencode(bucket_id), email_id=crate::apis::urlencode(email_id), attachment_index=crate::apis::urlencode(attachment_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/files_api.rs b/api/src/apis/files_api.rs new file mode 100644 index 00000000..2612fc88 --- /dev/null +++ b/api/src/apis/files_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`upload_files`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadFilesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Upload files +pub fn upload_files(configuration: &configuration::Configuration, body: std::path::PathBuf) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/files/upload", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&body); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/integrations_api.rs b/api/src/apis/integrations_api.rs new file mode 100644 index 00000000..587b70bc --- /dev/null +++ b/api/src/apis/integrations_api.rs @@ -0,0 +1,517 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_integration`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateIntegrationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_integration`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteIntegrationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_integrations`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllIntegrationsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_integrations_in_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllIntegrationsInProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_integration`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIntegrationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_integration_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIntegrationByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_integration_errors`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIntegrationErrorsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`integrations_o_auth2_authenticate`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum IntegrationsOAuth2AuthenticateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`o_auth2_salesforce_callback`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum OAuth2SalesforceCallbackError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_integration`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateIntegrationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`validate_exchange_credentials`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ValidateExchangeCredentialsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a integration +pub fn create_integration(configuration: &configuration::Configuration, owner: &str, integration_name: &str, create_integration_request: models::CreateIntegrationRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}/{integration_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), integration_name=crate::apis::urlencode(integration_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_integration_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a integration +pub fn delete_integration(configuration: &configuration::Configuration, integration_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/id:{integration_id}", local_var_configuration.base_path, integration_id=crate::apis::urlencode(integration_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all integrations +pub fn get_all_integrations(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all integrations in a project +pub fn get_all_integrations_in_project(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a integration by project and name +pub fn get_integration(configuration: &configuration::Configuration, owner: &str, integration_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}/{integration_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), integration_name=crate::apis::urlencode(integration_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a integration by ID +pub fn get_integration_by_id(configuration: &configuration::Configuration, integration_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/id:{integration_id}", local_var_configuration.base_path, integration_id=crate::apis::urlencode(integration_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get integration sync errors +pub fn get_integration_errors(configuration: &configuration::Configuration, owner: &str, integration_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}/{integration_name}/errors", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), integration_name=crate::apis::urlencode(integration_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// OAuth2 `authenticate` endpoint +pub fn integrations_o_auth2_authenticate(configuration: &configuration::Configuration, owner: &str, integration_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}/{integration_name}/oauth2/authenticate", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), integration_name=crate::apis::urlencode(integration_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Salesforce OAuth2 `callback` endpoint +pub fn o_auth2_salesforce_callback(configuration: &configuration::Configuration, o_auth2_salesforce_callback_request: models::OAuth2SalesforceCallbackRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/salesforce/oauth2/callback", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&o_auth2_salesforce_callback_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a integration +pub fn update_integration(configuration: &configuration::Configuration, owner: &str, integration_name: &str, update_integration_request: models::UpdateIntegrationRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/integrations/{owner}/{integration_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), integration_name=crate::apis::urlencode(integration_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_integration_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Validate the provided Exchange credentials with the remote server. +pub fn validate_exchange_credentials(configuration: &configuration::Configuration, validate_exchange_credentials_request: models::ValidateExchangeCredentialsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/validate-exchange-credentials", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&validate_exchange_credentials_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/ixp_datasets_api.rs b/api/src/apis/ixp_datasets_api.rs new file mode 100644 index 00000000..8e307dea --- /dev/null +++ b/api/src/apis/ixp_datasets_api.rs @@ -0,0 +1,109 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_ixp_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateIxpDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_ixp_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteIxpDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a new IXP dataset +pub fn create_ixp_dataset(configuration: &configuration::Configuration, create_ixp_dataset_request: models::CreateIxpDatasetRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/datasets", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_ixp_dataset_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete an IXP dataset +pub fn delete_ixp_dataset(configuration: &configuration::Configuration, dataset_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/datasets/{dataset_id}", local_var_configuration.base_path, dataset_id=crate::apis::urlencode(dataset_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/ixp_models_api.rs b/api/src/apis/ixp_models_api.rs new file mode 100644 index 00000000..971d1e49 --- /dev/null +++ b/api/src/apis/ixp_models_api.rs @@ -0,0 +1,203 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_ixp_consumability`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIxpConsumabilityError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_ixp_models`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIxpModelsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_ixp_predictions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIxpPredictionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`upload_ixp_document`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UploadIxpDocumentError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get IXP consumability information for the tenant +pub fn get_ixp_consumability(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/consumability", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all pinned IXP models in a Project +pub fn get_ixp_models(configuration: &configuration::Configuration, project_uuid: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{project_uuid}/models", local_var_configuration.base_path, project_uuid=crate::apis::urlencode(project_uuid)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get IXP Document Predictions +pub fn get_ixp_predictions(configuration: &configuration::Configuration, project_uuid: &str, model_version: &str, document_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{project_uuid}/models/{model_version}/documents/{document_id}/extractions", local_var_configuration.base_path, project_uuid=crate::apis::urlencode(project_uuid), model_version=crate::apis::urlencode(model_version), document_id=crate::apis::urlencode(document_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Upload IXP Document for Predictions +pub fn upload_ixp_document(configuration: &configuration::Configuration, project_uuid: &str, model_version: &str, file: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{project_uuid}/models/{model_version}/documents", local_var_configuration.base_path, project_uuid=crate::apis::urlencode(project_uuid), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + let mut local_var_form = reqwest::blocking::multipart::Form::new(); + if let Some(local_var_param_value) = file { + local_var_form = local_var_form.file("file", local_var_param_value)?; + } + local_var_req_builder = local_var_req_builder.multipart(local_var_form); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/ixp_projects_api.rs b/api/src/apis/ixp_projects_api.rs new file mode 100644 index 00000000..6180c565 --- /dev/null +++ b/api/src/apis/ixp_projects_api.rs @@ -0,0 +1,200 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_ixp_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIxpProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_ixp_projects`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetIxpProjectsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`import_taxonomy`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ImportTaxonomyError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`suggest_taxonomy`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SuggestTaxonomyError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get an IXP project +pub fn get_ixp_project(configuration: &configuration::Configuration, project_uuid: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{project_uuid}", local_var_configuration.base_path, project_uuid=crate::apis::urlencode(project_uuid)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all IXP projects +pub fn get_ixp_projects(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Import an IXP Taxonomy using a Dataset JSON file +pub fn import_taxonomy(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, import_taxonomy_request: models::ImportTaxonomyRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{owner}/{dataset_name}/import-taxonomy", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&import_taxonomy_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Suggest an IXP Taxonomy from context +pub fn suggest_taxonomy(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, suggest_taxonomy_request: models::SuggestTaxonomyRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/ixp/projects/{owner}/{dataset_name}/suggest-taxonomy", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&suggest_taxonomy_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/label_defs_api.rs b/api/src/apis/label_defs_api.rs new file mode 100644 index 00000000..85ec604f --- /dev/null +++ b/api/src/apis/label_defs_api.rs @@ -0,0 +1,299 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_label_defs_bulk`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateLabelDefsBulkError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_label_def`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteLabelDefError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_field_group_history`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetFieldGroupHistoryError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_field_history`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetFieldHistoryError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_label_def`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetLabelDefError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_label_def`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateLabelDefError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Label Group Bulk Create +pub fn create_label_defs_bulk(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, create_or_update_label_defs_bulk_request: models::CreateOrUpdateLabelDefsBulkRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_or_update_label_defs_bulk_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete Label Def +pub fn delete_label_def(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, label_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("label_name", &label_name.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get the history for a field group by name +pub fn get_field_group_history(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, label_name: &str, older_than_version: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}/{label_name}/history", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name), label_name=crate::apis::urlencode(label_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = older_than_version { + local_var_req_builder = local_var_req_builder.query(&[("older_than_version", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get the history for a specific field within a field group +pub fn get_field_history(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, label_name: &str, field_id: &str, older_than_version: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}/{label_name}/fields/{field_id}/history", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name), label_name=crate::apis::urlencode(label_name), field_id=crate::apis::urlencode(field_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = older_than_version { + local_var_req_builder = local_var_req_builder.query(&[("older_than_version", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get Label Def +pub fn get_label_def(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, label_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("label_name", &label_name.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update label def +pub fn update_label_def(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, label_name: &str, label_def_update_request: models::LabelDefUpdateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labels/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("label_name", &label_name.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&label_def_update_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/label_groups_api.rs b/api/src/apis/label_groups_api.rs new file mode 100644 index 00000000..191f66d4 --- /dev/null +++ b/api/src/apis/label_groups_api.rs @@ -0,0 +1,199 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_label_group`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateLabelGroupError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_label_group`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteLabelGroupError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_label_groups`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllLabelGroupsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_label_group`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetLabelGroupError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a label group +pub fn create_label_group(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str, create_label_group_request: models::CreateLabelGroupRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_label_group_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a label group +pub fn delete_label_group(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all label groups +pub fn get_all_label_groups(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/label-groups", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a label group +pub fn get_label_group(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, label_group_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/label-groups/{label_group_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), label_group_name=crate::apis::urlencode(label_group_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/metadata_api.rs b/api/src/apis/metadata_api.rs new file mode 100644 index 00000000..0ccea7a2 --- /dev/null +++ b/api/src/apis/metadata_api.rs @@ -0,0 +1,198 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_document_metadata`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDocumentMetadataError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_image`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageImageError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_selections`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageSelectionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_page_thumbnail`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPageThumbnailError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get metadata +pub fn get_document_metadata(configuration: &configuration::Configuration, attachment_reference: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/render", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get page image +pub fn get_page_image(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/render/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get ocr selections +pub fn get_page_selections(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/selections/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get page thumbnail +pub fn get_page_thumbnail(configuration: &configuration::Configuration, attachment_reference: &str, page_index: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/thumbnail/pages/{page_index}", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference), page_index=crate::apis::urlencode(page_index)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/mod.rs b/api/src/apis/mod.rs new file mode 100644 index 00000000..2506b118 --- /dev/null +++ b/api/src/apis/mod.rs @@ -0,0 +1,132 @@ +use std::error; +use std::fmt; + +#[derive(Debug, Clone)] +pub struct ResponseContent { + pub status: reqwest::StatusCode, + pub content: String, + pub entity: Option, +} + +#[derive(Debug)] +pub enum Error { + Reqwest(reqwest::Error), + Serde(serde_json::Error), + Io(std::io::Error), + ResponseError(ResponseContent), +} + +impl fmt::Display for Error { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let (module, e) = match self { + Error::Reqwest(e) => ("reqwest", e.to_string()), + Error::Serde(e) => ("serde", e.to_string()), + Error::Io(e) => ("IO", e.to_string()), + Error::ResponseError(e) => ("response", format!("status code {}", e.status)), + }; + write!(f, "error in {module}: {e}") + } +} + +impl error::Error for Error { + fn source(&self) -> Option<&(dyn error::Error + 'static)> { + Some(match self { + Error::Reqwest(e) => e, + Error::Serde(e) => e, + Error::Io(e) => e, + Error::ResponseError(_) => return None, + }) + } +} + +impl From for Error { + fn from(e: reqwest::Error) -> Self { + Error::Reqwest(e) + } +} + +impl From for Error { + fn from(e: serde_json::Error) -> Self { + Error::Serde(e) + } +} + +impl From for Error { + fn from(e: std::io::Error) -> Self { + Error::Io(e) + } +} + +pub fn urlencode>(s: T) -> String { + ::url::form_urlencoded::byte_serialize(s.as_ref().as_bytes()).collect() +} + +pub fn parse_deep_object(prefix: &str, value: &serde_json::Value) -> Vec<(String, String)> { + if let serde_json::Value::Object(object) = value { + let mut params = vec![]; + + for (key, value) in object { + match value { + serde_json::Value::Object(_) => params.append(&mut parse_deep_object( + &format!("{prefix}[{key}]"), + value, + )), + serde_json::Value::Array(array) => { + for (i, value) in array.iter().enumerate() { + params.append(&mut parse_deep_object( + &format!("{prefix}[{key}][{i}]"), + value, + )); + } + }, + serde_json::Value::String(s) => params.push((format!("{prefix}[{key}]"), s.clone())), + _ => params.push((format!("{prefix}[{key}]"), value.to_string())), + } + } + + return params; + } + + unimplemented!("Only objects are supported with style=deepObject") +} + +pub mod alerts_api; +pub mod analytics_api; +pub mod appliance_configs_api; +pub mod attachments_api; +pub mod audit_events_api; +pub mod buckets_api; +pub mod comments_api; +pub mod conversational_filter_api; +pub mod dashboards_api; +pub mod datasets_api; +pub mod deployment_api; +pub mod deprecation_api; +pub mod discover_api; +pub mod documents_api; +pub mod emails_api; +pub mod files_api; +pub mod integrations_api; +pub mod ixp_datasets_api; +pub mod ixp_models_api; +pub mod ixp_projects_api; +pub mod label_defs_api; +pub mod label_groups_api; +pub mod metadata_api; +pub mod model_family_api; +pub mod models_api; +pub mod permissions_api; +pub mod projects_api; +pub mod quotas_api; +pub mod reports_api; +pub mod search_api; +pub mod sources_api; +pub mod streams_api; +pub mod tenants_api; +pub mod themes_api; +pub mod thread_themes_api; +pub mod triggers_api; +pub mod uipath_provisioning_api; +pub mod users_api; + +pub mod configuration; diff --git a/api/src/apis/model_family_api.rs b/api/src/apis/model_family_api.rs new file mode 100644 index 00000000..5ef3d0a1 --- /dev/null +++ b/api/src/apis/model_family_api.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_pretrained_labels`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetPretrainedLabelsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get pretrained labels +pub fn get_pretrained_labels(configuration: &configuration::Configuration, model_family: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/model-family/{model_family}/pretrained-labels", local_var_configuration.base_path, model_family=crate::apis::urlencode(model_family)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/models_api.rs b/api/src/apis/models_api.rs new file mode 100644 index 00000000..a1cda448 --- /dev/null +++ b/api/src/apis/models_api.rs @@ -0,0 +1,847 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`delete_model_tag`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteModelTagError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_models_in_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllModelsInDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_comment_predictions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetCommentPredictionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_label_validation`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetLabelValidationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_model_tags`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetModelTagsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_training_action_ordered_comment_uids`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTrainingActionOrderedCommentUidsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_training_actions_labels`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTrainingActionsLabelsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_validation`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetValidationError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_validation_v1`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetValidationV1Error { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`pin_model`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PinModelError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`predict`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PredictError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`predict_extractions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PredictExtractionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`predict_latest`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PredictLatestError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`predict_raw_emails`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PredictRawEmailsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`put_training_comment_seen`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PutTrainingCommentSeenError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`unpin_model`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UnpinModelError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_model`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateModelError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_model_tag`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateModelTagError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Delete a model tag +pub fn delete_model_tag(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, tag_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/model-tags/{tag_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), tag_name=crate::apis::urlencode(tag_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all the models for a dataset +pub fn get_all_models_in_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, get_all_models_in_dataset_request: models::GetAllModelsInDatasetRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_all_models_in_dataset_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get predictions for a list of comments +pub fn get_comment_predictions(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, get_comment_predictions_request: models::GetCommentPredictionsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-comments", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_comment_predictions_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get label validation for a dataset +pub fn get_label_validation(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, get_label_validation_request: models::GetLabelValidationRequest, beta: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/label-validation", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = beta { + local_var_req_builder = local_var_req_builder.query(&[("beta", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_label_validation_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get model tags +pub fn get_model_tags(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/model-tags", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get ordered comment uids for training action +pub fn get_training_action_ordered_comment_uids(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, training_action_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/{training_action_id}/training-action-comment-uids", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), training_action_id=crate::apis::urlencode(training_action_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get ordered training actions for labels +pub fn get_training_actions_labels(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, beta: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/{model_version}/training-actions/labels", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = beta { + local_var_req_builder = local_var_req_builder.query(&[("beta", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get validation for a dataset +pub fn get_validation(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, beta: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/validation", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = beta { + local_var_req_builder = local_var_req_builder.query(&[("beta", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get validation for a dataset +pub fn get_validation_v1(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/validation", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Pin a model +pub fn pin_model(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/pin", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get predictions from a specific version of a pinned model +pub fn predict(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, predict_request: models::PredictRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&predict_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get extraction predictions from a specific version of a pinned model +pub fn predict_extractions(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, predict_extractions_request: models::PredictExtractionsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-extractions", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&predict_extractions_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get predictions from the latest model +pub fn predict_latest(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, predict_latest_request: models::PredictLatestRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/predict", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&predict_latest_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get predictions on raw emails from a specific model version +pub fn predict_raw_emails(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, predict_raw_emails_request: models::PredictRawEmailsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/labellers/{model_version}/predict-raw-emails", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&predict_raw_emails_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Put a training comment as seen, and perhaps with annotation +pub fn put_training_comment_seen(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, training_action_id: &str, comment_uid: &str, put_comment_as_seen_request: models::PutCommentAsSeenRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/{training_action_id}/{comment_uid}/seen-training-comment", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), training_action_id=crate::apis::urlencode(training_action_id), comment_uid=crate::apis::urlencode(comment_uid)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&put_comment_as_seen_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Unpin a model +pub fn unpin_model(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}/pin", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a model +pub fn update_model(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, model_version: &str, update_model_request: models::UpdateModelRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/labellers/{model_version}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), model_version=crate::apis::urlencode(model_version)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PATCH, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_model_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a model tag +pub fn update_model_tag(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, tag_name: &str, update_model_tag_request: models::UpdateModelTagRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/model-tags/{tag_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), tag_name=crate::apis::urlencode(tag_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_model_tag_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/permissions_api.rs b/api/src/apis/permissions_api.rs new file mode 100644 index 00000000..8258ed47 --- /dev/null +++ b/api/src/apis/permissions_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_derived_permissions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDerivedPermissionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get the derived permissions for a user. +pub fn get_derived_permissions(configuration: &configuration::Configuration, get_derived_permissions_request: models::GetDerivedPermissionsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/permissions/derived", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_derived_permissions_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/projects_api.rs b/api/src/apis/projects_api.rs new file mode 100644 index 00000000..b65cfe11 --- /dev/null +++ b/api/src/apis/projects_api.rs @@ -0,0 +1,387 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`create_project_setup`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateProjectSetupError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_projects`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllProjectsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_projects_v1`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllProjectsV1Error { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_project_resource_counts`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetProjectResourceCountsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a project +pub fn create_project(configuration: &configuration::Configuration, name: &str, create_project_request: models::CreateProjectRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_project_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Create a project with provisioned resources +pub fn create_project_setup(configuration: &configuration::Configuration, name: &str, create_project_setup_request: models::CreateProjectSetupRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/solution-accelerator-project-setup/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_project_setup_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a project +pub fn delete_project(configuration: &configuration::Configuration, name: &str, force: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = force { + local_var_req_builder = local_var_req_builder.query(&[("force", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all projects +pub fn get_all_projects(configuration: &configuration::Configuration, cm_only: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = cm_only { + local_var_req_builder = local_var_req_builder.query(&[("cm_only", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all projects +pub fn get_all_projects_v1(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/projects", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a project by name +pub fn get_project(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get resource counts for a Project +pub fn get_project_resource_counts(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects/{name}/resource_counts", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a project +pub fn update_project(configuration: &configuration::Configuration, name: &str, update_project_request: models::UpdateProjectRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/projects/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_project_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/quotas_api.rs b/api/src/apis/quotas_api.rs new file mode 100644 index 00000000..db97574a --- /dev/null +++ b/api/src/apis/quotas_api.rs @@ -0,0 +1,245 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_quotas_for_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetQuotasForTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant_quota`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantQuotaError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`reset_tenant_quota`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ResetTenantQuotaError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`set_quota_for_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SetQuotaForTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`set_tenant_quota`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SetTenantQuotaError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get all quotas for a given tenant +pub fn get_quotas_for_tenant(configuration: &configuration::Configuration, target_tenant_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/quotas/{target_tenant_id}", local_var_configuration.base_path, target_tenant_id=crate::apis::urlencode(target_tenant_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all quotas in current tenant +pub fn get_tenant_quota(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/quotas", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Reset a tenant quota to its default value +pub fn reset_tenant_quota(configuration: &configuration::Configuration, target_tenant_id: &str, quota_kind: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/quotas/{target_tenant_id}/{quota_kind}", local_var_configuration.base_path, target_tenant_id=crate::apis::urlencode(target_tenant_id), quota_kind=crate::apis::urlencode(quota_kind)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Set the value of a tenant quota +pub fn set_quota_for_tenant(configuration: &configuration::Configuration, target_tenant_id: &str, quota_kind: &str, set_quota_for_tenant_request: models::SetQuotaForTenantRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/quotas/{target_tenant_id}/{quota_kind}", local_var_configuration.base_path, target_tenant_id=crate::apis::urlencode(target_tenant_id), quota_kind=crate::apis::urlencode(quota_kind)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&set_quota_for_tenant_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Set the quota on the current tenant +pub fn set_tenant_quota(configuration: &configuration::Configuration, quota_kind: &str, set_tenant_quota_request: models::SetTenantQuotaRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/quotas/{quota_kind}", local_var_configuration.base_path, quota_kind=crate::apis::urlencode(quota_kind)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&set_tenant_quota_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/reports_api.rs b/api/src/apis/reports_api.rs new file mode 100644 index 00000000..2915dcb7 --- /dev/null +++ b/api/src/apis/reports_api.rs @@ -0,0 +1,290 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboards_in_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardsInDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_dashboards_in_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDashboardsInProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_dashboard`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateDashboardError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a new dashboard +pub fn create_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str, create_dashboard_request: models::CreateDashboardRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_dashboard_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a dashboard +pub fn delete_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a dashboard by project and name +pub fn get_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all dashboards in dataset +pub fn get_dashboards_in_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/dashboards", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all dashboards in project +pub fn get_dashboards_in_project(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a dashboard by project and name +pub fn update_dashboard(configuration: &configuration::Configuration, owner: &str, dashboard_name: &str, update_dashboard_request: models::UpdateDashboardRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/dashboards/{owner}/{dashboard_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dashboard_name=crate::apis::urlencode(dashboard_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_dashboard_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/search_api.rs b/api/src/apis/search_api.rs new file mode 100644 index 00000000..8ce48581 --- /dev/null +++ b/api/src/apis/search_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_document_search`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetDocumentSearchError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get document search selections +pub fn get_document_search(configuration: &configuration::Configuration, attachment_reference: &str, query: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/attachments/{attachment_reference}/selections/search", local_var_configuration.base_path, attachment_reference=crate::apis::urlencode(attachment_reference)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + local_var_req_builder = local_var_req_builder.query(&[("query", &query.to_string())]); + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/sources_api.rs b/api/src/apis/sources_api.rs new file mode 100644 index 00000000..559bb81b --- /dev/null +++ b/api/src/apis/sources_api.rs @@ -0,0 +1,471 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_source`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateSourceError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_source`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteSourceError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_sources`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllSourcesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_sources_in_project`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllSourcesInProjectError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_email_transform_tag_info`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetEmailTransformTagInfoError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_source`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetSourceError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_source_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetSourceByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_source_statistics`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetSourceStatisticsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_threads_by_source`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetThreadsBySourceError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_source`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateSourceError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a source +pub fn create_source(configuration: &configuration::Configuration, owner: &str, source_name: &str, create_source_request: models::CreateSourceRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_source_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a source +pub fn delete_source(configuration: &configuration::Configuration, source_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/id:{source_id}", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all sources +pub fn get_all_sources(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all sources in a project +pub fn get_all_sources_in_project(configuration: &configuration::Configuration, owner: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get info about email transform +pub fn get_email_transform_tag_info(configuration: &configuration::Configuration, transform_tag: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/sources/email-transform/tag:{transform_tag}", local_var_configuration.base_path, transform_tag=crate::apis::urlencode(transform_tag)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a source by project and name +pub fn get_source(configuration: &configuration::Configuration, owner: &str, source_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a source by ID +pub fn get_source_by_id(configuration: &configuration::Configuration, source_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/id:{source_id}", local_var_configuration.base_path, source_id=crate::apis::urlencode(source_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get source statistics +pub fn get_source_statistics(configuration: &configuration::Configuration, owner: &str, source_name: &str, get_source_statistics_request: models::GetSourceStatisticsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/statistics", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_source_statistics_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get threads by source +pub fn get_threads_by_source(configuration: &configuration::Configuration, owner: &str, source_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}/threads", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a source +pub fn update_source(configuration: &configuration::Configuration, owner: &str, source_name: &str, update_source_request: models::UpdateSourceRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/sources/{owner}/{source_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), source_name=crate::apis::urlencode(source_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_source_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/streams_api.rs b/api/src/apis/streams_api.rs new file mode 100644 index 00000000..a1f7c563 --- /dev/null +++ b/api/src/apis/streams_api.rs @@ -0,0 +1,622 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`advance_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AdvanceStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`create_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_exception`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteExceptionError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`fetch_from_gx_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum FetchFromGxStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`fetch_from_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum FetchFromStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_streams`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllStreamsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_stream_by_name`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetStreamByNameError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_stream_results`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetStreamResultsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_stream_results_preview`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetStreamResultsPreviewError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`reset_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ResetStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`store_exception`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum StoreExceptionError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_stream`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateStreamError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Advance stream +pub fn advance_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, advance_stream_request: models::AdvanceStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/advance", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&advance_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Create stream +pub fn create_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, create_stream_request: models::CreateStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete exception +pub fn delete_exception(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/exceptions", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete stream +pub fn delete_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Fetch from GX stream +pub fn fetch_from_gx_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, fetch_from_gx_stream_request: models::FetchFromGxStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/preview/datasets/{owner}/{dataset_name}/streams/{stream_name}/gx-fetch", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&fetch_from_gx_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Fetch from stream +pub fn fetch_from_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, fetch_from_stream_request: models::FetchFromStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/fetch", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&fetch_from_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all streams +pub fn get_all_streams(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get stream by name +pub fn get_stream_by_name(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Returns the next batch of comments from a stream together with their predictions, if the trigger has a model associated with it. This route can be called multiple times and it will return the same results until it's explicitly advances using one of the continuations from the response. +pub fn get_stream_results(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, max_results: Option, max_filtered: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/results", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = max_results { + local_var_req_builder = local_var_req_builder.query(&[("max_results", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = max_filtered { + local_var_req_builder = local_var_req_builder.query(&[("max_filtered", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Returns the next batch of comments from a stream together with their predictions, if the trigger has a model associated with it. This route can be called multiple times and it will return the same results until it's explicitly advances using one of the continuations from the response. Now deprecated, please use `v1` route intead +pub fn get_stream_results_preview(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, max_results: Option, max_filtered: Option) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/preview/datasets/{owner}/{dataset_name}/streams/{stream_name}/results", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_str) = max_results { + local_var_req_builder = local_var_req_builder.query(&[("max_results", &local_var_str.to_string())]); + } + if let Some(ref local_var_str) = max_filtered { + local_var_req_builder = local_var_req_builder.query(&[("max_filtered", &local_var_str.to_string())]); + } + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Reset stream +pub fn reset_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, reset_stream_request: models::ResetStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/reset", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&reset_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Store exception +pub fn store_exception(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, store_exception_request: models::StoreExceptionRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}/exceptions", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&store_exception_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update stream +pub fn update_stream(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, stream_name: &str, create_stream_request: models::CreateStreamRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/streams/{stream_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), stream_name=crate::apis::urlencode(stream_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_stream_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/tenants_api.rs b/api/src/apis/tenants_api.rs new file mode 100644 index 00000000..feb010e0 --- /dev/null +++ b/api/src/apis/tenants_api.rs @@ -0,0 +1,700 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`create_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_tenant_default_project_permissions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteTenantDefaultProjectPermissionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant_client_subnets`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantClientSubnetsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant_default_project_permissions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantDefaultProjectPermissionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant_domains`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantDomainsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenant_entity_def_ids`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantEntityDefIdsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_tenants`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTenantsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`set_tenant_state`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SetTenantStateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_tenant_client_subnets`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTenantClientSubnetsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_tenant_default_project_permissions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTenantDefaultProjectPermissionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_tenant_domains`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTenantDomainsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_tenant_entity_def_ids`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTenantEntityDefIdsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create a new tenant +pub fn create_tenant(configuration: &configuration::Configuration, name: &str, create_tenant_request: models::CreateTenantRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_tenant_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a tenant by name +pub fn delete_tenant(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Clear default project permissions for a tenant +pub fn delete_tenant_default_project_permissions(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/default_project_permissions", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a single tenant by name +pub fn get_tenant(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get client subnets for a tenant +pub fn get_tenant_client_subnets(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/client_subnets", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get default project permissions for a tenant +pub fn get_tenant_default_project_permissions(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/default_project_permissions", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get domains for a tenant +pub fn get_tenant_domains(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/domains", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get entity_def_ids for a tenant +pub fn get_tenant_entity_def_ids(configuration: &configuration::Configuration, name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/entity_def_ids", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get tenants +pub fn get_tenants(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Sets the enabled or disabled state for a tenant +pub fn set_tenant_state(configuration: &configuration::Configuration, name: &str, set_tenant_state_request: models::SetTenantStateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/state", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&set_tenant_state_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a tenant +pub fn update_tenant(configuration: &configuration::Configuration, name: &str, update_tenant_request: models::UpdateTenantRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_tenant_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update client subnets for a tenant +pub fn update_tenant_client_subnets(configuration: &configuration::Configuration, name: &str, update_tenant_client_subnets_request: models::UpdateTenantClientSubnetsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/client_subnets", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_tenant_client_subnets_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update default project permissions for a tenant +pub fn update_tenant_default_project_permissions(configuration: &configuration::Configuration, name: &str, update_tenant_default_project_permissions_request: models::UpdateTenantDefaultProjectPermissionsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/default_project_permissions", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_tenant_default_project_permissions_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update domains for a tenant +pub fn update_tenant_domains(configuration: &configuration::Configuration, name: &str, update_tenant_domains_request: models::UpdateTenantDomainsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/domains", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_tenant_domains_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update entity_def_ids for a tenant +pub fn update_tenant_entity_def_ids(configuration: &configuration::Configuration, name: &str, update_tenant_entity_def_ids_request: models::UpdateTenantEntityDefIdsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/tenants/{name}/entity_def_ids", local_var_configuration.base_path, name=crate::apis::urlencode(name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_tenant_entity_def_ids_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/themes_api.rs b/api/src/apis/themes_api.rs new file mode 100644 index 00000000..72cc1713 --- /dev/null +++ b/api/src/apis/themes_api.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_themes`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetThemesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get a themes by project and name +pub fn get_themes(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/datasets/{owner}/{dataset_name}/themes", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/thread_themes_api.rs b/api/src/apis/thread_themes_api.rs new file mode 100644 index 00000000..22511c4f --- /dev/null +++ b/api/src/apis/thread_themes_api.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`get_thread_themes`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetThreadThemesError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Get description of a thread +pub fn get_thread_themes(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, get_thread_themes_request: models::GetThreadThemesRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/preview/datasets/{owner}/{dataset_name}/thread-themes", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_thread_themes_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/triggers_api.rs b/api/src/apis/triggers_api.rs new file mode 100644 index 00000000..b4eefe03 --- /dev/null +++ b/api/src/apis/triggers_api.rs @@ -0,0 +1,474 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`advance_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AdvanceTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`create_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_trigger_exception`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteTriggerExceptionError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_all_triggers_in_dataset`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetAllTriggersInDatasetError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`poll_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum PollTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`reset_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum ResetTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`store_trigger_exception`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum StoreTriggerExceptionError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_trigger`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateTriggerError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Advance a trigger +pub fn advance_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str, advance_trigger_request: models::AdvanceTriggerRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/advance", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&advance_trigger_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Create a trigger +pub fn create_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, create_trigger_request: models::CreateTriggerRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_trigger_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a trigger +pub fn delete_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete trigger exception +pub fn delete_trigger_exception(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/exceptions", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get the available triggers for a dataset +pub fn get_all_triggers_in_dataset(configuration: &configuration::Configuration, owner: &str, dataset_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a trigger +pub fn get_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// This operation polls a trigger and fetches any new messages +pub fn poll_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str, poll_trigger_request: models::PollTriggerRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/fetch", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&poll_trigger_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Reset a trigger +pub fn reset_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str, reset_trigger_request: models::ResetTriggerRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/reset", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&reset_trigger_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Store trigger exception +pub fn store_trigger_exception(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str, store_exception_request: models::StoreExceptionRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}/exceptions", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&store_exception_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a trigger +pub fn update_trigger(configuration: &configuration::Configuration, owner: &str, dataset_name: &str, trigger_name: &str, update_trigger_request: models::UpdateTriggerRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/datasets/{owner}/{dataset_name}/triggers/{trigger_name}", local_var_configuration.base_path, owner=crate::apis::urlencode(owner), dataset_name=crate::apis::urlencode(dataset_name), trigger_name=crate::apis::urlencode(trigger_name)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_trigger_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/uipath_provisioning_api.rs b/api/src/apis/uipath_provisioning_api.rs new file mode 100644 index 00000000..1930bacb --- /dev/null +++ b/api/src/apis/uipath_provisioning_api.rs @@ -0,0 +1,202 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`uipath_provision_create`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UipathProvisionCreateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`uipath_provision_delete`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UipathProvisionDeleteError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`uipath_provision_restore`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UipathProvisionRestoreError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`uipath_provision_update`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UipathProvisionUpdateError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Create resources for a Uipath tenant +pub fn uipath_provision_create(configuration: &configuration::Configuration, ui_path_provision_create_request: models::UiPathProvisionCreateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/tenantserviceinstances", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&ui_path_provision_create_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete resources for a Uipath tenant +pub fn uipath_provision_delete(configuration: &configuration::Configuration, service_type: &str, tenant_id: &str, ui_path_provision_delete_request: models::UiPathProvisionDeleteRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/tenantserviceinstances/{service_type}/{tenant_id}", local_var_configuration.base_path, service_type=crate::apis::urlencode(service_type), tenant_id=crate::apis::urlencode(tenant_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&ui_path_provision_delete_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Restore resources for a Uipath tenant +pub fn uipath_provision_restore(configuration: &configuration::Configuration, service_type: &str, tenant_id: &str, ui_path_provision_restore_request: models::UiPathProvisionRestoreRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/tenantserviceinstances/{service_type}/{tenant_id}/restore", local_var_configuration.base_path, service_type=crate::apis::urlencode(service_type), tenant_id=crate::apis::urlencode(tenant_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&ui_path_provision_restore_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update resources for a Uipath tenant +pub fn uipath_provision_update(configuration: &configuration::Configuration, service_type: &str, tenant_id: &str, ui_path_provision_update_request: models::UiPathProvisionUpdateRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/tenantserviceinstances/{service_type}/{tenant_id}", local_var_configuration.base_path, service_type=crate::apis::urlencode(service_type), tenant_id=crate::apis::urlencode(tenant_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PATCH, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&ui_path_provision_update_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/apis/users_api.rs b/api/src/apis/users_api.rs new file mode 100644 index 00000000..062fcaea --- /dev/null +++ b/api/src/apis/users_api.rs @@ -0,0 +1,473 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + +use reqwest; +use serde::{Deserialize, Serialize}; +use crate::{apis::ResponseContent, models}; +use super::{Error, configuration}; + + +/// struct for typed errors of method [`add_support_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum AddSupportTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`create_user`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum CreateUserError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`delete_user`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum DeleteUserError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_reduced_permissions`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetReducedPermissionsError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_user_by_id`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetUserByIdError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_users`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetUsersError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`get_users_v1`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum GetUsersV1Error { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`remove_support_tenant`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum RemoveSupportTenantError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`send_welcome_email`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum SendWelcomeEmailError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + +/// struct for typed errors of method [`update_user`] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UpdateUserError { + Status4XX(models::ErrorResponse), + Status5XX(models::ErrorResponse), + UnknownValue(serde_json::Value), +} + + +/// Add a support tenant +pub fn add_support_tenant(configuration: &configuration::Configuration, add_support_tenant_request: models::AddSupportTenantRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/support-tenants/add", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&add_support_tenant_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Create a user +pub fn create_user(configuration: &configuration::Configuration, create_user_request: models::CreateUserRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&create_user_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Delete a user +pub fn delete_user(configuration: &configuration::Configuration, user_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/{user_id}", local_var_configuration.base_path, user_id=crate::apis::urlencode(user_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get the reduced permissions for a user +pub fn get_reduced_permissions(configuration: &configuration::Configuration, get_reduced_permissions_request: models::GetReducedPermissionsRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/permissions/reduced", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&get_reduced_permissions_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get a user by id +pub fn get_user_by_id(configuration: &configuration::Configuration, user_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/{user_id}", local_var_configuration.base_path, user_id=crate::apis::urlencode(user_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all users +pub fn get_users(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Get all users. +pub fn get_users_v1(configuration: &configuration::Configuration, ) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/v1/users", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Remove a support tenant +pub fn remove_support_tenant(configuration: &configuration::Configuration, remove_support_tenant_request: models::RemoveSupportTenantRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/support-tenants/remove", local_var_configuration.base_path); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&remove_support_tenant_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Send a welcome email +pub fn send_welcome_email(configuration: &configuration::Configuration, user_id: &str) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/{user_id}/welcome-email", local_var_configuration.base_path, user_id=crate::apis::urlencode(user_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + +/// Update a user +pub fn update_user(configuration: &configuration::Configuration, user_id: &str, update_user_request: models::UpdateUserRequest) -> Result> { + let local_var_configuration = configuration; + + let local_var_client = &local_var_configuration.client; + + let local_var_uri_str = format!("{}/api/_private/users/{user_id}", local_var_configuration.base_path, user_id=crate::apis::urlencode(user_id)); + let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str()); + + if let Some(ref local_var_user_agent) = local_var_configuration.user_agent { + local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone()); + } + if let Some(ref local_var_apikey) = local_var_configuration.api_key { + let local_var_key = local_var_apikey.key.clone(); + let local_var_value = match local_var_apikey.prefix { + Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"), + None => local_var_key, + }; + local_var_req_builder = local_var_req_builder.header("authorization", local_var_value); + }; + local_var_req_builder = local_var_req_builder.json(&update_user_request); + + let local_var_req = local_var_req_builder.build()?; + let local_var_resp = local_var_client.execute(local_var_req)?; + + let local_var_status = local_var_resp.status(); + let local_var_content = local_var_resp.text()?; + + if !local_var_status.is_client_error() && !local_var_status.is_server_error() { + serde_json::from_str(&local_var_content).map_err(Error::from) + } else { + let local_var_entity: Option = serde_json::from_str(&local_var_content).ok(); + let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity }; + Err(Error::ResponseError(local_var_error)) + } +} + diff --git a/api/src/error.rs b/api/src/error.rs deleted file mode 100644 index 75543e69..00000000 --- a/api/src/error.rs +++ /dev/null @@ -1,93 +0,0 @@ -use std::path::PathBuf; - -use reqwest::StatusCode; - -pub type Result = std::result::Result; - -#[derive(Debug, thiserror::Error)] -pub enum Error { - #[error("API request failed with {}: {}", status_code, message)] - Api { - status_code: StatusCode, - message: String, - }, - - #[error("Invalid endpoint: '{}'", endpoint)] - BadEndpoint { endpoint: url::Url }, - - #[error("Bad token: {}", token)] - BadToken { token: String }, - - #[error("File does not exist : {}", path.to_string_lossy())] - FileDoesNotExist { path: PathBuf }, - - #[error("Expected / or a source id, got: {}", identifier)] - BadSourceIdentifier { identifier: String }, - - #[error("Expected / or a dataset id, got: {}", identifier)] - BadDatasetIdentifier { identifier: String }, - - #[error("Expected /: {}", identifier)] - BadIntegrationIdentifier { identifier: String }, - - #[error("Expected //: {}", identifier)] - BadStreamName { identifier: String }, - - #[error("Expected u64: {}", version)] - BadStreamModelVersion { version: String }, - - #[error( - "Expected a user id (usernames and emails are not supported), got: {}", - identifier - )] - BadUserIdentifier { identifier: String }, - - #[error("Expected a valid project name, got: {}", identifier)] - BadProjectIdentifier { identifier: String }, - - #[error("Unknown project permission: {}", permission)] - BadProjectPermission { permission: String }, - - #[error("Unknown global permission: {}", permission)] - BadGlobalPermission { permission: String }, - - #[error("Expected / or a bucket id, got: {}", identifier)] - BadBucketIdentifier { identifier: String }, - - #[error("Expected /, got: {}", name)] - BadBucketName { name: String }, - - #[error("Expected a valid bucket type, got: {}", bucket_type)] - BadBucketType { bucket_type: String }, - - #[error("Expected a valid quota kind, got: {}", tenant_quota_kind)] - BadTenantQuotaKind { tenant_quota_kind: String }, - - #[error("Could not parse JSON response.")] - BadJsonResponse(#[source] reqwest::Error), - - #[error( - "Status code {} inconsistent with response payload: {}", - status_code, - message - )] - BadProtocol { - status_code: StatusCode, - message: String, - }, - - #[error("Failed to initialise the HTTP client")] - BuildHttpClient(#[source] reqwest::Error), - - #[error("HTTP request error: {}", message)] - ReqwestError { - message: String, - source: reqwest::Error, - }, - - #[error("An unknown error has occurred: {}", message)] - Unknown { - message: String, - source: Box, - }, -} diff --git a/api/src/lib.rs b/api/src/lib.rs index 7138a303..e1520628 100644 --- a/api/src/lib.rs +++ b/api/src/lib.rs @@ -1,2504 +1,11 @@ -#![deny(clippy::all)] -mod error; -pub mod resources; -pub mod retry; +#![allow(unused_imports)] +#![allow(clippy::too_many_arguments)] -use chrono::{DateTime, Utc}; -use http::{header::ACCEPT, Method}; -use log::debug; -use once_cell::sync::Lazy; -use reqwest::{ - blocking::{ - multipart::{Form, Part}, - Client as HttpClient, Response as HttpResponse, - }, - header::{self, HeaderMap, HeaderValue}, - IntoUrl, Proxy, Result as ReqwestResult, -}; -use resources::{ - attachments::UploadAttachmentResponse, - auth::{RefreshUserPermissionsRequest, RefreshUserPermissionsResponse}, - bucket::{ - GetKeyedSyncStateIdsRequest, GetKeyedSyncStateIdsResponse, GetKeyedSyncStatesResponse, - KeyedSyncState, KeyedSyncStateId, - }, - bucket_statistics::GetBucketStatisticsResponse, - comment::{AttachmentReference, CommentTimestampFilter}, - dataset::{ - CreateIxpDatasetRequest, CreateIxpDatasetResponse, GetAllModelsInDatasetRequest, - GetAllModelsInDatasetRespone, IxpDatasetNew, QueryRequestParams, QueryResponse, - StatisticsRequestParams as DatasetStatisticsRequestParams, SummaryRequestParams, - SummaryResponse, UploadIxpDocumentResponse, UserModelMetadata, - }, - documents::{Document, SyncRawEmailsRequest, SyncRawEmailsResponse}, - email::{Email, GetEmailResponse}, - integration::{ - GetIntegrationResponse, GetIntegrationsResponse, Integration, NewIntegration, - PostIntegrationRequest, PostIntegrationResponse, PutIntegrationRequest, - PutIntegrationResponse, - }, - label_def::{CreateOrUpdateLabelDefsBulkRequest, CreateOrUpdateLabelDefsBulkResponse}, - project::ForceDeleteProject, - quota::{GetQuotasResponse, Quota}, - source::StatisticsRequestParams as SourceStatisticsRequestParams, - stream::{GetStreamResponse, NewStream, PutStreamRequest, PutStreamResponse}, - tenant_id::UiPathTenantId, - validation::{ - LabelValidation, LabelValidationRequest, LabelValidationResponse, ValidationResponse, - }, -}; -use serde::{Deserialize, Serialize}; -use serde_json::json; -use std::{ - cell::Cell, - fmt::{Debug, Display}, - io::Read, - path::{Path, PathBuf}, - time::Duration, -}; -use url::Url; +extern crate serde_repr; +extern crate serde; +extern crate serde_json; +extern crate url; +extern crate reqwest; -use crate::resources::{ - audit::{AuditQueryFilter, AuditQueryRequest, AuditQueryResponse}, - bucket::{ - CreateRequest as CreateBucketRequest, CreateResponse as CreateBucketResponse, - GetAvailableResponse as GetAvailableBucketsResponse, GetResponse as GetBucketResponse, - }, - bucket_statistics::Statistics as BucketStatistics, - comment::{ - GetAnnotationsResponse, GetCommentResponse, GetLabellingsAfter, GetPredictionsResponse, - GetRecentRequest, PutCommentsRequest, PutCommentsResponse, RecentCommentsPage, - SyncCommentsRequest, UpdateAnnotationsRequest, - }, - dataset::{ - CreateRequest as CreateDatasetRequest, CreateResponse as CreateDatasetResponse, - GetAvailableResponse as GetAvailableDatasetsResponse, GetResponse as GetDatasetResponse, - UpdateRequest as UpdateDatasetRequest, UpdateResponse as UpdateDatasetResponse, - }, - email::{PutEmailsRequest, PutEmailsResponse}, - project::{ - CreateProjectRequest, CreateProjectResponse, GetProjectResponse, GetProjectsResponse, - UpdateProjectRequest, UpdateProjectResponse, - }, - quota::{CreateQuota, TenantQuotaKind}, - source::{ - CreateRequest as CreateSourceRequest, CreateResponse as CreateSourceResponse, - GetAvailableResponse as GetAvailableSourcesResponse, GetResponse as GetSourceResponse, - UpdateRequest as UpdateSourceRequest, UpdateResponse as UpdateSourceResponse, - }, - statistics::GetResponse as GetStatisticsResponse, - stream::{ - AdvanceRequest as StreamAdvanceRequest, FetchRequest as StreamFetchRequest, - GetStreamsResponse, ResetRequest as StreamResetRequest, - TagExceptionsRequest as TagStreamExceptionsRequest, - }, - tenant_id::TenantId, - user::{ - CreateRequest as CreateUserRequest, CreateResponse as CreateUserResponse, - GetAvailableResponse as GetAvailableUsersResponse, - GetCurrentResponse as GetCurrentUserResponse, GetResponse as GetUserResponse, - PostUserRequest, PostUserResponse, WelcomeEmailResponse, - }, - EmptySuccess, Response, -}; - -use crate::retry::{Retrier, RetryConfig}; - -pub use crate::{ - error::{Error, Result}, - resources::{ - bucket::{ - Bucket, BucketType, FullName as BucketFullName, Id as BucketId, - Identifier as BucketIdentifier, Name as BucketName, NewBucket, - }, - comment::{ - AnnotatedComment, Comment, CommentFilter, CommentPredictionsThreshold, - CommentsIterPage, Continuation, EitherLabelling, Entities, Entity, - GetCommentPredictionsRequest, HasAnnotations, Id as CommentId, Label, Labelling, - Message, MessageBody, MessageSignature, MessageSubject, NewAnnotatedComment, - NewComment, NewEntities, NewLabelling, NewMoonForm, PredictedLabel, Prediction, - PropertyMap, PropertyValue, Sentiment, SyncCommentsResponse, TriggerLabelThreshold, - Uid as CommentUid, - }, - dataset::{ - Dataset, FullName as DatasetFullName, Id as DatasetId, Identifier as DatasetIdentifier, - ModelVersion, Name as DatasetName, NewDataset, UpdateDataset, - }, - email::{ - Continuation as EmailContinuation, EmailsIterPage, Id as EmailId, Mailbox, MimeContent, - NewEmail, - }, - entity_def::{EntityDef, Id as EntityDefId, Name as EntityName, NewEntityDef}, - integration::FullName as IntegrationFullName, - label_def::{ - LabelDef, LabelDefPretrained, MoonFormFieldDef, Name as LabelName, NewLabelDef, - NewLabelDefPretrained, PretrainedId as LabelDefPretrainedId, - }, - label_group::{ - LabelGroup, Name as LabelGroupName, NewLabelGroup, DEFAULT_LABEL_GROUP_NAME, - }, - project::{NewProject, Project, ProjectName, UpdateProject}, - source::{ - FullName as SourceFullName, Id as SourceId, Identifier as SourceIdentifier, - Name as SourceName, NewSource, Source, SourceKind, TransformTag, UpdateSource, - }, - statistics::Statistics as CommentStatistics, - stream::{ - Batch as StreamBatch, FullName as StreamFullName, SequenceId as StreamSequenceId, - Stream, StreamException, StreamExceptionMetadata, - }, - user::{ - Email as UserEmail, GlobalPermission, Id as UserId, Identifier as UserIdentifier, - ModifiedPermissions, NewUser, ProjectPermission, UpdateUser, User, Username, - }, - }, -}; - -#[derive(Clone, Debug, PartialEq, Eq)] -pub struct Token(pub String); - -pub trait SplittableRequest { - fn split(self) -> impl Iterator - where - Self: Sized; - - fn count(&self) -> usize; -} - -pub struct SplitableRequestResponse -where - for<'de> ResponseT: Deserialize<'de> + ReducibleResponse, -{ - pub response: ResponseT, - pub num_failed: usize, -} - -pub trait ReducibleResponse { - fn merge(self, _b: Self) -> Self - where - Self: std::default::Default, - { - Default::default() - } - - fn empty() -> Self - where - Self: std::default::Default, - { - Default::default() - } -} - -pub struct Config { - pub endpoint: Url, - pub token: Token, - pub accept_invalid_certificates: bool, - pub proxy: Option, - /// Retry settings to use, if any. This will apply to all requests except for POST requests - /// which are not idempotent (as they cannot be naively retried). - pub retry_config: Option, -} - -impl Default for Config { - fn default() -> Self { - Config { - endpoint: DEFAULT_ENDPOINT.clone(), - token: Token("".to_owned()), - accept_invalid_certificates: false, - proxy: None, - retry_config: None, - } - } -} - -#[derive(Debug)] -pub struct Client { - endpoints: Endpoints, - http_client: HttpClient, - headers: HeaderMap, - retrier: Option, -} - -#[derive(Serialize)] -pub struct GetLabellingsInBulk<'a> { - pub source_id: &'a SourceId, - pub return_predictions: &'a bool, - - #[serde(skip_serializing_if = "Option::is_none")] - pub after: &'a Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub limit: &'a Option, -} - -#[derive(Serialize)] -pub struct GetCommentsIterPageQuery<'a> { - #[serde(skip_serializing_if = "Option::is_none")] - pub from_timestamp: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - pub to_timestamp: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - pub after: Option<&'a Continuation>, - pub limit: usize, - pub include_markup: bool, -} - -#[derive(Serialize)] -pub struct GetEmailsIterPageQuery<'a> { - #[serde(skip_serializing_if = "Option::is_none")] - pub continuation: Option<&'a EmailContinuation>, - pub limit: usize, -} - -#[derive(Serialize)] -pub struct GetCommentQuery { - pub include_markup: bool, -} - -#[derive(Serialize)] -pub struct GetEmailQuery { - pub id: String, -} - -impl Client { - /// Create a new API client. - pub fn new(config: Config) -> Result { - let http_client = build_http_client(&config)?; - let headers = build_headers(&config)?; - let endpoints = Endpoints::new(config.endpoint)?; - let retrier = config.retry_config.map(Retrier::new); - Ok(Client { - endpoints, - http_client, - headers, - retrier, - }) - } - - /// Get the base url for the client - pub fn base_url(&self) -> &Url { - &self.endpoints.base - } - - /// List all visible sources. - pub fn get_sources(&self) -> Result> { - Ok(self - .get::<_, GetAvailableSourcesResponse>(self.endpoints.sources.clone())? - .sources) - } - - /// Get a source by either id or name. - pub fn get_user(&self, user: impl Into) -> Result { - Ok(match user.into() { - UserIdentifier::Id(user_id) => { - self.get::<_, GetUserResponse>(self.endpoints.user_by_id(&user_id)?)? - .user - } - }) - } - - /// Get a source by either id or name. - pub fn get_source(&self, source: impl Into) -> Result { - Ok(match source.into() { - SourceIdentifier::Id(source_id) => { - self.get::<_, GetSourceResponse>(self.endpoints.source_by_id(&source_id)?)? - .source - } - SourceIdentifier::FullName(source_name) => { - self.get::<_, GetSourceResponse>(self.endpoints.source_by_name(&source_name)?)? - .source - } - }) - } - - pub fn create_label_defs_bulk( - &self, - dataset_name: &DatasetFullName, - label_group: LabelGroupName, - label_defs: Vec, - ) -> Result<()> { - self.put::<_, _, CreateOrUpdateLabelDefsBulkResponse>( - self.endpoints.label_group(dataset_name, label_group)?, - CreateOrUpdateLabelDefsBulkRequest { label_defs }, - )?; - Ok(()) - } - - /// Create a new source. - pub fn create_source( - &self, - source_name: &SourceFullName, - options: NewSource<'_>, - ) -> Result { - Ok(self - .put::<_, _, CreateSourceResponse>( - self.endpoints.source_by_name(source_name)?, - CreateSourceRequest { source: options }, - )? - .source) - } - - /// Update a source. - pub fn update_source( - &self, - source_name: &SourceFullName, - options: UpdateSource<'_>, - ) -> Result { - Ok(self - .post::<_, _, UpdateSourceResponse>( - self.endpoints.source_by_name(source_name)?, - UpdateSourceRequest { source: options }, - Retry::Yes, - )? - .source) - } - - /// Delete a source. - pub fn delete_source(&self, source: impl Into) -> Result<()> { - let source_id = match source.into() { - SourceIdentifier::Id(source_id) => source_id, - source @ SourceIdentifier::FullName(_) => self.get_source(source)?.id, - }; - self.delete(self.endpoints.source_by_id(&source_id)?) - } - - /// Set a quota - pub fn create_quota( - &self, - target_tenant_id: &TenantId, - tenant_quota_kind: TenantQuotaKind, - options: CreateQuota, - ) -> Result<()> { - self.post( - self.endpoints.quota(target_tenant_id, tenant_quota_kind)?, - options, - Retry::Yes, - ) - } - - /// Get quotas for current tenant - pub fn get_quotas(&self, tenant_id: &Option) -> Result> { - Ok(self - .get::<_, GetQuotasResponse>(self.endpoints.quotas(tenant_id)?)? - .quotas) - } - - /// Delete a user. - pub fn delete_user(&self, user: impl Into) -> Result<()> { - let UserIdentifier::Id(user_id) = user.into(); - self.delete(self.endpoints.user_by_id(&user_id)?) - } - - /// Delete comments by id in a source. - pub fn delete_comments( - &self, - source: impl Into, - comments: &[CommentId], - ) -> Result<()> { - let source_full_name = match source.into() { - source @ SourceIdentifier::Id(_) => self.get_source(source)?.full_name(), - SourceIdentifier::FullName(source_full_name) => source_full_name, - }; - self.delete_query( - self.endpoints.comments_v1(&source_full_name)?, - Some(&id_list_query(comments.iter().map(|uid| &uid.0))), - ) - } - - /// Get a page of comments from a source. - pub fn get_comments_iter_page( - &self, - source_name: &SourceFullName, - continuation: Option<&ContinuationKind>, - to_timestamp: Option>, - limit: usize, - ) -> Result { - // Comments are returned from the API in increasing order of their - // `timestamp` field. - let (from_timestamp, after) = match continuation { - // If we have a timestamp, then this is a request for the first page of - // a series of comments with timestamps starting from the given time. - Some(ContinuationKind::Timestamp(from_timestamp)) => (Some(*from_timestamp), None), - // If we have a continuation, then this is a request for page n+1 of - // a series of comments, where the continuation came from page n. - Some(ContinuationKind::Continuation(after)) => (None, Some(after)), - // Otherwise, this is a request for the first page of a series of comments - // with timestamps starting from the beginning of time. - None => (None, None), - }; - let query_params = GetCommentsIterPageQuery { - from_timestamp, - to_timestamp, - after, - limit, - include_markup: true, - }; - self.get_query(self.endpoints.comments(source_name)?, Some(&query_params)) - } - - /// Iterate through all comments for a given dataset query. - pub fn get_dataset_query_iter<'a>( - &'a self, - dataset_name: &'a DatasetFullName, - params: &'a mut QueryRequestParams, - ) -> DatasetQueryIter<'a> { - DatasetQueryIter::new(self, dataset_name, params) - } - - /// Iterate through all comments in a source. - pub fn get_comments_iter<'a>( - &'a self, - source_name: &'a SourceFullName, - page_size: Option, - timerange: CommentsIterTimerange, - ) -> CommentsIter<'a> { - CommentsIter::new(self, source_name, page_size, timerange) - } - - pub fn get_keyed_sync_state_ids( - &self, - bucket_id: &BucketId, - request: &GetKeyedSyncStateIdsRequest, - ) -> Result> { - Ok(self - .post::<_, _, GetKeyedSyncStateIdsResponse>( - self.endpoints.query_keyed_sync_state_ids(bucket_id)?, - Some(&request), - Retry::Yes, - )? - .keyed_sync_state_ids) - } - - pub fn delete_keyed_sync_state( - &self, - bucket_id: &BucketId, - id: &KeyedSyncStateId, - ) -> Result<()> { - self.delete(self.endpoints.keyed_sync_state(bucket_id, id)?) - } - - pub fn get_keyed_sync_states(&self, bucket_id: &BucketId) -> Result> { - Ok(self - .get::<_, GetKeyedSyncStatesResponse>(self.endpoints.keyed_sync_states(bucket_id)?)? - .keyed_sync_states) - } - - /// Get a single of email from a bucket. - pub fn get_email(&self, bucket_name: &BucketFullName, id: EmailId) -> Result> { - let query_params = GetEmailQuery { id: id.0 }; - Ok(self - .get_query::<_, _, GetEmailResponse>( - self.endpoints.get_emails(bucket_name)?, - Some(&query_params), - )? - .emails) - } - - /// Get a page of emails from a bucket. - pub fn get_emails_iter_page( - &self, - bucket_name: &BucketFullName, - continuation: Option<&EmailContinuation>, - limit: usize, - ) -> Result { - let query_params = GetEmailsIterPageQuery { - continuation, - limit, - }; - self.post( - self.endpoints.get_emails(bucket_name)?, - Some(&query_params), - Retry::Yes, - ) - } - - /// Iterate through all comments in a source. - pub fn get_emails_iter<'a>( - &'a self, - bucket_name: &'a BucketFullName, - page_size: Option, - ) -> EmailsIter<'a> { - EmailsIter::new(self, bucket_name, page_size) - } - - /// Get a single comment by id. - pub fn get_comment<'a>( - &'a self, - source_name: &'a SourceFullName, - comment_id: &'a CommentId, - ) -> Result { - let query_params = GetCommentQuery { - include_markup: true, - }; - Ok(self - .get_query::<_, _, GetCommentResponse>( - self.endpoints.comment_by_id(source_name, comment_id)?, - Some(&query_params), - )? - .comment) - } - pub fn post_integration( - &self, - name: &IntegrationFullName, - integration: &NewIntegration, - ) -> Result { - self.request( - &Method::POST, - &self.endpoints.integration(name)?, - &Some(PostIntegrationRequest { - integration: integration.clone(), - }), - &None::<()>, - &Retry::No, - ) - } - - pub fn put_integration( - &self, - name: &IntegrationFullName, - integration: &NewIntegration, - ) -> Result { - self.request( - &Method::PUT, - &self.endpoints.integration(name)?, - &Some(PutIntegrationRequest { - integration: integration.clone(), - }), - &None::<()>, - &Retry::No, - ) - } - - pub fn put_comments_split_on_failure( - &self, - source_name: &SourceFullName, - comments: Vec, - no_charge: bool, - ) -> Result> { - // Retrying here despite the potential for 409's in order to increase reliability when - // working with poor connection - - self.splitable_request( - Method::PUT, - self.endpoints.put_comments(source_name)?, - PutCommentsRequest { comments }, - Some(NoChargeQuery { no_charge }), - Retry::Yes, - ) - } - - pub fn put_comments( - &self, - source_name: &SourceFullName, - comments: Vec, - no_charge: bool, - ) -> Result { - // Retrying here despite the potential for 409's in order to increase reliability when - // working with poor connection - self.request( - &Method::PUT, - &self.endpoints.put_comments(source_name)?, - &Some(PutCommentsRequest { comments }), - &Some(NoChargeQuery { no_charge }), - &Retry::Yes, - ) - } - - pub fn put_stream( - &self, - dataset_name: &DatasetFullName, - stream: &NewStream, - ) -> Result { - self.put( - self.endpoints.streams(dataset_name)?, - Some(PutStreamRequest { stream }), - ) - } - - pub fn get_audit_events( - &self, - minimum_timestamp: Option>, - maximum_timestamp: Option>, - continuation: Option, - ) -> Result { - self.post::<_, _, AuditQueryResponse>( - self.endpoints.audit_events_query()?, - AuditQueryRequest { - continuation, - filter: AuditQueryFilter { - timestamp: CommentTimestampFilter { - minimum: minimum_timestamp, - maximum: maximum_timestamp, - }, - }, - }, - Retry::Yes, - ) - } - pub fn get_latest_validation( - &self, - dataset_name: &DatasetFullName, - ) -> Result { - self.get::<_, ValidationResponse>(self.endpoints.latest_validation(dataset_name)?) - } - - pub fn get_validation( - &self, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - ) -> Result { - self.get::<_, ValidationResponse>(self.endpoints.validation(dataset_name, model_version)?) - } - - pub fn get_labellers(&self, dataset_name: &DatasetFullName) -> Result> { - Ok(self - .post::<_, _, GetAllModelsInDatasetRespone>( - self.endpoints.labellers(dataset_name)?, - GetAllModelsInDatasetRequest {}, - Retry::Yes, - )? - .labellers) - } - - pub fn get_label_validation( - &self, - label: &LabelName, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - ) -> Result { - Ok(self - .post::<_, _, LabelValidationResponse>( - self.endpoints - .label_validation(dataset_name, model_version)?, - LabelValidationRequest { - label: label.clone(), - }, - Retry::Yes, - )? - .label_validation) - } - - pub fn sync_comments( - &self, - source_name: &SourceFullName, - comments: Vec, - no_charge: bool, - ) -> Result { - self.request( - &Method::POST, - &self.endpoints.sync_comments(source_name)?, - &Some(SyncCommentsRequest { comments }), - &Some(NoChargeQuery { no_charge }), - &Retry::Yes, - ) - } - - pub fn sync_comments_split_on_failure( - &self, - source_name: &SourceFullName, - comments: Vec, - no_charge: bool, - ) -> Result> { - self.splitable_request( - Method::POST, - self.endpoints.sync_comments(source_name)?, - SyncCommentsRequest { comments }, - Some(NoChargeQuery { no_charge }), - Retry::Yes, - ) - } - - pub fn sync_raw_emails( - &self, - source_name: &SourceFullName, - documents: &[Document], - transform_tag: &TransformTag, - include_comments: bool, - no_charge: bool, - ) -> Result { - self.request( - &Method::POST, - &self.endpoints.sync_comments_raw_emails(source_name)?, - &Some(SyncRawEmailsRequest { - documents, - transform_tag, - include_comments, - }), - &Some(NoChargeQuery { no_charge }), - &Retry::Yes, - ) - } - - pub fn put_emails_split_on_failure( - &self, - bucket_name: &BucketFullName, - emails: Vec, - no_charge: bool, - ) -> Result> { - self.splitable_request( - Method::PUT, - self.endpoints.put_emails(bucket_name)?, - PutEmailsRequest { emails }, - Some(NoChargeQuery { no_charge }), - Retry::Yes, - ) - } - - pub fn put_emails( - &self, - bucket_name: &BucketFullName, - emails: Vec, - no_charge: bool, - ) -> Result { - self.request( - &Method::PUT, - &self.endpoints.put_emails(bucket_name)?, - &Some(PutEmailsRequest { emails }), - &Some(NoChargeQuery { no_charge }), - &Retry::Yes, - ) - } - - pub fn post_user(&self, user_id: &UserId, user: UpdateUser) -> Result { - self.post( - self.endpoints.post_user(user_id)?, - PostUserRequest { user: &user }, - Retry::Yes, - ) - } - - pub fn put_comment_audio( - &self, - source_id: &SourceId, - comment_id: &CommentId, - audio_path: impl AsRef, - ) -> Result<()> { - let form = Form::new() - .file("file", audio_path) - .map_err(|source| Error::Unknown { - message: "PUT comment audio operation failed".to_owned(), - source: source.into(), - })?; - let http_response = self - .http_client - .put(self.endpoints.comment_audio(source_id, comment_id)?) - .headers(self.headers.clone()) - .multipart(form) - .send() - .map_err(|source| Error::ReqwestError { - message: "PUT comment audio operation failed".to_owned(), - source, - })?; - let status = http_response.status(); - http_response - .json::>() - .map_err(Error::BadJsonResponse)? - .into_result(status)?; - Ok(()) - } - - pub fn upload_ixp_document( - &self, - source_id: &SourceId, - filename: String, - bytes: Vec, - ) -> Result { - let endpoint = self.endpoints.ixp_documents(source_id)?; - - let do_request = || { - let form = Form::new().part( - "file", - Part::bytes(bytes.clone()).file_name(filename.clone()), - ); - let request = self - .http_client - .request(Method::PUT, endpoint.clone()) - .multipart(form) - .headers(self.headers.clone()); - - request.send() - }; - - let result = self.with_retries(do_request); - - let http_response = result.map_err(|source| Error::ReqwestError { - source, - message: "Operation failed.".to_string(), - })?; - - let status = http_response.status(); - - Ok(http_response - .json::>() - .map_err(Error::BadJsonResponse)? - .into_result(status)? - .comment_id) - } - - pub fn upload_comment_attachment( - &self, - source_id: &SourceId, - comment_id: &CommentId, - attachment_index: usize, - attachment: &PathBuf, - ) -> Result { - let url = self - .endpoints - .attachment_upload(source_id, comment_id, attachment_index)?; - - if !attachment.is_file() || !attachment.exists() { - return Err(Error::FileDoesNotExist { - path: attachment.clone(), - }); - } - - let do_request = || { - let form = Form::new() - .file("file", attachment) - .map_err(|source| Error::Unknown { - message: "PUT comment attachment operation failed".to_owned(), - source: source.into(), - }) - .unwrap(); - let request = self - .http_client - .request(Method::PUT, url.clone()) - .multipart(form) - .headers(self.headers.clone()); - - request.send() - }; - - let result = self.with_retries(do_request); - - let http_response = result.map_err(|source| Error::ReqwestError { - source, - message: "Operation failed.".to_string(), - })?; - - let status = http_response.status(); - - http_response - .json::>() - .map_err(Error::BadJsonResponse)? - .into_result(status) - } - - pub fn get_ixp_document( - &self, - source_id: &SourceId, - comment_id: &CommentId, - ) -> Result> { - self.get_octet_stream(&self.endpoints.ixp_document(source_id, comment_id)?) - } - - fn get_octet_stream(&self, endpoint: &Url) -> Result> { - let mut response = self.raw_request( - &Method::GET, - endpoint, - &None::<()>, - &None::<()>, - &Retry::Yes, - None, - )?; - - let status = response.status(); - - if !status.is_success() { - return Err(Error::Api { - status_code: status, - message: "Bad status code when getting octet stream".to_string(), - }); - } - - let mut buffer = Vec::new(); - - response - .read_to_end(&mut buffer) - .map_err(|source| Error::Unknown { - message: "Failed to read buffer".to_string(), - source: Box::new(source), - })?; - Ok(buffer) - } - - pub fn get_attachment(&self, reference: &AttachmentReference) -> Result> { - self.get_octet_stream(&self.endpoints.attachment_reference(reference)?) - } - - pub fn get_integrations(&self) -> Result> { - Ok(self - .get::<_, GetIntegrationsResponse>(self.endpoints.integrations()?)? - .integrations) - } - - pub fn get_integration(&self, name: &IntegrationFullName) -> Result { - Ok(self - .get::<_, GetIntegrationResponse>(self.endpoints.integration(name)?)? - .integration) - } - - pub fn get_datasets(&self) -> Result> { - Ok(self - .get::<_, GetAvailableDatasetsResponse>(self.endpoints.datasets.clone())? - .datasets) - } - - pub fn get_dataset(&self, dataset: IdentifierT) -> Result - where - IdentifierT: Into, - { - Ok(match dataset.into() { - DatasetIdentifier::Id(dataset_id) => { - self.get::<_, GetDatasetResponse>(self.endpoints.dataset_by_id(&dataset_id)?)? - .dataset - } - DatasetIdentifier::FullName(dataset_name) => { - self.get::<_, GetDatasetResponse>(self.endpoints.dataset_by_name(&dataset_name)?)? - .dataset - } - }) - } - - /// Create a ixp dataset. - pub fn create_ixp_dataset(&self, dataset: IxpDatasetNew) -> Result { - Ok(self - .put::<_, _, CreateIxpDatasetResponse>( - self.endpoints.ixp_datasets()?, - CreateIxpDatasetRequest { dataset }, - )? - .dataset) - } - - /// Create a dataset. - pub fn create_dataset( - &self, - dataset_name: &DatasetFullName, - options: NewDataset<'_>, - ) -> Result { - Ok(self - .put::<_, _, CreateDatasetResponse>( - self.endpoints.dataset_by_name(dataset_name)?, - CreateDatasetRequest { dataset: options }, - )? - .dataset) - } - - /// Update a dataset. - pub fn update_dataset( - &self, - dataset_name: &DatasetFullName, - options: UpdateDataset<'_>, - ) -> Result { - Ok(self - .post::<_, _, UpdateDatasetResponse>( - self.endpoints.dataset_by_name(dataset_name)?, - UpdateDatasetRequest { dataset: options }, - Retry::Yes, - )? - .dataset) - } - - pub fn delete_dataset(&self, dataset: IdentifierT) -> Result<()> - where - IdentifierT: Into, - { - let dataset_id = match dataset.into() { - DatasetIdentifier::Id(dataset_id) => dataset_id, - dataset @ DatasetIdentifier::FullName(_) => self.get_dataset(dataset)?.id, - }; - self.delete(self.endpoints.dataset_by_id(&dataset_id)?) - } - - /// Get labellings for a given a dataset and a list of comment UIDs. - pub fn get_labellings<'a>( - &self, - dataset_name: &DatasetFullName, - comment_uids: impl Iterator, - ) -> Result> { - Ok(self - .get_query::<_, _, GetAnnotationsResponse>( - self.endpoints.get_labellings(dataset_name)?, - Some(&id_list_query(comment_uids.into_iter().map(|id| &id.0))), - )? - .results) - } - - /// Iterate through all reviewed comments in a source. - pub fn get_labellings_iter<'a>( - &'a self, - dataset_name: &'a DatasetFullName, - source_id: &'a SourceId, - return_predictions: bool, - limit: Option, - ) -> LabellingsIter<'a> { - LabellingsIter::new(self, dataset_name, source_id, return_predictions, limit) - } - - /// Get reviewed comments in bulk - pub fn get_labellings_in_bulk( - &self, - dataset_name: &DatasetFullName, - query_parameters: GetLabellingsInBulk<'_>, - ) -> Result { - self.get_query::<_, _, GetAnnotationsResponse>( - self.endpoints.get_labellings(dataset_name)?, - Some(&query_parameters), - ) - } - - /// Update labellings for a given a dataset and comment UID. - pub fn update_labelling( - &self, - dataset_name: &DatasetFullName, - comment_uid: &CommentUid, - labelling: Option<&[NewLabelling]>, - entities: Option<&NewEntities>, - moon_forms: Option<&[NewMoonForm]>, - ) -> Result { - self.post::<_, _, AnnotatedComment>( - self.endpoints.post_labelling(dataset_name, comment_uid)?, - UpdateAnnotationsRequest { - labelling, - entities, - moon_forms, - }, - Retry::Yes, - ) - } - - /// Get predictions for a given a dataset, a model version, and a list of comment UIDs. - pub fn get_comment_predictions<'a>( - &self, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - comment_uids: impl Iterator, - threshold: Option, - labels: Option>, - ) -> Result> { - Ok(self - .post::<_, _, GetPredictionsResponse>( - self.endpoints - .get_comment_predictions(dataset_name, model_version)?, - GetCommentPredictionsRequest { - uids: comment_uids - .into_iter() - .map(|id| id.0.clone()) - .collect::>(), - - threshold, - labels, - }, - Retry::Yes, - )? - .predictions) - } - - pub fn get_streams(&self, dataset_name: &DatasetFullName) -> Result> { - Ok(self - .get::<_, GetStreamsResponse>(self.endpoints.streams(dataset_name)?)? - .streams) - } - - pub fn get_recent_comments( - &self, - dataset_name: &DatasetFullName, - filter: &CommentFilter, - limit: usize, - continuation: Option<&Continuation>, - ) -> Result { - self.post::<_, _, RecentCommentsPage>( - self.endpoints.recent_comments(dataset_name)?, - GetRecentRequest { - limit, - filter, - continuation, - }, - Retry::No, - ) - } - - pub fn refresh_user_permissions(&self) -> Result { - self.post::<_, _, RefreshUserPermissionsResponse>( - self.endpoints.refresh_user_permissions()?, - RefreshUserPermissionsRequest {}, - Retry::Yes, - ) - } - - pub fn get_current_user(&self) -> Result { - Ok(self - .get::<_, GetCurrentUserResponse>(self.endpoints.current_user.clone())? - .user) - } - - pub fn get_users(&self) -> Result> { - Ok(self - .get::<_, GetAvailableUsersResponse>(self.endpoints.users.clone())? - .users) - } - - pub fn create_user(&self, user: NewUser<'_>) -> Result { - Ok(self - .put::<_, _, CreateUserResponse>( - self.endpoints.users.clone(), - CreateUserRequest { user }, - )? - .user) - } - - pub fn dataset_summary( - &self, - dataset_name: &DatasetFullName, - params: &SummaryRequestParams, - ) -> Result { - self.post::<_, _, SummaryResponse>( - self.endpoints.dataset_summary(dataset_name)?, - serde_json::to_value(params).expect("summary params serialization error"), - Retry::Yes, - ) - } - - pub fn query_dataset_csv( - &self, - dataset_name: &DatasetFullName, - params: &QueryRequestParams, - ) -> Result { - let response = self - .raw_request( - &Method::POST, - &self.endpoints.query_dataset(dataset_name)?, - &Some(serde_json::to_value(params).expect("query params serialization error")), - &None::<()>, - &Retry::Yes, - Some(HeaderValue::from_str("text/csv").expect("Could not parse csv header")), - )? - .text() - .expect("Could not get csv text"); - - Ok(response) - } - - pub fn query_dataset( - &self, - dataset_name: &DatasetFullName, - params: &QueryRequestParams, - ) -> Result { - self.post::<_, _, QueryResponse>( - self.endpoints.query_dataset(dataset_name)?, - serde_json::to_value(params).expect("query params serialization error"), - Retry::Yes, - ) - } - - pub fn send_welcome_email(&self, user_id: UserId) -> Result<()> { - self.post::<_, _, WelcomeEmailResponse>( - self.endpoints.welcome_email(&user_id)?, - json!({}), - Retry::No, - )?; - Ok(()) - } - - pub fn get_bucket_statistics(&self, bucket_name: &BucketFullName) -> Result { - Ok(self - .get::<_, GetBucketStatisticsResponse>(self.endpoints.bucket_statistics(bucket_name)?)? - .statistics) - } - - pub fn get_dataset_statistics( - &self, - dataset_name: &DatasetFullName, - params: &DatasetStatisticsRequestParams, - ) -> Result { - Ok(self - .post::<_, _, GetStatisticsResponse>( - self.endpoints.dataset_statistics(dataset_name)?, - serde_json::to_value(params) - .expect("dataset statistics params serialization error"), - Retry::No, - )? - .statistics) - } - - pub fn get_source_statistics( - &self, - source_name: &SourceFullName, - params: &SourceStatisticsRequestParams, - ) -> Result { - Ok(self - .post::<_, _, GetStatisticsResponse>( - self.endpoints.source_statistics(source_name)?, - serde_json::to_value(params).expect("source statistics params serialization error"), - Retry::No, - )? - .statistics) - } - - /// Create a new bucket. - pub fn create_bucket( - &self, - bucket_name: &BucketFullName, - options: NewBucket<'_>, - ) -> Result { - Ok(self - .put::<_, _, CreateBucketResponse>( - self.endpoints.bucket_by_name(bucket_name)?, - CreateBucketRequest { bucket: options }, - )? - .bucket) - } - - pub fn get_buckets(&self) -> Result> { - Ok(self - .get::<_, GetAvailableBucketsResponse>(self.endpoints.buckets.clone())? - .buckets) - } - - pub fn get_bucket(&self, bucket: IdentifierT) -> Result - where - IdentifierT: Into, - { - Ok(match bucket.into() { - BucketIdentifier::Id(bucket_id) => { - self.get::<_, GetBucketResponse>(self.endpoints.bucket_by_id(&bucket_id)?)? - .bucket - } - BucketIdentifier::FullName(bucket_name) => { - self.get::<_, GetBucketResponse>(self.endpoints.bucket_by_name(&bucket_name)?)? - .bucket - } - }) - } - - pub fn delete_bucket(&self, bucket: IdentifierT) -> Result<()> - where - IdentifierT: Into, - { - let bucket_id = match bucket.into() { - BucketIdentifier::Id(bucket_id) => bucket_id, - bucket @ BucketIdentifier::FullName(_) => self.get_bucket(bucket)?.id, - }; - self.delete(self.endpoints.bucket_by_id(&bucket_id)?) - } - - pub fn fetch_stream_comments( - &self, - stream_name: &StreamFullName, - size: u32, - ) -> Result { - self.post( - self.endpoints.stream_fetch(stream_name)?, - StreamFetchRequest { size }, - Retry::No, - ) - } - - pub fn get_stream(&self, stream_name: &StreamFullName) -> Result { - Ok(self - .get::<_, GetStreamResponse>(self.endpoints.stream(stream_name)?)? - .stream) - } - - pub fn advance_stream( - &self, - stream_name: &StreamFullName, - sequence_id: StreamSequenceId, - ) -> Result<()> { - self.post::<_, _, serde::de::IgnoredAny>( - self.endpoints.stream_advance(stream_name)?, - StreamAdvanceRequest { sequence_id }, - Retry::No, - )?; - Ok(()) - } - - pub fn reset_stream( - &self, - stream_name: &StreamFullName, - to_comment_created_at: DateTime, - ) -> Result<()> { - self.post::<_, _, serde::de::IgnoredAny>( - self.endpoints.stream_reset(stream_name)?, - StreamResetRequest { - to_comment_created_at, - }, - Retry::No, - )?; - Ok(()) - } - - pub fn tag_stream_exceptions( - &self, - stream_name: &StreamFullName, - exceptions: &[StreamException], - ) -> Result<()> { - self.put::<_, _, serde::de::IgnoredAny>( - self.endpoints.stream_exceptions(stream_name)?, - TagStreamExceptionsRequest { exceptions }, - )?; - Ok(()) - } - - /// Gets a project. - pub fn get_project(&self, project_name: &ProjectName) -> Result { - let response = - self.get::<_, GetProjectResponse>(self.endpoints.project_by_name(project_name)?)?; - Ok(response.project) - } - - /// Gets all projects. - pub fn get_projects(&self) -> Result> { - let response = self.get::<_, GetProjectsResponse>(self.endpoints.projects.clone())?; - Ok(response.projects) - } - - /// Creates a new project. - pub fn create_project( - &self, - project_name: &ProjectName, - options: NewProject, - user_ids: &[UserId], - ) -> Result { - Ok(self - .put::<_, _, CreateProjectResponse>( - self.endpoints.project_by_name(project_name)?, - CreateProjectRequest { - project: options, - user_ids, - }, - )? - .project) - } - - /// Updates an existing project. - pub fn update_project( - &self, - project_name: &ProjectName, - options: UpdateProject, - ) -> Result { - Ok(self - .post::<_, _, UpdateProjectResponse>( - self.endpoints.project_by_name(project_name)?, - UpdateProjectRequest { project: options }, - Retry::Yes, - )? - .project) - } - - /// Deletes an existing project. - pub fn delete_project( - &self, - project_name: &ProjectName, - force_delete: ForceDeleteProject, - ) -> Result<()> { - let endpoint = self.endpoints.project_by_name(project_name)?; - match force_delete { - ForceDeleteProject::No => self.delete(endpoint)?, - ForceDeleteProject::Yes => { - self.delete_query(endpoint, Some(&json!({ "force": true })))? - } - }; - Ok(()) - } - - fn get(&self, url: LocationT) -> Result - where - LocationT: IntoUrl + Display + Clone, - for<'de> SuccessT: Deserialize<'de>, - { - self.request(&Method::GET, &url, &None::<()>, &None::<()>, &Retry::Yes) - } - - fn get_query( - &self, - url: LocationT, - query: Option<&QueryT>, - ) -> Result - where - LocationT: IntoUrl + Display + Clone, - QueryT: Serialize, - for<'de> SuccessT: Deserialize<'de>, - { - self.request(&Method::GET, &url, &None::<()>, &Some(query), &Retry::Yes) - } - - fn delete(&self, url: LocationT) -> Result<()> - where - LocationT: IntoUrl + Display + Clone, - { - self.delete_query::(url, None) - } - - fn delete_query(&self, url: LocationT, query: Option<&QueryT>) -> Result<()> - where - LocationT: IntoUrl + Display + Clone, - QueryT: Serialize, - { - debug!("Attempting DELETE `{url}`"); - - let attempts = Cell::new(0); - let http_response = self - .with_retries(|| { - attempts.set(attempts.get() + 1); - - let mut request = self - .http_client - .delete(url.clone()) - .headers(self.headers.clone()); - if let Some(query) = query { - request = request.query(query); - } - request.send() - }) - .map_err(|source| Error::ReqwestError { - source, - message: "DELETE operation failed.".to_owned(), - })?; - let status = http_response.status(); - http_response - .json::>() - .map_err(Error::BadJsonResponse)? - .into_result(status) - .map_or_else( - // Ignore 404 not found if the request had to be re-tried - assume the target - // object was deleted on a previous incomplete request. - |error| { - if attempts.get() > 1 && status == reqwest::StatusCode::NOT_FOUND { - Ok(()) - } else { - Err(error) - } - }, - |_| Ok(()), - ) - } - - fn post( - &self, - url: LocationT, - request: RequestT, - retry: Retry, - ) -> Result - where - LocationT: IntoUrl + Display + Clone, - RequestT: Serialize, - for<'de> SuccessT: Deserialize<'de>, - { - self.request(&Method::POST, &url, &Some(request), &None::<()>, &retry) - } - - fn put( - &self, - url: LocationT, - request: RequestT, - ) -> Result - where - LocationT: IntoUrl + Display + Clone, - RequestT: Serialize, - for<'de> SuccessT: Deserialize<'de>, - { - self.request(&Method::PUT, &url, &Some(request), &None::<()>, &Retry::Yes) - } - - fn raw_request( - &self, - method: &Method, - url: &LocationT, - body: &Option, - query: &Option, - retry: &Retry, - accept_header: Option, - ) -> Result - where - LocationT: IntoUrl + Display + Clone, - RequestT: Serialize, - QueryT: Serialize, - { - let mut headers = self.headers.clone(); - - if let Some(accept_header) = accept_header { - headers.insert(ACCEPT, accept_header); - } - - let do_request = || { - let request = self - .http_client - .request(method.clone(), url.clone()) - .headers(headers.clone()); - - let request = match &query { - Some(query) => request.query(query), - None => request, - }; - let request = match &body { - Some(body) => request.json(body), - None => request, - }; - request.send() - }; - - let result = match retry { - Retry::Yes => self.with_retries(do_request), - Retry::No => do_request(), - }; - let http_response = result.map_err(|source| Error::ReqwestError { - source, - message: format!("{method} operation failed."), - })?; - - Ok(http_response) - } - - fn splitable_request( - &self, - method: Method, - url: LocationT, - body: RequestT, - query: Option, - retry: Retry, - ) -> Result> - where - LocationT: IntoUrl + Display + Clone, - RequestT: Serialize + SplittableRequest + Clone, - QueryT: Serialize + Clone, - for<'de> SuccessT: Deserialize<'de> + ReducibleResponse + Clone + Default, - { - debug!("Attempting {method} `{url}`"); - let result: Result = - self.request(&method, &url, &Some(body.clone()), &query, &retry); - - fn should_split(error: &Error) -> bool { - if let Error::Api { status_code, .. } = error { - *status_code == reqwest::StatusCode::UNPROCESSABLE_ENTITY - || *status_code == reqwest::StatusCode::BAD_REQUEST - } else if let Error::BadJsonResponse(_) = error { - // This is for the case where some sort of network config (e.g. cloudflare) blocks - // the request and returns invalid content - true - } else if let Error::ReqwestError { source, .. } = error { - // Should split timeouts - source.is_timeout() - } else { - false - } - } - - match result { - Ok(response) => Ok(SplitableRequestResponse { - response, - num_failed: 0, - }), - Err(error) if should_split(&error) => { - let mut num_failed = 0; - let response = body - .split() - .filter_map(|request| { - match self.request(&method, &url, &Some(request), &query, &retry) { - Ok(response) => Some(response), - Err(_) => { - num_failed += 1; - None - } - } - }) - .fold(SuccessT::empty(), |merged, next: SuccessT| { - merged.merge(next) - }); - - Ok(SplitableRequestResponse { - num_failed, - response, - }) - } - Err(error) => Err(error), - } - } - - fn request( - &self, - method: &Method, - url: &LocationT, - body: &Option, - query: &Option, - retry: &Retry, - ) -> Result - where - LocationT: IntoUrl + Display + Clone, - RequestT: Serialize, - QueryT: Serialize + Clone, - for<'de> SuccessT: Deserialize<'de>, - { - debug!("Attempting {method} `{url}`"); - let http_response = self.raw_request(method, url, body, query, retry, None)?; - - let status = http_response.status(); - http_response - .json::>() - .map_err(Error::BadJsonResponse)? - .into_result(status) - } - - fn with_retries( - &self, - send_request: impl Fn() -> ReqwestResult, - ) -> ReqwestResult { - match &self.retrier { - Some(retrier) => retrier.with_retries(send_request), - None => send_request(), - } - } -} - -#[derive(Copy, Clone)] -enum Retry { - Yes, - No, -} - -pub struct DatasetQueryIter<'a> { - client: &'a Client, - dataset_name: &'a DatasetFullName, - done: bool, - params: &'a mut QueryRequestParams, -} - -impl<'a> DatasetQueryIter<'a> { - fn new( - client: &'a Client, - dataset_name: &'a DatasetFullName, - params: &'a mut QueryRequestParams, - ) -> Self { - Self { - client, - dataset_name, - done: false, - params, - } - } -} - -impl Iterator for DatasetQueryIter<'_> { - type Item = Result>; - - fn next(&mut self) -> Option { - if self.done { - return None; - } - - let response = self.client.query_dataset(self.dataset_name, self.params); - Some(response.map(|page| { - self.params.continuation = page.continuation; - self.done = self.params.continuation.is_none(); - page.results - })) - } -} - -pub enum ContinuationKind { - Timestamp(DateTime), - Continuation(Continuation), -} - -pub struct EmailsIter<'a> { - client: &'a Client, - bucket_name: &'a BucketFullName, - continuation: Option, - done: bool, - page_size: usize, -} - -impl<'a> EmailsIter<'a> { - // Default number of emails per page to request from API. - pub const DEFAULT_PAGE_SIZE: usize = 64; - // Maximum number of emails per page which can be requested from the API. - pub const MAX_PAGE_SIZE: usize = 256; - - fn new(client: &'a Client, bucket_name: &'a BucketFullName, page_size: Option) -> Self { - Self { - client, - bucket_name, - continuation: None, - done: false, - page_size: page_size.unwrap_or(Self::DEFAULT_PAGE_SIZE), - } - } -} - -impl Iterator for EmailsIter<'_> { - type Item = Result>; - - fn next(&mut self) -> Option { - if self.done { - return None; - } - let response = self.client.get_emails_iter_page( - self.bucket_name, - self.continuation.as_ref(), - self.page_size, - ); - Some(response.map(|page| { - self.continuation = page.continuation; - self.done = self.continuation.is_none(); - page.emails - })) - } -} - -pub struct CommentsIter<'a> { - client: &'a Client, - source_name: &'a SourceFullName, - continuation: Option, - done: bool, - page_size: usize, - to_timestamp: Option>, -} - -#[derive(Debug, Default)] -pub struct CommentsIterTimerange { - pub from: Option>, - pub to: Option>, -} -impl<'a> CommentsIter<'a> { - // Default number of comments per page to request from API. - pub const DEFAULT_PAGE_SIZE: usize = 64; - // Maximum number of comments per page which can be requested from the API. - pub const MAX_PAGE_SIZE: usize = 256; - - fn new( - client: &'a Client, - source_name: &'a SourceFullName, - page_size: Option, - timerange: CommentsIterTimerange, - ) -> Self { - let (from_timestamp, to_timestamp) = (timerange.from, timerange.to); - Self { - client, - source_name, - to_timestamp, - continuation: from_timestamp.map(ContinuationKind::Timestamp), - done: false, - page_size: page_size.unwrap_or(Self::DEFAULT_PAGE_SIZE), - } - } -} - -impl Iterator for CommentsIter<'_> { - type Item = Result>; - - fn next(&mut self) -> Option { - if self.done { - return None; - } - let response = self.client.get_comments_iter_page( - self.source_name, - self.continuation.as_ref(), - self.to_timestamp, - self.page_size, - ); - Some(response.map(|page| { - self.continuation = page.continuation.map(ContinuationKind::Continuation); - self.done = self.continuation.is_none(); - page.comments - })) - } -} - -pub struct LabellingsIter<'a> { - client: &'a Client, - dataset_name: &'a DatasetFullName, - source_id: &'a SourceId, - return_predictions: bool, - after: Option, - limit: Option, - done: bool, -} - -impl<'a> LabellingsIter<'a> { - fn new( - client: &'a Client, - dataset_name: &'a DatasetFullName, - source_id: &'a SourceId, - return_predictions: bool, - limit: Option, - ) -> Self { - Self { - client, - dataset_name, - source_id, - return_predictions, - after: None, - limit, - done: false, - } - } -} - -impl Iterator for LabellingsIter<'_> { - type Item = Result>; - - fn next(&mut self) -> Option { - if self.done { - return None; - } - let response = self.client.get_labellings_in_bulk( - self.dataset_name, - GetLabellingsInBulk { - source_id: self.source_id, - return_predictions: &self.return_predictions, - after: &self.after, - limit: &self.limit, - }, - ); - Some(response.map(|page| { - if self.after == page.after && !page.results.is_empty() { - panic!("Labellings API did not increment pagination continuation"); - } - self.after = page.after; - if page.results.is_empty() { - self.done = true; - } - page.results - })) - } -} - -#[derive(Debug)] -struct Endpoints { - base: Url, - datasets: Url, - sources: Url, - buckets: Url, - users: Url, - current_user: Url, - projects: Url, -} - -#[derive(Debug, Serialize, Clone, Copy)] -struct NoChargeQuery { - no_charge: bool, -} - -fn construct_endpoint(base: &Url, segments: &[&str]) -> Result { - let mut endpoint = base.clone(); - - let mut endpoint_segments = endpoint - .path_segments_mut() - .map_err(|_| Error::BadEndpoint { - endpoint: base.clone(), - })?; - - for segment in segments { - endpoint_segments.push(segment); - } - - drop(endpoint_segments); - - Ok(endpoint) -} - -impl Endpoints { - pub fn new(base: Url) -> Result { - let datasets = construct_endpoint(&base, &["api", "v1", "datasets"])?; - let sources = construct_endpoint(&base, &["api", "v1", "sources"])?; - let buckets = construct_endpoint(&base, &["api", "_private", "buckets"])?; - let users = construct_endpoint(&base, &["api", "_private", "users"])?; - let current_user = construct_endpoint(&base, &["auth", "user"])?; - let projects = construct_endpoint(&base, &["api", "_private", "projects"])?; - - Ok(Endpoints { - base, - datasets, - sources, - buckets, - users, - current_user, - projects, - }) - } - - fn refresh_user_permissions(&self) -> Result { - construct_endpoint(&self.base, &["auth", "refresh-user-permissions"]) - } - - fn label_group( - &self, - dataset_name: &DatasetFullName, - label_group: LabelGroupName, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "datasets", - &dataset_name.0, - "labels", - &label_group.0, - ], - ) - } - - fn ixp_datasets(&self) -> Result { - construct_endpoint(&self.base, &["api", "_private", "ixp", "datasets"]) - } - - fn ixp_documents(&self, source_id: &SourceId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "sources", - &format!("id:{0}", source_id.0), - "documents", - ], - ) - } - - fn ixp_document(&self, source_id: &SourceId, comment_id: &CommentId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "sources", - &format!("id:{0}", source_id.0), - "documents", - &comment_id.0, - ], - ) - } - - fn keyed_sync_states(&self, bucket_id: &BucketId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "buckets", - &format!("id:{}", bucket_id.0), - "keyed-sync-states/", - ], - ) - } - - fn keyed_sync_state(&self, bucket_id: &BucketId, id: &KeyedSyncStateId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "buckets", - &format!("id:{}", bucket_id.0), - "keyed-sync-state", - &id.0, - ], - ) - } - - fn query_keyed_sync_state_ids(&self, bucket_id: &BucketId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "buckets", - &format!("id:{}", bucket_id.0), - "keyed-sync-state-ids", - ], - ) - } - - fn audit_events_query(&self) -> Result { - construct_endpoint(&self.base, &["api", "v1", "audit_events", "query"]) - } - - fn integrations(&self) -> Result { - construct_endpoint(&self.base, &["api", "_private", "integrations"]) - } - - fn integration(&self, name: &IntegrationFullName) -> Result { - construct_endpoint(&self.base, &["api", "_private", "integrations", &name.0]) - } - - fn attachment_reference(&self, reference: &AttachmentReference) -> Result { - construct_endpoint(&self.base, &["api", "v1", "attachments", &reference.0]) - } - - fn attachment_upload( - &self, - source_id: &SourceId, - comment_id: &CommentId, - attachment_index: usize, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "sources", - &format!("id:{}", source_id.0), - "comments", - &comment_id.0, - "attachments", - &attachment_index.to_string(), - ], - ) - } - fn latest_validation(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "datasets", - &dataset_name.0, - "labellers", - "latest", - "validation", - ], - ) - } - - fn validation( - &self, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "datasets", - &dataset_name.0, - "labellers", - &model_version.0.to_string(), - "validation", - ], - ) - } - - fn label_validation( - &self, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "datasets", - &dataset_name.0, - "labellers", - &model_version.0.to_string(), - "label-validation", - ], - ) - } - fn bucket_statistics(&self, bucket_name: &BucketFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "buckets", &bucket_name.0, "statistics"], - ) - } - - fn dataset_summary(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "summary"], - ) - } - - fn query_dataset(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "query"], - ) - } - - fn streams(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "datasets", &dataset_name.0, "streams"], - ) - } - - fn stream(&self, stream_name: &StreamFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &stream_name.dataset.0, - "streams", - &stream_name.stream.0, - ], - ) - } - - fn stream_fetch(&self, stream_name: &StreamFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &stream_name.dataset.0, - "streams", - &stream_name.stream.0, - "fetch", - ], - ) - } - - fn stream_advance(&self, stream_name: &StreamFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &stream_name.dataset.0, - "streams", - &stream_name.stream.0, - "advance", - ], - ) - } - - fn stream_reset(&self, stream_name: &StreamFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &stream_name.dataset.0, - "streams", - &stream_name.stream.0, - "reset", - ], - ) - } - - fn stream_exceptions(&self, stream_name: &StreamFullName) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &stream_name.dataset.0, - "streams", - &stream_name.stream.0, - "exceptions", - ], - ) - } - - fn recent_comments(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "recent"], - ) - } - - fn dataset_statistics(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "statistics"], - ) - } - - fn source_statistics(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "sources", &source_name.0, "statistics"], - ) - } - - fn user_by_id(&self, user_id: &UserId) -> Result { - construct_endpoint(&self.base, &["api", "_private", "users", &user_id.0]) - } - - fn source_by_id(&self, source_id: &SourceId) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "sources", &format!("id:{}", source_id.0)], - ) - } - - fn source_by_name(&self, source_name: &SourceFullName) -> Result { - construct_endpoint(&self.base, &["api", "v1", "sources", &source_name.0]) - } - - fn quotas(&self, tenant_id: &Option) -> Result { - if let Some(tenant_id) = tenant_id { - construct_endpoint(&self.base, &["api", "_private", "quotas", &tenant_id.0]) - } else { - construct_endpoint(&self.base, &["api", "_private", "quotas"]) - } - } - - fn quota(&self, tenant_id: &TenantId, tenant_quota_kind: TenantQuotaKind) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "quotas", - &tenant_id.to_string(), - &tenant_quota_kind.to_string(), - ], - ) - } - - fn put_comments(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "sources", &source_name.0, "comments"], - ) - } - - fn comments(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "sources", &source_name.0, "comments"], - ) - } - - fn comment_by_id(&self, source_name: &SourceFullName, comment_id: &CommentId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "sources", - &source_name.0, - "comments", - &comment_id.0, - ], - ) - } - - fn comments_v1(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "sources", &source_name.0, "comments"], - ) - } - - fn sync_comments(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "sources", &source_name.0, "sync"], - ) - } - - fn sync_comments_raw_emails(&self, source_name: &SourceFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "sources", &source_name.0, "sync-raw-emails"], - ) - } - - fn comment_audio(&self, source_id: &SourceId, comment_id: &CommentId) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "sources", - &format!("id:{}", source_id.0), - "comments", - &comment_id.0, - "audio", - ], - ) - } - - fn get_emails(&self, bucket_name: &BucketFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "buckets", &bucket_name.0, "emails"], - ) - } - - fn put_emails(&self, bucket_name: &BucketFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "buckets", &bucket_name.0, "emails"], - ) - } - - fn post_user(&self, user_id: &UserId) -> Result { - construct_endpoint(&self.base, &["api", "_private", "users", &user_id.0]) - } - - fn dataset_by_id(&self, dataset_id: &DatasetId) -> Result { - construct_endpoint( - &self.base, - &["api", "v1", "datasets", &format!("id:{}", dataset_id.0)], - ) - } - - fn dataset_by_name(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint(&self.base, &["api", "v1", "datasets", &dataset_name.0]) - } - - fn get_labellings(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "labellings"], - ) - } - - fn labellers(&self, dataset_name: &DatasetFullName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "datasets", &dataset_name.0, "labellers"], - ) - } - - fn get_comment_predictions( - &self, - dataset_name: &DatasetFullName, - model_version: &ModelVersion, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "v1", - "datasets", - &dataset_name.0, - "labellers", - &model_version.0.to_string(), - "predict-comments", - ], - ) - } - - fn post_labelling( - &self, - dataset_name: &DatasetFullName, - comment_uid: &CommentUid, - ) -> Result { - construct_endpoint( - &self.base, - &[ - "api", - "_private", - "datasets", - &dataset_name.0, - "labellings", - &comment_uid.0, - ], - ) - } - - fn bucket_by_id(&self, bucket_id: &BucketId) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "buckets", &format!("id:{}", bucket_id.0)], - ) - } - - fn bucket_by_name(&self, bucket_name: &BucketFullName) -> Result { - construct_endpoint(&self.base, &["api", "_private", "buckets", &bucket_name.0]) - } - - fn project_by_name(&self, project_name: &ProjectName) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "projects", &project_name.0], - ) - } - - fn welcome_email(&self, user_id: &UserId) -> Result { - construct_endpoint( - &self.base, - &["api", "_private", "users", &user_id.0, "welcome-email"], - ) - } -} - -const DEFAULT_HTTP_TIMEOUT_SECONDS: u64 = 240; - -fn build_http_client(config: &Config) -> Result { - let mut builder = HttpClient::builder() - .gzip(true) - .danger_accept_invalid_certs(config.accept_invalid_certificates) - .timeout(Some(Duration::from_secs(DEFAULT_HTTP_TIMEOUT_SECONDS))); - - if let Some(proxy) = config.proxy.clone() { - builder = builder.proxy(Proxy::all(proxy).map_err(Error::BuildHttpClient)?); - } - builder.build().map_err(Error::BuildHttpClient) -} - -fn build_headers(config: &Config) -> Result { - let mut headers = HeaderMap::new(); - headers.insert( - header::AUTHORIZATION, - HeaderValue::from_str(&format!("Bearer {}", &config.token.0)).map_err(|_| { - Error::BadToken { - token: config.token.0.clone(), - } - })?, - ); - Ok(headers) -} - -fn id_list_query<'a>(ids: impl Iterator) -> Vec<(&'static str, &'a str)> { - // Return a list of pairs ("id", "a"), ("id", "b"), ... - // The http client will turn this into a query string of - // the form "id=a&id=b&..." - ids.map(|id| ("id", id.as_str())).collect() -} - -pub static DEFAULT_ENDPOINT: Lazy = - Lazy::new(|| Url::parse("https://reinfer.dev").expect("Default URL is well-formed")); - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn test_construct_endpoint() { - let url = construct_endpoint( - &Url::parse("https://cloud.uipath.com/org/tenant/reinfer_").unwrap(), - &["api", "v1", "sources", "project", "source", "sync"], - ) - .unwrap(); - - assert_eq!( - url.to_string(), - "https://cloud.uipath.com/org/tenant/reinfer_/api/v1/sources/project/source/sync" - ) - } - - #[test] - fn test_id_list_query() { - assert_eq!(id_list_query(Vec::new().iter()), Vec::new()); - assert_eq!( - id_list_query(["foo".to_owned()].iter()), - vec![("id", "foo")] - ); - assert_eq!( - id_list_query( - [ - "Stream".to_owned(), - "River".to_owned(), - "Waterfall".to_owned() - ] - .iter() - ), - [("id", "Stream"), ("id", "River"), ("id", "Waterfall"),] - ); - } -} +pub mod apis; +pub mod models; diff --git a/api/src/models/_audit_events_dataset.rs b/api/src/models/_audit_events_dataset.rs new file mode 100644 index 00000000..400fc743 --- /dev/null +++ b/api/src/models/_audit_events_dataset.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsDataset { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "project_id")] + pub project_id: String, +} + +impl AuditEventsDataset { + pub fn new(id: String, name: String, title: String, project_id: String) -> AuditEventsDataset { + AuditEventsDataset { + id, + name, + title, + project_id, + } + } +} + diff --git a/api/src/models/_audit_events_project.rs b/api/src/models/_audit_events_project.rs new file mode 100644 index 00000000..a509ab68 --- /dev/null +++ b/api/src/models/_audit_events_project.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsProject { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "name")] + pub name: String, +} + +impl AuditEventsProject { + pub fn new(id: String, tenant_id: String, name: String) -> AuditEventsProject { + AuditEventsProject { + id, + tenant_id, + name, + } + } +} + diff --git a/api/src/models/_audit_events_source.rs b/api/src/models/_audit_events_source.rs new file mode 100644 index 00000000..6b134b39 --- /dev/null +++ b/api/src/models/_audit_events_source.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsSource { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "project_id")] + pub project_id: String, +} + +impl AuditEventsSource { + pub fn new(id: String, name: String, title: String, project_id: String) -> AuditEventsSource { + AuditEventsSource { + id, + name, + title, + project_id, + } + } +} + diff --git a/api/src/models/_audit_events_tenant.rs b/api/src/models/_audit_events_tenant.rs new file mode 100644 index 00000000..feb54278 --- /dev/null +++ b/api/src/models/_audit_events_tenant.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsTenant { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, +} + +impl AuditEventsTenant { + pub fn new(id: String, name: String) -> AuditEventsTenant { + AuditEventsTenant { + id, + name, + } + } +} + diff --git a/api/src/models/_audit_events_trigger.rs b/api/src/models/_audit_events_trigger.rs new file mode 100644 index 00000000..0e4d74c8 --- /dev/null +++ b/api/src/models/_audit_events_trigger.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsTrigger { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "dataset_id")] + pub dataset_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, +} + +impl AuditEventsTrigger { + pub fn new(id: String, dataset_id: String, name: String, title: String) -> AuditEventsTrigger { + AuditEventsTrigger { + id, + dataset_id, + name, + title, + } + } +} + diff --git a/api/src/models/_audit_events_user.rs b/api/src/models/_audit_events_user.rs new file mode 100644 index 00000000..557e0271 --- /dev/null +++ b/api/src/models/_audit_events_user.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEventsUser { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "display_name")] + pub display_name: String, +} + +impl AuditEventsUser { + pub fn new(id: String, tenant_id: String, username: String, email: String, display_name: String) -> AuditEventsUser { + AuditEventsUser { + id, + tenant_id, + username, + email, + display_name, + } + } +} + diff --git a/api/src/models/_bucket_statistics.rs b/api/src/models/_bucket_statistics.rs new file mode 100644 index 00000000..a057e74c --- /dev/null +++ b/api/src/models/_bucket_statistics.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BucketStatistics { + #[serde(rename = "count")] + pub count: Box, +} + +impl BucketStatistics { + pub fn new(count: models::Count) -> BucketStatistics { + BucketStatistics { + count: Box::new(count), + } + } +} + diff --git a/api/src/models/_by_labels_include_container.rs b/api/src/models/_by_labels_include_container.rs new file mode 100644 index 00000000..09ecd175 --- /dev/null +++ b/api/src/models/_by_labels_include_container.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ByLabelsIncludeContainer { + #[serde(rename = "include")] + pub include: Box, +} + +impl ByLabelsIncludeContainer { + pub fn new(include: models::ByLabelsInclude) -> ByLabelsIncludeContainer { + ByLabelsIncludeContainer { + include: Box::new(include), + } + } +} + diff --git a/api/src/models/_by_labels_top_container.rs b/api/src/models/_by_labels_top_container.rs new file mode 100644 index 00000000..a0fd798a --- /dev/null +++ b/api/src/models/_by_labels_top_container.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ByLabelsTopContainer { + #[serde(rename = "top")] + pub top: Box, +} + +impl ByLabelsTopContainer { + pub fn new(top: models::ByLabelsTop) -> ByLabelsTopContainer { + ByLabelsTopContainer { + top: Box::new(top), + } + } +} + diff --git a/api/src/models/_dataset_string_summary_value.rs b/api/src/models/_dataset_string_summary_value.rs new file mode 100644 index 00000000..3984b261 --- /dev/null +++ b/api/src/models/_dataset_string_summary_value.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetStringSummaryValue { + #[serde(rename = "value")] + pub value: String, +} + +impl DatasetStringSummaryValue { + pub fn new(value: String) -> DatasetStringSummaryValue { + DatasetStringSummaryValue { + value, + } + } +} + diff --git a/api/src/models/_dataset_user_properties_summary_number.rs b/api/src/models/_dataset_user_properties_summary_number.rs new file mode 100644 index 00000000..c64729bd --- /dev/null +++ b/api/src/models/_dataset_user_properties_summary_number.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetUserPropertiesSummaryNumber { + #[serde(rename = "full_name")] + pub full_name: String, +} + +impl DatasetUserPropertiesSummaryNumber { + pub fn new(full_name: String) -> DatasetUserPropertiesSummaryNumber { + DatasetUserPropertiesSummaryNumber { + full_name, + } + } +} + diff --git a/api/src/models/_dataset_user_properties_summary_string.rs b/api/src/models/_dataset_user_properties_summary_string.rs new file mode 100644 index 00000000..fdadf7d3 --- /dev/null +++ b/api/src/models/_dataset_user_properties_summary_string.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetUserPropertiesSummaryString { + /// Full name of the string + #[serde(rename = "full_name")] + pub full_name: String, + /// Whether there are too many values to show + #[serde(rename = "too_many_values")] + pub too_many_values: bool, + /// List of values + #[serde(rename = "values")] + pub values: Vec, +} + +impl DatasetUserPropertiesSummaryString { + pub fn new(full_name: String, too_many_values: bool, values: Vec) -> DatasetUserPropertiesSummaryString { + DatasetUserPropertiesSummaryString { + full_name, + too_many_values, + values, + } + } +} + diff --git a/api/src/models/_entity_summary_v1.rs b/api/src/models/_entity_summary_v1.rs new file mode 100644 index 00000000..508e20d3 --- /dev/null +++ b/api/src/models/_entity_summary_v1.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntitySummaryV1 { + /// Entity name + #[serde(rename = "name")] + pub name: String, + /// Entity title + #[serde(rename = "title")] + pub title: String, +} + +impl EntitySummaryV1 { + pub fn new(name: String, title: String) -> EntitySummaryV1 { + EntitySummaryV1 { + name, + title, + } + } +} + diff --git a/api/src/models/_exact_bucket_count.rs b/api/src/models/_exact_bucket_count.rs new file mode 100644 index 00000000..c338aed1 --- /dev/null +++ b/api/src/models/_exact_bucket_count.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExactBucketCount { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "value")] + pub value: i32, +} + +impl ExactBucketCount { + pub fn new(kind: Kind, value: i32) -> ExactBucketCount { + ExactBucketCount { + kind, + value, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "exact")] + Exact, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Exact + } +} + diff --git a/api/src/models/_label_summary_v1.rs b/api/src/models/_label_summary_v1.rs new file mode 100644 index 00000000..e3dc80be --- /dev/null +++ b/api/src/models/_label_summary_v1.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelSummaryV1 { + /// Label name + #[serde(rename = "name")] + pub name: String, + /// List of label parts + #[serde(rename = "parts")] + pub parts: Vec, +} + +impl LabelSummaryV1 { + pub fn new(name: String, parts: Vec) -> LabelSummaryV1 { + LabelSummaryV1 { + name, + parts, + } + } +} + diff --git a/api/src/models/_lower_bound_bucket_count.rs b/api/src/models/_lower_bound_bucket_count.rs new file mode 100644 index 00000000..e91dad3e --- /dev/null +++ b/api/src/models/_lower_bound_bucket_count.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LowerBoundBucketCount { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "value")] + pub value: i32, +} + +impl LowerBoundBucketCount { + pub fn new(kind: Kind, value: i32) -> LowerBoundBucketCount { + LowerBoundBucketCount { + kind, + value, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "lower_bound")] + LowerBound, +} + +impl Default for Kind { + fn default() -> Kind { + Self::LowerBound + } +} + diff --git a/api/src/models/_query_comments_order_any_label.rs b/api/src/models/_query_comments_order_any_label.rs new file mode 100644 index 00000000..060194c8 --- /dev/null +++ b/api/src/models/_query_comments_order_any_label.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderAnyLabel { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl QueryCommentsOrderAnyLabel { + pub fn new(kind: Kind) -> QueryCommentsOrderAnyLabel { + QueryCommentsOrderAnyLabel { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "any_label_asc")] + AnyLabelAsc, +} + +impl Default for Kind { + fn default() -> Kind { + Self::AnyLabelAsc + } +} + diff --git a/api/src/models/_query_comments_order_attachment_text_search.rs b/api/src/models/_query_comments_order_attachment_text_search.rs new file mode 100644 index 00000000..b01ebbcf --- /dev/null +++ b/api/src/models/_query_comments_order_attachment_text_search.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderAttachmentTextSearch { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "query")] + pub query: String, +} + +impl QueryCommentsOrderAttachmentTextSearch { + pub fn new(kind: Kind, query: String) -> QueryCommentsOrderAttachmentTextSearch { + QueryCommentsOrderAttachmentTextSearch { + kind, + query, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "attachment_text_search")] + AttachmentTextSearch, +} + +impl Default for Kind { + fn default() -> Kind { + Self::AttachmentTextSearch + } +} + diff --git a/api/src/models/_query_comments_order_by_label.rs b/api/src/models/_query_comments_order_by_label.rs new file mode 100644 index 00000000..c6205766 --- /dev/null +++ b/api/src/models/_query_comments_order_by_label.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderByLabel { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "label", skip_serializing_if = "Option::is_none")] + pub label: Option, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option, +} + +impl QueryCommentsOrderByLabel { + pub fn new(kind: Kind) -> QueryCommentsOrderByLabel { + QueryCommentsOrderByLabel { + kind, + label: None, + sentiment: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "by_label")] + ByLabel, +} + +impl Default for Kind { + fn default() -> Kind { + Self::ByLabel + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Sentiment { + #[serde(rename = "positive")] + Positive, + #[serde(rename = "negative")] + Negative, +} + +impl Default for Sentiment { + fn default() -> Sentiment { + Self::Positive + } +} + diff --git a/api/src/models/_query_comments_order_check.rs b/api/src/models/_query_comments_order_check.rs new file mode 100644 index 00000000..65baeaee --- /dev/null +++ b/api/src/models/_query_comments_order_check.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderCheck { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "entity_def_id", skip_serializing_if = "Option::is_none")] + pub entity_def_id: Option, +} + +impl QueryCommentsOrderCheck { + pub fn new(kind: Kind) -> QueryCommentsOrderCheck { + QueryCommentsOrderCheck { + kind, + entity_def_id: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "check")] + Check, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Check + } +} + diff --git a/api/src/models/_query_comments_order_diagnostic.rs b/api/src/models/_query_comments_order_diagnostic.rs new file mode 100644 index 00000000..d647d830 --- /dev/null +++ b/api/src/models/_query_comments_order_diagnostic.rs @@ -0,0 +1,69 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderDiagnostic { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "diagnostic_kind")] + pub diagnostic_kind: DiagnosticKind, + #[serde(rename = "entity_def_id", skip_serializing_if = "Option::is_none")] + pub entity_def_id: Option, +} + +impl QueryCommentsOrderDiagnostic { + pub fn new(kind: Kind, diagnostic_kind: DiagnosticKind) -> QueryCommentsOrderDiagnostic { + QueryCommentsOrderDiagnostic { + kind, + diagnostic_kind, + entity_def_id: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "diagnostic")] + Diagnostic, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Diagnostic + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DiagnosticKind { + #[serde(rename = "bias")] + Bias, + #[serde(rename = "informative")] + Informative, + #[serde(rename = "label_only_neglect")] + LabelOnlyNeglect, + #[serde(rename = "neglect")] + Neglect, + #[serde(rename = "teach_entity")] + TeachEntity, + #[serde(rename = "missed_entity")] + MissedEntity, + #[serde(rename = "check_entity")] + CheckEntity, + #[serde(rename = "extraction_error_rate")] + ExtractionErrorRate, +} + +impl Default for DiagnosticKind { + fn default() -> DiagnosticKind { + Self::Bias + } +} + diff --git a/api/src/models/_query_comments_order_label_property.rs b/api/src/models/_query_comments_order_label_property.rs new file mode 100644 index 00000000..677a761f --- /dev/null +++ b/api/src/models/_query_comments_order_label_property.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderLabelProperty { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "label_property_id")] + pub label_property_id: models::LabelPropertyId, + #[serde(rename = "direction", skip_serializing_if = "Option::is_none")] + pub direction: Option, +} + +impl QueryCommentsOrderLabelProperty { + pub fn new(kind: Kind, label_property_id: models::LabelPropertyId) -> QueryCommentsOrderLabelProperty { + QueryCommentsOrderLabelProperty { + kind, + label_property_id, + direction: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "label_property")] + LabelProperty, +} + +impl Default for Kind { + fn default() -> Kind { + Self::LabelProperty + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Direction { + #[serde(rename = "ascending")] + Ascending, + #[serde(rename = "descending")] + Descending, +} + +impl Default for Direction { + fn default() -> Direction { + Self::Ascending + } +} + diff --git a/api/src/models/_query_comments_order_learning.rs b/api/src/models/_query_comments_order_learning.rs new file mode 100644 index 00000000..2649281a --- /dev/null +++ b/api/src/models/_query_comments_order_learning.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderLearning { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "label", skip_serializing_if = "Option::is_none")] + pub label: Option, +} + +impl QueryCommentsOrderLearning { + pub fn new(kind: Kind) -> QueryCommentsOrderLearning { + QueryCommentsOrderLearning { + kind, + label: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "learning")] + Learning, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Learning + } +} + diff --git a/api/src/models/_query_comments_order_missed.rs b/api/src/models/_query_comments_order_missed.rs new file mode 100644 index 00000000..a48e2af9 --- /dev/null +++ b/api/src/models/_query_comments_order_missed.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderMissed { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "entity_def_id", skip_serializing_if = "Option::is_none")] + pub entity_def_id: Option, +} + +impl QueryCommentsOrderMissed { + pub fn new(kind: Kind) -> QueryCommentsOrderMissed { + QueryCommentsOrderMissed { + kind, + entity_def_id: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "missed")] + Missed, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Missed + } +} + diff --git a/api/src/models/_query_comments_order_recent.rs b/api/src/models/_query_comments_order_recent.rs new file mode 100644 index 00000000..23c661a0 --- /dev/null +++ b/api/src/models/_query_comments_order_recent.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderRecent { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl QueryCommentsOrderRecent { + pub fn new(kind: Kind) -> QueryCommentsOrderRecent { + QueryCommentsOrderRecent { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "recent")] + Recent, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Recent + } +} + diff --git a/api/src/models/_query_comments_order_sample.rs b/api/src/models/_query_comments_order_sample.rs new file mode 100644 index 00000000..cae77133 --- /dev/null +++ b/api/src/models/_query_comments_order_sample.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderSample { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "seed")] + pub seed: i32, +} + +impl QueryCommentsOrderSample { + pub fn new(kind: Kind, seed: i32) -> QueryCommentsOrderSample { + QueryCommentsOrderSample { + kind, + seed, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "sample")] + Sample, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Sample + } +} + diff --git a/api/src/models/_query_comments_order_text_search.rs b/api/src/models/_query_comments_order_text_search.rs new file mode 100644 index 00000000..ece5b442 --- /dev/null +++ b/api/src/models/_query_comments_order_text_search.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsOrderTextSearch { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "query")] + pub query: String, +} + +impl QueryCommentsOrderTextSearch { + pub fn new(kind: Kind, query: String) -> QueryCommentsOrderTextSearch { + QueryCommentsOrderTextSearch { + kind, + query, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "text_search")] + TextSearch, +} + +impl Default for Kind { + fn default() -> Kind { + Self::TextSearch + } +} + diff --git a/api/src/models/_query_dataset_user_property_values_filter.rs b/api/src/models/_query_dataset_user_property_values_filter.rs new file mode 100644 index 00000000..293da366 --- /dev/null +++ b/api/src/models/_query_dataset_user_property_values_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryDatasetUserPropertyValuesFilter { + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, + #[serde(rename = "attribute_filters", skip_serializing_if = "Option::is_none")] + pub attribute_filters: Option>, +} + +impl QueryDatasetUserPropertyValuesFilter { + pub fn new() -> QueryDatasetUserPropertyValuesFilter { + QueryDatasetUserPropertyValuesFilter { + comment_filter: None, + attribute_filters: None, + } + } +} + diff --git a/api/src/models/_raw_email_body.rs b/api/src/models/_raw_email_body.rs new file mode 100644 index 00000000..9a60ac14 --- /dev/null +++ b/api/src/models/_raw_email_body.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RawEmailBody { + #[serde(rename = "plain", skip_serializing_if = "Option::is_none")] + pub plain: Option, + #[serde(rename = "html", skip_serializing_if = "Option::is_none")] + pub html: Option, +} + +impl RawEmailBody { + pub fn new() -> RawEmailBody { + RawEmailBody { + plain: None, + html: None, + } + } +} + diff --git a/api/src/models/_raw_email_headers_parsed.rs b/api/src/models/_raw_email_headers_parsed.rs new file mode 100644 index 00000000..1d065dfd --- /dev/null +++ b/api/src/models/_raw_email_headers_parsed.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RawEmailHeadersParsed { + #[serde(rename = "parsed")] + pub parsed: std::collections::HashMap, +} + +impl RawEmailHeadersParsed { + pub fn new(parsed: std::collections::HashMap) -> RawEmailHeadersParsed { + RawEmailHeadersParsed { + parsed, + } + } +} + diff --git a/api/src/models/_raw_email_headers_raw.rs b/api/src/models/_raw_email_headers_raw.rs new file mode 100644 index 00000000..22d59dee --- /dev/null +++ b/api/src/models/_raw_email_headers_raw.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RawEmailHeadersRaw { + #[serde(rename = "raw")] + pub raw: String, +} + +impl RawEmailHeadersRaw { + pub fn new(raw: String) -> RawEmailHeadersRaw { + RawEmailHeadersRaw { + raw, + } + } +} + diff --git a/api/src/models/_source_statistics.rs b/api/src/models/_source_statistics.rs new file mode 100644 index 00000000..43c40ef6 --- /dev/null +++ b/api/src/models/_source_statistics.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SourceStatistics { + /// Number of comments + #[serde(rename = "num_comments")] + pub num_comments: i32, +} + +impl SourceStatistics { + pub fn new(num_comments: i32) -> SourceStatistics { + SourceStatistics { + num_comments, + } + } +} + diff --git a/api/src/models/_thread_histogram_binning_custom_container.rs b/api/src/models/_thread_histogram_binning_custom_container.rs new file mode 100644 index 00000000..03fee738 --- /dev/null +++ b/api/src/models/_thread_histogram_binning_custom_container.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningCustomContainer { + #[serde(rename = "custom")] + pub custom: Box, +} + +impl ThreadHistogramBinningCustomContainer { + pub fn new(custom: models::ThreadHistogramBinningCustom) -> ThreadHistogramBinningCustomContainer { + ThreadHistogramBinningCustomContainer { + custom: Box::new(custom), + } + } +} + diff --git a/api/src/models/_thread_histogram_binning_fixed_container.rs b/api/src/models/_thread_histogram_binning_fixed_container.rs new file mode 100644 index 00000000..92fb2c66 --- /dev/null +++ b/api/src/models/_thread_histogram_binning_fixed_container.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningFixedContainer { + #[serde(rename = "fixed")] + pub fixed: Box, +} + +impl ThreadHistogramBinningFixedContainer { + pub fn new(fixed: models::ThreadHistogramBinningFixed) -> ThreadHistogramBinningFixedContainer { + ThreadHistogramBinningFixedContainer { + fixed: Box::new(fixed), + } + } +} + diff --git a/api/src/models/_thread_histogram_binning_variable_container.rs b/api/src/models/_thread_histogram_binning_variable_container.rs new file mode 100644 index 00000000..4d859cba --- /dev/null +++ b/api/src/models/_thread_histogram_binning_variable_container.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningVariableContainer { + #[serde(rename = "variable")] + pub variable: Box, +} + +impl ThreadHistogramBinningVariableContainer { + pub fn new(variable: models::ThreadHistogramBinningVariable) -> ThreadHistogramBinningVariableContainer { + ThreadHistogramBinningVariableContainer { + variable: Box::new(variable), + } + } +} + diff --git a/api/src/models/access.rs b/api/src/models/access.rs new file mode 100644 index 00000000..bd61eb8d --- /dev/null +++ b/api/src/models/access.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Access { + #[serde(rename = "kind")] + pub kind: models::AppAccessModelKind, + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "password", skip_serializing_if = "Option::is_none")] + pub password: Option, +} + +impl Access { + pub fn new(kind: models::AppAccessModelKind, username: String) -> Access { + Access { + kind, + username, + password: None, + } + } +} + diff --git a/api/src/models/add_comments_request.rs b/api/src/models/add_comments_request.rs new file mode 100644 index 00000000..58bda368 --- /dev/null +++ b/api/src/models/add_comments_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddCommentsRequest { + #[serde(rename = "comments")] + pub comments: Vec, +} + +impl AddCommentsRequest { + pub fn new(comments: Vec) -> AddCommentsRequest { + AddCommentsRequest { + comments, + } + } +} + diff --git a/api/src/models/add_comments_response.rs b/api/src/models/add_comments_response.rs new file mode 100644 index 00000000..63f22f12 --- /dev/null +++ b/api/src/models/add_comments_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddCommentsResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl AddCommentsResponse { + pub fn new(status: Status) -> AddCommentsResponse { + AddCommentsResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/add_emails_to_bucket_request.rs b/api/src/models/add_emails_to_bucket_request.rs new file mode 100644 index 00000000..db0be7e8 --- /dev/null +++ b/api/src/models/add_emails_to_bucket_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddEmailsToBucketRequest { + #[serde(rename = "emails")] + pub emails: Vec, +} + +impl AddEmailsToBucketRequest { + pub fn new(emails: Vec) -> AddEmailsToBucketRequest { + AddEmailsToBucketRequest { + emails, + } + } +} + diff --git a/api/src/models/add_emails_to_bucket_response.rs b/api/src/models/add_emails_to_bucket_response.rs new file mode 100644 index 00000000..24eb9d78 --- /dev/null +++ b/api/src/models/add_emails_to_bucket_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddEmailsToBucketResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl AddEmailsToBucketResponse { + pub fn new(status: Status) -> AddEmailsToBucketResponse { + AddEmailsToBucketResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/add_support_tenant_request.rs b/api/src/models/add_support_tenant_request.rs new file mode 100644 index 00000000..f46f529a --- /dev/null +++ b/api/src/models/add_support_tenant_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddSupportTenantRequest { + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "user_tenant")] + pub user_tenant: String, +} + +impl AddSupportTenantRequest { + pub fn new(email: String, user_tenant: String) -> AddSupportTenantRequest { + AddSupportTenantRequest { + email, + user_tenant, + } + } +} + diff --git a/api/src/models/add_support_tenant_response.rs b/api/src/models/add_support_tenant_response.rs new file mode 100644 index 00000000..b1b8b60a --- /dev/null +++ b/api/src/models/add_support_tenant_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AddSupportTenantResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl AddSupportTenantResponse { + pub fn new(status: Status) -> AddSupportTenantResponse { + AddSupportTenantResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/advance_stream_request.rs b/api/src/models/advance_stream_request.rs new file mode 100644 index 00000000..dab617ff --- /dev/null +++ b/api/src/models/advance_stream_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AdvanceStreamRequest { + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl AdvanceStreamRequest { + pub fn new(sequence_id: String) -> AdvanceStreamRequest { + AdvanceStreamRequest { + sequence_id, + } + } +} + diff --git a/api/src/models/advance_stream_response.rs b/api/src/models/advance_stream_response.rs new file mode 100644 index 00000000..b644de3a --- /dev/null +++ b/api/src/models/advance_stream_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AdvanceStreamResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl AdvanceStreamResponse { + pub fn new(status: Status, sequence_id: String) -> AdvanceStreamResponse { + AdvanceStreamResponse { + status, + sequence_id, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/advance_trigger_request.rs b/api/src/models/advance_trigger_request.rs new file mode 100644 index 00000000..cd821477 --- /dev/null +++ b/api/src/models/advance_trigger_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AdvanceTriggerRequest { + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl AdvanceTriggerRequest { + pub fn new(sequence_id: String) -> AdvanceTriggerRequest { + AdvanceTriggerRequest { + sequence_id, + } + } +} + diff --git a/api/src/models/advance_trigger_response.rs b/api/src/models/advance_trigger_response.rs new file mode 100644 index 00000000..e4c7ddce --- /dev/null +++ b/api/src/models/advance_trigger_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AdvanceTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl AdvanceTriggerResponse { + pub fn new(status: Status, sequence_id: String) -> AdvanceTriggerResponse { + AdvanceTriggerResponse { + status, + sequence_id, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/alert.rs b/api/src/models/alert.rs new file mode 100644 index 00000000..b8d1874a --- /dev/null +++ b/api/src/models/alert.rs @@ -0,0 +1,68 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Alert { + /// Unique ID of the alert + #[serde(rename = "id")] + pub id: String, + /// The API name of the alert + #[serde(rename = "name")] + pub name: String, + /// The project which owns the alert + #[serde(rename = "owner")] + pub owner: String, + /// Timestamp when the alert was created + #[serde(rename = "created_at")] + pub created_at: String, + /// Timestamp when the alert was updated + #[serde(rename = "updated_at")] + pub updated_at: String, + /// The latest revision of the alert + #[serde(rename = "revision")] + pub revision: i32, + /// A short title for the alert + #[serde(rename = "title")] + pub title: String, + /// A longer description of the alert + #[serde(rename = "description")] + pub description: String, + /// The datasets associated with this alert + #[serde(rename = "dataset_ids")] + pub dataset_ids: Vec, + /// The users subscribed to receive this alert + #[serde(rename = "subscribed_user_ids")] + pub subscribed_user_ids: Vec, + /// Alert Configuration + #[serde(rename = "config")] + pub config: Box, +} + +impl Alert { + pub fn new(id: String, name: String, owner: String, created_at: String, updated_at: String, revision: i32, title: String, description: String, dataset_ids: Vec, subscribed_user_ids: Vec, config: models::AlertConfig) -> Alert { + Alert { + id, + name, + owner, + created_at, + updated_at, + revision, + title, + description, + dataset_ids, + subscribed_user_ids, + config: Box::new(config), + } + } +} + diff --git a/api/src/models/alert_config.rs b/api/src/models/alert_config.rs new file mode 100644 index 00000000..4f51231d --- /dev/null +++ b/api/src/models/alert_config.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertConfig { + #[serde(rename = "kind")] + pub kind: models::AlertConfigKind, + #[serde(rename = "filter")] + pub filter: Box, + #[serde(rename = "metric")] + pub metric: models::AlertMetric, + #[serde(rename = "period")] + pub period: Box, + #[serde(rename = "process")] + pub process: Box, +} + +impl AlertConfig { + pub fn new(kind: models::AlertConfigKind, filter: models::AlertFilter, metric: models::AlertMetric, period: models::Period, process: models::Process) -> AlertConfig { + AlertConfig { + kind, + filter: Box::new(filter), + metric, + period: Box::new(period), + process: Box::new(process), + } + } +} + diff --git a/api/src/models/alert_config_kind.rs b/api/src/models/alert_config_kind.rs new file mode 100644 index 00000000..3d74010c --- /dev/null +++ b/api/src/models/alert_config_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AlertConfigKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AlertConfigKind { + #[serde(rename = "condition")] + Condition, + +} + +impl std::fmt::Display for AlertConfigKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Condition => write!(f, "condition"), + } + } +} + +impl Default for AlertConfigKind { + fn default() -> AlertConfigKind { + Self::Condition + } +} + diff --git a/api/src/models/alert_filter.rs b/api/src/models/alert_filter.rs new file mode 100644 index 00000000..11426102 --- /dev/null +++ b/api/src/models/alert_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertFilter { + #[serde(rename = "comment_filter")] + pub comment_filter: models::CommentFilter, + #[serde(rename = "attribute_filters")] + pub attribute_filters: Vec, +} + +impl AlertFilter { + pub fn new(comment_filter: models::CommentFilter, attribute_filters: Vec) -> AlertFilter { + AlertFilter { + comment_filter, + attribute_filters, + } + } +} + diff --git a/api/src/models/alert_issues_response.rs b/api/src/models/alert_issues_response.rs new file mode 100644 index 00000000..c476a2d0 --- /dev/null +++ b/api/src/models/alert_issues_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertIssuesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "issues")] + pub issues: Vec, + #[serde(rename = "alerts")] + pub alerts: Vec, +} + +impl AlertIssuesResponse { + pub fn new(status: Status, issues: Vec, alerts: Vec) -> AlertIssuesResponse { + AlertIssuesResponse { + status, + issues, + alerts, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/alert_metric.rs b/api/src/models/alert_metric.rs new file mode 100644 index 00000000..93ac35e6 --- /dev/null +++ b/api/src/models/alert_metric.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AlertMetric : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AlertMetric { + #[serde(rename = "volume")] + Volume, + #[serde(rename = "quality_of_service")] + QualityOfService, + +} + +impl std::fmt::Display for AlertMetric { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Volume => write!(f, "volume"), + Self::QualityOfService => write!(f, "quality_of_service"), + } + } +} + +impl Default for AlertMetric { + fn default() -> AlertMetric { + Self::Volume + } +} + diff --git a/api/src/models/alert_new.rs b/api/src/models/alert_new.rs new file mode 100644 index 00000000..d63fe225 --- /dev/null +++ b/api/src/models/alert_new.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertNew { + /// A short title for the alert + #[serde(rename = "title")] + pub title: String, + /// A longer description of the alert + #[serde(rename = "description")] + pub description: String, + /// The datasets associated with this alert + #[serde(rename = "dataset_ids")] + pub dataset_ids: Vec, + /// The users subscribed to receive this alert + #[serde(rename = "subscribed_user_ids", skip_serializing_if = "Option::is_none")] + pub subscribed_user_ids: Option>, + /// The configuration for this alert + #[serde(rename = "config")] + pub config: Box, +} + +impl AlertNew { + pub fn new(title: String, description: String, dataset_ids: Vec, config: models::AlertConfig) -> AlertNew { + AlertNew { + title, + description, + dataset_ids, + subscribed_user_ids: None, + config: Box::new(config), + } + } +} + diff --git a/api/src/models/alert_process_threshold.rs b/api/src/models/alert_process_threshold.rs new file mode 100644 index 00000000..307700c1 --- /dev/null +++ b/api/src/models/alert_process_threshold.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertProcessThreshold { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "value")] + pub value: f64, + #[serde(rename = "direction")] + pub direction: models::Direction, +} + +impl AlertProcessThreshold { + pub fn new(kind: Kind, value: f64, direction: models::Direction) -> AlertProcessThreshold { + AlertProcessThreshold { + kind, + value, + direction, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "threshold")] + Threshold, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Threshold + } +} + diff --git a/api/src/models/alert_process_variation.rs b/api/src/models/alert_process_variation.rs new file mode 100644 index 00000000..85d11833 --- /dev/null +++ b/api/src/models/alert_process_variation.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertProcessVariation { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "value")] + pub value: f64, + #[serde(rename = "variation_kind")] + pub variation_kind: models::VariationKind, + #[serde(rename = "compared_to")] + pub compared_to: models::TimePeriodComparison, +} + +impl AlertProcessVariation { + pub fn new(kind: Kind, value: f64, variation_kind: models::VariationKind, compared_to: models::TimePeriodComparison) -> AlertProcessVariation { + AlertProcessVariation { + kind, + value, + variation_kind, + compared_to, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "variation")] + Variation, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Variation + } +} + diff --git a/api/src/models/alert_subscription.rs b/api/src/models/alert_subscription.rs new file mode 100644 index 00000000..f2a7b462 --- /dev/null +++ b/api/src/models/alert_subscription.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertSubscription { + /// Unique ID of the alert + #[serde(rename = "id")] + pub id: String, + /// The API name of the alert + #[serde(rename = "name")] + pub name: String, + /// The project which owns the alert + #[serde(rename = "owner")] + pub owner: String, +} + +impl AlertSubscription { + pub fn new(id: String, name: String, owner: String) -> AlertSubscription { + AlertSubscription { + id, + name, + owner, + } + } +} + diff --git a/api/src/models/alert_update.rs b/api/src/models/alert_update.rs new file mode 100644 index 00000000..40388859 --- /dev/null +++ b/api/src/models/alert_update.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AlertUpdate { + /// The latest revision of the alert + #[serde(rename = "revision")] + pub revision: i32, + /// A short title for the alert + #[serde(rename = "title")] + pub title: String, + /// A longer description of the alert + #[serde(rename = "description")] + pub description: String, + /// The datasets associated with this alert + #[serde(rename = "dataset_ids")] + pub dataset_ids: Vec, + /// The users subscribed to receive this alert + #[serde(rename = "subscribed_user_ids", skip_serializing_if = "Option::is_none")] + pub subscribed_user_ids: Option>, + #[serde(rename = "config")] + pub config: Box, +} + +impl AlertUpdate { + pub fn new(revision: i32, title: String, description: String, dataset_ids: Vec, config: models::AlertConfig) -> AlertUpdate { + AlertUpdate { + revision, + title, + description, + dataset_ids, + subscribed_user_ids: None, + config: Box::new(config), + } + } +} + diff --git a/api/src/models/amount_field_data_private.rs b/api/src/models/amount_field_data_private.rs new file mode 100644 index 00000000..caa9d197 --- /dev/null +++ b/api/src/models/amount_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AmountFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl AmountFieldDataPrivate { + pub fn new(kind: Kind) -> AmountFieldDataPrivate { + AmountFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "amount")] + Amount, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Amount + } +} + diff --git a/api/src/models/annotated_comment.rs b/api/src/models/annotated_comment.rs new file mode 100644 index 00000000..88655740 --- /dev/null +++ b/api/src/models/annotated_comment.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AnnotatedComment { + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "labelling")] + pub labelling: Vec, + #[serde(rename = "reviewable_blocks", skip_serializing_if = "Option::is_none")] + pub reviewable_blocks: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + #[serde(rename = "thread_properties", skip_serializing_if = "Option::is_none")] + pub thread_properties: Option>, + #[serde(rename = "trigger_exceptions", skip_serializing_if = "Option::is_none")] + pub trigger_exceptions: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>, + #[serde(rename = "moon_forms", skip_serializing_if = "Option::is_none")] + pub moon_forms: Option>, + #[serde(rename = "extractions", skip_serializing_if = "Option::is_none")] + pub extractions: Option>, + #[serde(rename = "highlights", skip_serializing_if = "Option::is_none")] + pub highlights: Option>, + #[serde(rename = "diagnostics", skip_serializing_if = "Option::is_none")] + pub diagnostics: Option>, + #[serde(rename = "model_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model_version: Option>, +} + +impl AnnotatedComment { + pub fn new(comment: models::Comment, labelling: Vec) -> AnnotatedComment { + AnnotatedComment { + comment: Box::new(comment), + labelling, + reviewable_blocks: None, + entities: None, + thread_properties: None, + trigger_exceptions: None, + label_properties: None, + moon_forms: None, + extractions: None, + highlights: None, + diagnostics: None, + model_version: None, + } + } +} + diff --git a/api/src/models/annotation.rs b/api/src/models/annotation.rs new file mode 100644 index 00000000..74205a93 --- /dev/null +++ b/api/src/models/annotation.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Annotation { + #[serde(rename = "comment_uid")] + pub comment_uid: Vec, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, +} + +impl Annotation { + pub fn new(comment_uid: Vec) -> Annotation { + Annotation { + comment_uid, + labels: None, + } + } +} + diff --git a/api/src/models/annotation_label.rs b/api/src/models/annotation_label.rs new file mode 100644 index 00000000..f5ac817d --- /dev/null +++ b/api/src/models/annotation_label.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AnnotationLabel { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "external_id", skip_serializing_if = "Option::is_none")] + pub external_id: Option, +} + +impl AnnotationLabel { + pub fn new(name: String) -> AnnotationLabel { + AnnotationLabel { + name, + external_id: None, + } + } +} + diff --git a/api/src/models/annotation_metadata.rs b/api/src/models/annotation_metadata.rs new file mode 100644 index 00000000..3ae195e6 --- /dev/null +++ b/api/src/models/annotation_metadata.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AnnotationMetadata { + #[serde(rename = "user_id")] + pub user_id: String, + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "ui", skip_serializing_if = "Option::is_none")] + pub ui: Option>, +} + +impl AnnotationMetadata { + pub fn new(user_id: String, timestamp: String) -> AnnotationMetadata { + AnnotationMetadata { + user_id, + timestamp, + ui: None, + } + } +} + diff --git a/api/src/models/annotation_metadata_count.rs b/api/src/models/annotation_metadata_count.rs new file mode 100644 index 00000000..e4eaffd7 --- /dev/null +++ b/api/src/models/annotation_metadata_count.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AnnotationMetadataCount { + #[serde(rename = "unknown", skip_serializing_if = "Option::is_none")] + pub unknown: Option, + #[serde(rename = "other", skip_serializing_if = "Option::is_none")] + pub other: Option, + #[serde(rename = "retrieved_by_text_search", skip_serializing_if = "Option::is_none")] + pub retrieved_by_text_search: Option, + #[serde(rename = "shuffle_label_unfiltered", skip_serializing_if = "Option::is_none")] + pub shuffle_label_unfiltered: Option, + #[serde(rename = "clusters_unfiltered", skip_serializing_if = "Option::is_none")] + pub clusters_unfiltered: Option, + #[serde(rename = "low_confidence", skip_serializing_if = "Option::is_none")] + pub low_confidence: Option, + #[serde(rename = "teach_label_reviewed", skip_serializing_if = "Option::is_none")] + pub teach_label_reviewed: Option, + #[serde(rename = "teach_label_unreviewed", skip_serializing_if = "Option::is_none")] + pub teach_label_unreviewed: Option, +} + +impl AnnotationMetadataCount { + pub fn new() -> AnnotationMetadataCount { + AnnotationMetadataCount { + unknown: None, + other: None, + retrieved_by_text_search: None, + shuffle_label_unfiltered: None, + clusters_unfiltered: None, + low_confidence: None, + teach_label_reviewed: None, + teach_label_unreviewed: None, + } + } +} + diff --git a/api/src/models/annotations.rs b/api/src/models/annotations.rs new file mode 100644 index 00000000..c0ff101e --- /dev/null +++ b/api/src/models/annotations.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Annotations { + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, +} + +impl Annotations { + pub fn new() -> Annotations { + Annotations { + labels: None, + } + } +} + diff --git a/api/src/models/app_access_model.rs b/api/src/models/app_access_model.rs new file mode 100644 index 00000000..64715479 --- /dev/null +++ b/api/src/models/app_access_model.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AppAccessModel { + #[serde(rename = "kind")] + pub kind: models::AppAccessModelKind, +} + +impl AppAccessModel { + pub fn new(kind: models::AppAccessModelKind) -> AppAccessModel { + AppAccessModel { + kind, + } + } +} + diff --git a/api/src/models/app_access_model_kind.rs b/api/src/models/app_access_model_kind.rs new file mode 100644 index 00000000..ba7df3ac --- /dev/null +++ b/api/src/models/app_access_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AppAccessModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AppAccessModelKind { + #[serde(rename = "app_access")] + AppAccess, + +} + +impl std::fmt::Display for AppAccessModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::AppAccess => write!(f, "app_access"), + } + } +} + +impl Default for AppAccessModelKind { + fn default() -> AppAccessModelKind { + Self::AppAccess + } +} + diff --git a/api/src/models/application.rs b/api/src/models/application.rs new file mode 100644 index 00000000..b88d64bb --- /dev/null +++ b/api/src/models/application.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Application { + #[serde(rename = "kind")] + pub kind: models::NtlmApplicationModelKind, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "client_id")] + pub client_id: String, + #[serde(rename = "client_secret", skip_serializing_if = "Option::is_none")] + pub client_secret: Option, + #[serde(rename = "thumbprint")] + pub thumbprint: String, + #[serde(rename = "private_key", skip_serializing_if = "Option::is_none")] + pub private_key: Option, +} + +impl Application { + pub fn new(kind: models::NtlmApplicationModelKind, tenant_id: String, client_id: String, thumbprint: String) -> Application { + Application { + kind, + tenant_id, + client_id, + client_secret: None, + thumbprint, + private_key: None, + } + } +} + diff --git a/api/src/models/assigned_predicted_present_filter.rs b/api/src/models/assigned_predicted_present_filter.rs new file mode 100644 index 00000000..3f5b7f4f --- /dev/null +++ b/api/src/models/assigned_predicted_present_filter.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AssignedPredictedPresentFilter { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "any_assigned")] + pub any_assigned: Vec, + #[serde(rename = "any_predicted")] + pub any_predicted: Vec, + #[serde(rename = "none_present")] + pub none_present: Vec, +} + +impl AssignedPredictedPresentFilter { + pub fn new(kind: Kind, any_assigned: Vec, any_predicted: Vec, none_present: Vec) -> AssignedPredictedPresentFilter { + AssignedPredictedPresentFilter { + kind, + any_assigned, + any_predicted, + none_present, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "assigned_predicted_present")] + AssignedPredictedPresent, +} + +impl Default for Kind { + fn default() -> Kind { + Self::AssignedPredictedPresent + } +} + diff --git a/api/src/models/assignment_method.rs b/api/src/models/assignment_method.rs new file mode 100644 index 00000000..f90b42d9 --- /dev/null +++ b/api/src/models/assignment_method.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AssignmentMethod : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AssignmentMethod { + #[serde(rename = "bulk")] + Bulk, + #[serde(rename = "suggested")] + Suggested, + #[serde(rename = "predicted")] + Predicted, + #[serde(rename = "manual")] + Manual, + #[serde(rename = "assigned")] + Assigned, + +} + +impl std::fmt::Display for AssignmentMethod { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Bulk => write!(f, "bulk"), + Self::Suggested => write!(f, "suggested"), + Self::Predicted => write!(f, "predicted"), + Self::Manual => write!(f, "manual"), + Self::Assigned => write!(f, "assigned"), + } + } +} + +impl Default for AssignmentMethod { + fn default() -> AssignmentMethod { + Self::Bulk + } +} + diff --git a/api/src/models/attachment.rs b/api/src/models/attachment.rs new file mode 100644 index 00000000..a716387b --- /dev/null +++ b/api/src/models/attachment.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Attachment { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "size")] + pub size: i32, + #[serde(rename = "content_type")] + pub content_type: String, + #[serde(rename = "content_hash", skip_serializing_if = "Option::is_none")] + pub content_hash: Option, + #[serde(rename = "inline", skip_serializing_if = "Option::is_none")] + pub inline: Option, + #[serde(rename = "attachment_reference", skip_serializing_if = "Option::is_none")] + pub attachment_reference: Option, +} + +impl Attachment { + pub fn new(name: String, size: i32, content_type: String) -> Attachment { + Attachment { + name, + size, + content_type, + content_hash: None, + inline: None, + attachment_reference: None, + } + } +} + diff --git a/api/src/models/attribute.rs b/api/src/models/attribute.rs new file mode 100644 index 00000000..0f4d335a --- /dev/null +++ b/api/src/models/attribute.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Attribute { +} + +impl Attribute { + pub fn new() -> Attribute { + Attribute { + } + } +} + diff --git a/api/src/models/attribute_filter.rs b/api/src/models/attribute_filter.rs new file mode 100644 index 00000000..906af211 --- /dev/null +++ b/api/src/models/attribute_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AttributeFilter { + #[serde(rename = "attribute")] + pub attribute: Box, + #[serde(rename = "filter")] + pub filter: Box, +} + +impl AttributeFilter { + pub fn new(attribute: models::Attribute, filter: models::Filter) -> AttributeFilter { + AttributeFilter { + attribute: Box::new(attribute), + filter: Box::new(filter), + } + } +} + diff --git a/api/src/models/attribute_filter_attribute.rs b/api/src/models/attribute_filter_attribute.rs new file mode 100644 index 00000000..64a7a2ca --- /dev/null +++ b/api/src/models/attribute_filter_attribute.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AttributeFilterAttribute : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AttributeFilterAttribute { + #[serde(rename = "labels")] + Labels, + #[serde(rename = "entities")] + Entities, + #[serde(rename = "attachment_property_num_attachments")] + AttachmentPropertyNumAttachments, + #[serde(rename = "attachment_property_num_attachments_with_contents")] + AttachmentPropertyNumAttachmentsWithContents, + #[serde(rename = "attachment_property_num_attachments_without_contents")] + AttachmentPropertyNumAttachmentsWithoutContents, + #[serde(rename = "attachment_property_types")] + AttachmentPropertyTypes, + #[serde(rename = "attachment_property_names")] + AttachmentPropertyNames, + #[serde(rename = "attachment_property_extensions")] + AttachmentPropertyExtensions, + #[serde(rename = "attachment_property_size")] + AttachmentPropertySize, + #[serde(rename = "attachment_property_total_size")] + AttachmentPropertyTotalSize, + +} + +impl std::fmt::Display for AttributeFilterAttribute { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Labels => write!(f, "labels"), + Self::Entities => write!(f, "entities"), + Self::AttachmentPropertyNumAttachments => write!(f, "attachment_property_num_attachments"), + Self::AttachmentPropertyNumAttachmentsWithContents => write!(f, "attachment_property_num_attachments_with_contents"), + Self::AttachmentPropertyNumAttachmentsWithoutContents => write!(f, "attachment_property_num_attachments_without_contents"), + Self::AttachmentPropertyTypes => write!(f, "attachment_property_types"), + Self::AttachmentPropertyNames => write!(f, "attachment_property_names"), + Self::AttachmentPropertyExtensions => write!(f, "attachment_property_extensions"), + Self::AttachmentPropertySize => write!(f, "attachment_property_size"), + Self::AttachmentPropertyTotalSize => write!(f, "attachment_property_total_size"), + } + } +} + +impl Default for AttributeFilterAttribute { + fn default() -> AttributeFilterAttribute { + Self::Labels + } +} + diff --git a/api/src/models/attribution_method.rs b/api/src/models/attribution_method.rs new file mode 100644 index 00000000..a6a07314 --- /dev/null +++ b/api/src/models/attribution_method.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// AttributionMethod : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum AttributionMethod { + #[serde(rename = "table_heuristic")] + TableHeuristic, + #[serde(rename = "word_ids")] + WordIds, + +} + +impl std::fmt::Display for AttributionMethod { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::TableHeuristic => write!(f, "table_heuristic"), + Self::WordIds => write!(f, "word_ids"), + } + } +} + +impl Default for AttributionMethod { + fn default() -> AttributionMethod { + Self::TableHeuristic + } +} + diff --git a/api/src/models/audit_event.rs b/api/src/models/audit_event.rs new file mode 100644 index 00000000..10b87ba7 --- /dev/null +++ b/api/src/models/audit_event.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct AuditEvent { + #[serde(rename = "event_id")] + pub event_id: String, + #[serde(rename = "event_type")] + pub event_type: String, + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "actor_user_id")] + pub actor_user_id: String, + #[serde(rename = "actor_tenant_id")] + pub actor_tenant_id: String, + #[serde(rename = "tenant_ids")] + pub tenant_ids: Vec, + #[serde(rename = "user_ids", skip_serializing_if = "Option::is_none")] + pub user_ids: Option>, + #[serde(rename = "source_ids", skip_serializing_if = "Option::is_none")] + pub source_ids: Option>, + #[serde(rename = "dataset_ids", skip_serializing_if = "Option::is_none")] + pub dataset_ids: Option>, + #[serde(rename = "trigger_ids", skip_serializing_if = "Option::is_none")] + pub trigger_ids: Option>, + #[serde(rename = "project_ids", skip_serializing_if = "Option::is_none")] + pub project_ids: Option>, +} + +impl AuditEvent { + pub fn new(event_id: String, event_type: String, timestamp: String, actor_user_id: String, actor_tenant_id: String, tenant_ids: Vec) -> AuditEvent { + AuditEvent { + event_id, + event_type, + timestamp, + actor_user_id, + actor_tenant_id, + tenant_ids, + user_ids: None, + source_ids: None, + dataset_ids: None, + trigger_ids: None, + project_ids: None, + } + } +} + diff --git a/api/src/models/binary_label_health_action.rs b/api/src/models/binary_label_health_action.rs new file mode 100644 index 00000000..39670d5c --- /dev/null +++ b/api/src/models/binary_label_health_action.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BinaryLabelHealthAction { + #[serde(rename = "kind")] + pub kind: models::BinaryLabelHealthActionKind, + #[serde(rename = "label")] + pub label: String, +} + +impl BinaryLabelHealthAction { + pub fn new(kind: models::BinaryLabelHealthActionKind, label: String) -> BinaryLabelHealthAction { + BinaryLabelHealthAction { + kind, + label, + } + } +} + diff --git a/api/src/models/binary_label_health_action_kind.rs b/api/src/models/binary_label_health_action_kind.rs new file mode 100644 index 00000000..513e4b71 --- /dev/null +++ b/api/src/models/binary_label_health_action_kind.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BinaryLabelHealthActionKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BinaryLabelHealthActionKind { + #[serde(rename = "merge")] + Merge, + #[serde(rename = "deconfuse")] + Deconfuse, + +} + +impl std::fmt::Display for BinaryLabelHealthActionKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Merge => write!(f, "merge"), + Self::Deconfuse => write!(f, "deconfuse"), + } + } +} + +impl Default for BinaryLabelHealthActionKind { + fn default() -> BinaryLabelHealthActionKind { + Self::Merge + } +} + diff --git a/api/src/models/binary_label_health_warning.rs b/api/src/models/binary_label_health_warning.rs new file mode 100644 index 00000000..87b15d66 --- /dev/null +++ b/api/src/models/binary_label_health_warning.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BinaryLabelHealthWarning { + #[serde(rename = "kind")] + pub kind: models::BinaryLabelHealthWarningKind, + #[serde(rename = "label")] + pub label: String, +} + +impl BinaryLabelHealthWarning { + pub fn new(kind: models::BinaryLabelHealthWarningKind, label: String) -> BinaryLabelHealthWarning { + BinaryLabelHealthWarning { + kind, + label, + } + } +} + diff --git a/api/src/models/binary_label_health_warning_kind.rs b/api/src/models/binary_label_health_warning_kind.rs new file mode 100644 index 00000000..1ea5c9c6 --- /dev/null +++ b/api/src/models/binary_label_health_warning_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BinaryLabelHealthWarningKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BinaryLabelHealthWarningKind { + #[serde(rename = "confused")] + Confused, + +} + +impl std::fmt::Display for BinaryLabelHealthWarningKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Confused => write!(f, "confused"), + } + } +} + +impl Default for BinaryLabelHealthWarningKind { + fn default() -> BinaryLabelHealthWarningKind { + Self::Confused + } +} + diff --git a/api/src/models/binning.rs b/api/src/models/binning.rs new file mode 100644 index 00000000..af71a54e --- /dev/null +++ b/api/src/models/binning.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Binning { + #[serde(rename = "fixed")] + pub fixed: Box, + #[serde(rename = "custom")] + pub custom: Box, + #[serde(rename = "variable")] + pub variable: Box, +} + +impl Binning { + pub fn new(fixed: models::ThreadHistogramBinningFixed, custom: models::ThreadHistogramBinningCustom, variable: models::ThreadHistogramBinningVariable) -> Binning { + Binning { + fixed: Box::new(fixed), + custom: Box::new(custom), + variable: Box::new(variable), + } + } +} + diff --git a/api/src/models/bool_field_data_private.rs b/api/src/models/bool_field_data_private.rs new file mode 100644 index 00000000..45c91bae --- /dev/null +++ b/api/src/models/bool_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BoolFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl BoolFieldDataPrivate { + pub fn new(kind: Kind) -> BoolFieldDataPrivate { + BoolFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "boolean")] + Boolean, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Boolean + } +} + diff --git a/api/src/models/bool_field_data_type.rs b/api/src/models/bool_field_data_type.rs new file mode 100644 index 00000000..4ec56bf3 --- /dev/null +++ b/api/src/models/bool_field_data_type.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BoolFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "true_formatted", deserialize_with = "Option::deserialize")] + pub true_formatted: Option, + #[serde(rename = "false_formatted", deserialize_with = "Option::deserialize")] + pub false_formatted: Option, +} + +impl BoolFieldDataType { + pub fn new(kind: Kind, true_formatted: Option, false_formatted: Option) -> BoolFieldDataType { + BoolFieldDataType { + kind, + true_formatted, + false_formatted, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "boolean")] + Boolean, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Boolean + } +} + diff --git a/api/src/models/breakdown.rs b/api/src/models/breakdown.rs new file mode 100644 index 00000000..f433cfa1 --- /dev/null +++ b/api/src/models/breakdown.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Breakdown { + #[serde(rename = "label_contributions")] + pub label_contributions: Vec, + #[serde(rename = "other_group_contributions")] + pub other_group_contributions: Vec, +} + +impl Breakdown { + pub fn new(label_contributions: Vec, other_group_contributions: Vec) -> Breakdown { + Breakdown { + label_contributions, + other_group_contributions, + } + } +} + diff --git a/api/src/models/bucket.rs b/api/src/models/bucket.rs new file mode 100644 index 00000000..4b76a1bb --- /dev/null +++ b/api/src/models/bucket.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Bucket { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "owner")] + pub owner: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "updated_at")] + pub updated_at: String, + #[serde(rename = "last_updated_by", skip_serializing_if = "Option::is_none")] + pub last_updated_by: Option>, +} + +impl Bucket { + pub fn new(id: String, owner: String, name: String, title: String, created_at: String, updated_at: String) -> Bucket { + Bucket { + id, + owner, + name, + title, + created_at, + updated_at, + last_updated_by: None, + } + } +} + diff --git a/api/src/models/bucket_new.rs b/api/src/models/bucket_new.rs new file mode 100644 index 00000000..40a351e3 --- /dev/null +++ b/api/src/models/bucket_new.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BucketNew { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "bucket_type", skip_serializing_if = "Option::is_none")] + pub bucket_type: Option, +} + +impl BucketNew { + pub fn new() -> BucketNew { + BucketNew { + title: None, + bucket_type: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BucketType { + #[serde(rename = "emails")] + Emails, +} + +impl Default for BucketType { + fn default() -> BucketType { + Self::Emails + } +} + diff --git a/api/src/models/bucket_sync_state.rs b/api/src/models/bucket_sync_state.rs new file mode 100644 index 00000000..1c8aa18d --- /dev/null +++ b/api/src/models/bucket_sync_state.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BucketSyncState { + #[serde(rename = "sync_state")] + pub sync_state: String, + #[serde(rename = "progress_timestamp", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub progress_timestamp: Option>, + #[serde(rename = "last_synced_at", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub last_synced_at: Option>, +} + +impl BucketSyncState { + pub fn new(sync_state: String) -> BucketSyncState { + BucketSyncState { + sync_state, + progress_timestamp: None, + last_synced_at: None, + } + } +} + diff --git a/api/src/models/bucket_update.rs b/api/src/models/bucket_update.rs new file mode 100644 index 00000000..19d1ee42 --- /dev/null +++ b/api/src/models/bucket_update.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BucketUpdate { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "last_updated_by", skip_serializing_if = "Option::is_none")] + pub last_updated_by: Option>, +} + +impl BucketUpdate { + pub fn new() -> BucketUpdate { + BucketUpdate { + title: None, + last_updated_by: None, + } + } +} + diff --git a/api/src/models/bucket_updated_by.rs b/api/src/models/bucket_updated_by.rs new file mode 100644 index 00000000..ca3fbdd8 --- /dev/null +++ b/api/src/models/bucket_updated_by.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BucketUpdatedBy { + #[serde(rename = "config_owner")] + pub config_owner: String, + #[serde(rename = "config_key")] + pub config_key: String, + #[serde(rename = "shard_index")] + pub shard_index: i32, + #[serde(rename = "num_shards")] + pub num_shards: i32, +} + +impl BucketUpdatedBy { + pub fn new(config_owner: String, config_key: String, shard_index: i32, num_shards: i32) -> BucketUpdatedBy { + BucketUpdatedBy { + config_owner, + config_key, + shard_index, + num_shards, + } + } +} + diff --git a/api/src/models/builtin_label_def.rs b/api/src/models/builtin_label_def.rs new file mode 100644 index 00000000..5bf58e8f --- /dev/null +++ b/api/src/models/builtin_label_def.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BuiltinLabelDef { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: models::BuiltinLabelDefName, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(rename = "properties", skip_serializing_if = "Option::is_none")] + pub properties: Option>, +} + +impl BuiltinLabelDef { + pub fn new(id: String, name: models::BuiltinLabelDefName) -> BuiltinLabelDef { + BuiltinLabelDef { + id, + name, + description: None, + properties: None, + } + } +} + diff --git a/api/src/models/builtin_label_def_name.rs b/api/src/models/builtin_label_def_name.rs new file mode 100644 index 00000000..a6dec4a3 --- /dev/null +++ b/api/src/models/builtin_label_def_name.rs @@ -0,0 +1,135 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BuiltinLabelDefName : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BuiltinLabelDefName { + #[serde(rename = "Autogenerated")] + Autogenerated, + #[serde(rename = "Chaser")] + Chaser, + #[serde(rename = "Escalation")] + Escalation, + #[serde(rename = "Out of Office")] + OutOfOffice, + #[serde(rename = "Urgent")] + Urgent, + #[serde(rename = "Clarification")] + Clarification, + #[serde(rename = "Dispute")] + Dispute, + #[serde(rename = "Information Check")] + InformationCheck, + #[serde(rename = "Exception")] + Exception, + #[serde(rename = "Failure")] + Failure, + #[serde(rename = "Thanks")] + Thanks, + #[serde(rename = "Above and Beyond")] + AboveAndBeyond, + #[serde(rename = "Autogenerated - NT")] + AutogeneratedNt, + #[serde(rename = "Chaser - NT")] + ChaserNt, + #[serde(rename = "Escalation - NT")] + EscalationNt, + #[serde(rename = "Out of Office - NT")] + OutOfOfficeNt, + #[serde(rename = "Urgent - NT")] + UrgentNt, + #[serde(rename = "Clarification - NT")] + ClarificationNt, + #[serde(rename = "Dispute - NT")] + DisputeNt, + #[serde(rename = "Information Check - NT")] + InformationCheckNt, + #[serde(rename = "Exception - NT")] + ExceptionNt, + #[serde(rename = "Failure - NT")] + FailureNt, + #[serde(rename = "Thanks - NT")] + ThanksNt, + #[serde(rename = "Above and Beyond - NT")] + AboveAndBeyondNt, + #[serde(rename = "Negative Tone")] + NegativeTone, + #[serde(rename = "Positive Tone")] + PositiveTone, + #[serde(rename = "Apologetic")] + Apologetic, + #[serde(rename = "Appreciative")] + Appreciative, + #[serde(rename = "Frustrated")] + Frustrated, + #[serde(rename = "Thankful")] + Thankful, + #[serde(rename = "Concerned")] + Concerned, + #[serde(rename = "Very Concerned")] + VeryConcerned, + #[serde(rename = "Very Frustrated")] + VeryFrustrated, + #[serde(rename = "Delighted")] + Delighted, + +} + +impl std::fmt::Display for BuiltinLabelDefName { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Autogenerated => write!(f, "Autogenerated"), + Self::Chaser => write!(f, "Chaser"), + Self::Escalation => write!(f, "Escalation"), + Self::OutOfOffice => write!(f, "Out of Office"), + Self::Urgent => write!(f, "Urgent"), + Self::Clarification => write!(f, "Clarification"), + Self::Dispute => write!(f, "Dispute"), + Self::InformationCheck => write!(f, "Information Check"), + Self::Exception => write!(f, "Exception"), + Self::Failure => write!(f, "Failure"), + Self::Thanks => write!(f, "Thanks"), + Self::AboveAndBeyond => write!(f, "Above and Beyond"), + Self::AutogeneratedNt => write!(f, "Autogenerated - NT"), + Self::ChaserNt => write!(f, "Chaser - NT"), + Self::EscalationNt => write!(f, "Escalation - NT"), + Self::OutOfOfficeNt => write!(f, "Out of Office - NT"), + Self::UrgentNt => write!(f, "Urgent - NT"), + Self::ClarificationNt => write!(f, "Clarification - NT"), + Self::DisputeNt => write!(f, "Dispute - NT"), + Self::InformationCheckNt => write!(f, "Information Check - NT"), + Self::ExceptionNt => write!(f, "Exception - NT"), + Self::FailureNt => write!(f, "Failure - NT"), + Self::ThanksNt => write!(f, "Thanks - NT"), + Self::AboveAndBeyondNt => write!(f, "Above and Beyond - NT"), + Self::NegativeTone => write!(f, "Negative Tone"), + Self::PositiveTone => write!(f, "Positive Tone"), + Self::Apologetic => write!(f, "Apologetic"), + Self::Appreciative => write!(f, "Appreciative"), + Self::Frustrated => write!(f, "Frustrated"), + Self::Thankful => write!(f, "Thankful"), + Self::Concerned => write!(f, "Concerned"), + Self::VeryConcerned => write!(f, "Very Concerned"), + Self::VeryFrustrated => write!(f, "Very Frustrated"), + Self::Delighted => write!(f, "Delighted"), + } + } +} + +impl Default for BuiltinLabelDefName { + fn default() -> BuiltinLabelDefName { + Self::Autogenerated + } +} + diff --git a/api/src/models/builtin_label_def_request.rs b/api/src/models/builtin_label_def_request.rs new file mode 100644 index 00000000..906187eb --- /dev/null +++ b/api/src/models/builtin_label_def_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BuiltinLabelDefRequest { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, +} + +impl BuiltinLabelDefRequest { + pub fn new(id: String) -> BuiltinLabelDefRequest { + BuiltinLabelDefRequest { + id, + name: None, + } + } +} + diff --git a/api/src/models/business_rule.rs b/api/src/models/business_rule.rs new file mode 100644 index 00000000..f001160b --- /dev/null +++ b/api/src/models/business_rule.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BusinessRule { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "type")] + pub r#type: models::BusinessRuleType, + #[serde(rename = "logical_operator")] + pub logical_operator: models::BusinessRuleLogicalOperator, + #[serde(rename = "expression")] + pub expression: String, + #[serde(rename = "comparison_operator")] + pub comparison_operator: models::BusinessRuleComparisonOperator, + #[serde(rename = "set_values")] + pub set_values: Vec, +} + +impl BusinessRule { + pub fn new(name: String, r#type: models::BusinessRuleType, logical_operator: models::BusinessRuleLogicalOperator, expression: String, comparison_operator: models::BusinessRuleComparisonOperator, set_values: Vec) -> BusinessRule { + BusinessRule { + name, + r#type, + logical_operator, + expression, + comparison_operator, + set_values, + } + } +} + diff --git a/api/src/models/business_rule_comparison_operator.rs b/api/src/models/business_rule_comparison_operator.rs new file mode 100644 index 00000000..fa30d0c6 --- /dev/null +++ b/api/src/models/business_rule_comparison_operator.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BusinessRuleComparisonOperator : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BusinessRuleComparisonOperator { + #[serde(rename = "Equals")] + Equals, + #[serde(rename = "NotEquals")] + NotEquals, + #[serde(rename = "Greater")] + Greater, + #[serde(rename = "GreaterOrEqual")] + GreaterOrEqual, + #[serde(rename = "Less")] + Less, + #[serde(rename = "LessOrEqual")] + LessOrEqual, + +} + +impl std::fmt::Display for BusinessRuleComparisonOperator { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Equals => write!(f, "Equals"), + Self::NotEquals => write!(f, "NotEquals"), + Self::Greater => write!(f, "Greater"), + Self::GreaterOrEqual => write!(f, "GreaterOrEqual"), + Self::Less => write!(f, "Less"), + Self::LessOrEqual => write!(f, "LessOrEqual"), + } + } +} + +impl Default for BusinessRuleComparisonOperator { + fn default() -> BusinessRuleComparisonOperator { + Self::Equals + } +} + diff --git a/api/src/models/business_rule_logical_operator.rs b/api/src/models/business_rule_logical_operator.rs new file mode 100644 index 00000000..587049a1 --- /dev/null +++ b/api/src/models/business_rule_logical_operator.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BusinessRuleLogicalOperator : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BusinessRuleLogicalOperator { + #[serde(rename = "AND")] + And, + #[serde(rename = "OR")] + Or, + +} + +impl std::fmt::Display for BusinessRuleLogicalOperator { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::And => write!(f, "AND"), + Self::Or => write!(f, "OR"), + } + } +} + +impl Default for BusinessRuleLogicalOperator { + fn default() -> BusinessRuleLogicalOperator { + Self::And + } +} + diff --git a/api/src/models/business_rule_set.rs b/api/src/models/business_rule_set.rs new file mode 100644 index 00000000..d7e2a603 --- /dev/null +++ b/api/src/models/business_rule_set.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct BusinessRuleSet { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "criticality")] + pub criticality: models::BusinessRuleSetCriticality, + #[serde(rename = "rules")] + pub rules: Vec, +} + +impl BusinessRuleSet { + pub fn new(name: String, criticality: models::BusinessRuleSetCriticality, rules: Vec) -> BusinessRuleSet { + BusinessRuleSet { + name, + criticality, + rules, + } + } +} + diff --git a/api/src/models/business_rule_set_criticality.rs b/api/src/models/business_rule_set_criticality.rs new file mode 100644 index 00000000..3d8f7ac2 --- /dev/null +++ b/api/src/models/business_rule_set_criticality.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BusinessRuleSetCriticality : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BusinessRuleSetCriticality { + #[serde(rename = "Must")] + Must, + #[serde(rename = "Should")] + Should, + +} + +impl std::fmt::Display for BusinessRuleSetCriticality { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Must => write!(f, "Must"), + Self::Should => write!(f, "Should"), + } + } +} + +impl Default for BusinessRuleSetCriticality { + fn default() -> BusinessRuleSetCriticality { + Self::Must + } +} + diff --git a/api/src/models/business_rule_type.rs b/api/src/models/business_rule_type.rs new file mode 100644 index 00000000..c3db545a --- /dev/null +++ b/api/src/models/business_rule_type.rs @@ -0,0 +1,63 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// BusinessRuleType : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum BusinessRuleType { + #[serde(rename = "Mandatory")] + Mandatory, + #[serde(rename = "IsEmpty")] + IsEmpty, + #[serde(rename = "PossibleValues")] + PossibleValues, + #[serde(rename = "Regex")] + Regex, + #[serde(rename = "StartsWith")] + StartsWith, + #[serde(rename = "EndsWith")] + EndsWith, + #[serde(rename = "Contains")] + Contains, + #[serde(rename = "FixedLength")] + FixedLength, + #[serde(rename = "IsEmail")] + IsEmail, + #[serde(rename = "Expression")] + Expression, + +} + +impl std::fmt::Display for BusinessRuleType { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Mandatory => write!(f, "Mandatory"), + Self::IsEmpty => write!(f, "IsEmpty"), + Self::PossibleValues => write!(f, "PossibleValues"), + Self::Regex => write!(f, "Regex"), + Self::StartsWith => write!(f, "StartsWith"), + Self::EndsWith => write!(f, "EndsWith"), + Self::Contains => write!(f, "Contains"), + Self::FixedLength => write!(f, "FixedLength"), + Self::IsEmail => write!(f, "IsEmail"), + Self::Expression => write!(f, "Expression"), + } + } +} + +impl Default for BusinessRuleType { + fn default() -> BusinessRuleType { + Self::Mandatory + } +} + diff --git a/api/src/models/by_labels.rs b/api/src/models/by_labels.rs new file mode 100644 index 00000000..023e85b2 --- /dev/null +++ b/api/src/models/by_labels.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ByLabels { + #[serde(rename = "include")] + pub include: Box, + #[serde(rename = "top")] + pub top: Box, +} + +impl ByLabels { + pub fn new(include: models::ByLabelsInclude, top: models::ByLabelsTop) -> ByLabels { + ByLabels { + include: Box::new(include), + top: Box::new(top), + } + } +} + diff --git a/api/src/models/by_labels_include.rs b/api/src/models/by_labels_include.rs new file mode 100644 index 00000000..4f8149f1 --- /dev/null +++ b/api/src/models/by_labels_include.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ByLabelsInclude { + #[serde(rename = "include_labels")] + pub include_labels: Vec, +} + +impl ByLabelsInclude { + pub fn new(include_labels: Vec) -> ByLabelsInclude { + ByLabelsInclude { + include_labels, + } + } +} + diff --git a/api/src/models/by_labels_top.rs b/api/src/models/by_labels_top.rs new file mode 100644 index 00000000..f0c28806 --- /dev/null +++ b/api/src/models/by_labels_top.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ByLabelsTop { + #[serde(rename = "num_top_labels")] + pub num_top_labels: i32, + #[serde(rename = "exclude_labels")] + pub exclude_labels: Vec, +} + +impl ByLabelsTop { + pub fn new(num_top_labels: i32, exclude_labels: Vec) -> ByLabelsTop { + ByLabelsTop { + num_top_labels, + exclude_labels, + } + } +} + diff --git a/api/src/models/capture_threshold.rs b/api/src/models/capture_threshold.rs new file mode 100644 index 00000000..d9ae523e --- /dev/null +++ b/api/src/models/capture_threshold.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CaptureThreshold { +} + +impl CaptureThreshold { + pub fn new() -> CaptureThreshold { + CaptureThreshold { + } + } +} + diff --git a/api/src/models/choice_field_data_private.rs b/api/src/models/choice_field_data_private.rs new file mode 100644 index 00000000..d70dcc69 --- /dev/null +++ b/api/src/models/choice_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ChoiceFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl ChoiceFieldDataPrivate { + pub fn new(kind: Kind) -> ChoiceFieldDataPrivate { + ChoiceFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "choice")] + Choice, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Choice + } +} + diff --git a/api/src/models/choice_field_data_type.rs b/api/src/models/choice_field_data_type.rs new file mode 100644 index 00000000..5c9f6c6e --- /dev/null +++ b/api/src/models/choice_field_data_type.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ChoiceFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl ChoiceFieldDataType { + pub fn new(kind: Kind) -> ChoiceFieldDataType { + ChoiceFieldDataType { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "choice")] + Choice, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Choice + } +} + diff --git a/api/src/models/client_secret_application_model.rs b/api/src/models/client_secret_application_model.rs new file mode 100644 index 00000000..11208a95 --- /dev/null +++ b/api/src/models/client_secret_application_model.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ClientSecretApplicationModel { + #[serde(rename = "kind")] + pub kind: models::ClientSecretApplicationModelKind, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "client_id")] + pub client_id: String, + #[serde(rename = "client_secret", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub client_secret: Option>, +} + +impl ClientSecretApplicationModel { + pub fn new(kind: models::ClientSecretApplicationModelKind, tenant_id: String, client_id: String) -> ClientSecretApplicationModel { + ClientSecretApplicationModel { + kind, + tenant_id, + client_id, + client_secret: None, + } + } +} + diff --git a/api/src/models/client_secret_application_model_kind.rs b/api/src/models/client_secret_application_model_kind.rs new file mode 100644 index 00000000..86878624 --- /dev/null +++ b/api/src/models/client_secret_application_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ClientSecretApplicationModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ClientSecretApplicationModelKind { + #[serde(rename = "custom")] + Custom, + +} + +impl std::fmt::Display for ClientSecretApplicationModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Custom => write!(f, "custom"), + } + } +} + +impl Default for ClientSecretApplicationModelKind { + fn default() -> ClientSecretApplicationModelKind { + Self::Custom + } +} + diff --git a/api/src/models/cm_model_config.rs b/api/src/models/cm_model_config.rs new file mode 100644 index 00000000..c5b6d562 --- /dev/null +++ b/api/src/models/cm_model_config.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CmModelConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl CmModelConfig { + pub fn new() -> CmModelConfig { + CmModelConfig { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "cm")] + Cm, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Cm + } +} + diff --git a/api/src/models/comment.rs b/api/src/models/comment.rs new file mode 100644 index 00000000..361460f5 --- /dev/null +++ b/api/src/models/comment.rs @@ -0,0 +1,68 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Comment { + #[serde(rename = "uid")] + pub uid: String, + /// ID of the comment unique within a source + #[serde(rename = "id")] + pub id: String, + /// User supplied comment timestamp + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "thread_id", skip_serializing_if = "Option::is_none")] + pub thread_id: Option, + #[serde(rename = "user_properties")] + pub user_properties: std::collections::HashMap, + #[serde(rename = "messages")] + pub messages: Vec, + #[serde(rename = "text_format", skip_serializing_if = "Option::is_none")] + pub text_format: Option, + #[serde(rename = "attachments")] + pub attachments: Vec, + /// ID of the source containing the comment + #[serde(rename = "source_id")] + pub source_id: String, + /// Timestamp of the last modification of the comment + #[serde(rename = "last_modified")] + pub last_modified: String, + /// Timestamp of the creation of the comment + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "context", skip_serializing_if = "Option::is_none")] + pub context: Option, + #[serde(rename = "has_annotations", skip_serializing_if = "Option::is_none")] + pub has_annotations: Option, +} + +impl Comment { + pub fn new(uid: String, id: String, timestamp: String, user_properties: std::collections::HashMap, messages: Vec, attachments: Vec, source_id: String, last_modified: String, created_at: String) -> Comment { + Comment { + uid, + id, + timestamp, + thread_id: None, + user_properties, + messages, + text_format: None, + attachments, + source_id, + last_modified, + created_at, + context: None, + has_annotations: None, + } + } +} + diff --git a/api/src/models/comment_extractions_predictions.rs b/api/src/models/comment_extractions_predictions.rs new file mode 100644 index 00000000..7b042be3 --- /dev/null +++ b/api/src/models/comment_extractions_predictions.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentExtractionsPredictions { + #[serde(rename = "groups")] + pub groups: Vec, +} + +impl CommentExtractionsPredictions { + pub fn new(groups: Vec) -> CommentExtractionsPredictions { + CommentExtractionsPredictions { + groups, + } + } +} + diff --git a/api/src/models/comment_filter.rs b/api/src/models/comment_filter.rs new file mode 100644 index 00000000..e956bf17 --- /dev/null +++ b/api/src/models/comment_filter.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentFilter { + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + #[serde(rename = "thread_properties", skip_serializing_if = "Option::is_none")] + pub thread_properties: Option>, + #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")] + pub timestamp: Option>, + #[serde(rename = "reviewed", skip_serializing_if = "Option::is_none")] + pub reviewed: Option, + #[serde(rename = "sources", skip_serializing_if = "Option::is_none")] + pub sources: Option>, + #[serde(rename = "messages", skip_serializing_if = "Option::is_none")] + pub messages: Option>, + #[serde(rename = "user_properties", skip_serializing_if = "Option::is_none")] + pub user_properties: Option, + #[serde(rename = "trigger_exceptions", skip_serializing_if = "Option::is_none")] + pub trigger_exceptions: Option>, + #[serde(rename = "annotations", skip_serializing_if = "Option::is_none")] + pub annotations: Option>, +} + +impl CommentFilter { + pub fn new() -> CommentFilter { + CommentFilter { + entities: None, + thread_properties: None, + timestamp: None, + reviewed: None, + sources: None, + messages: None, + user_properties: None, + trigger_exceptions: None, + annotations: None, + } + } +} + diff --git a/api/src/models/comment_new.rs b/api/src/models/comment_new.rs new file mode 100644 index 00000000..943cc559 --- /dev/null +++ b/api/src/models/comment_new.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentNew { + /// ID of the comment unique within a source + #[serde(rename = "id")] + pub id: String, + /// User supplied comment timestamp + #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")] + pub timestamp: Option, + #[serde(rename = "thread_id", skip_serializing_if = "Option::is_none")] + pub thread_id: Option, + #[serde(rename = "user_properties", skip_serializing_if = "Option::is_none")] + pub user_properties: Option>, + #[serde(rename = "messages", skip_serializing_if = "Option::is_none")] + pub messages: Option>, + #[serde(rename = "text_format", skip_serializing_if = "Option::is_none")] + pub text_format: Option, + #[serde(rename = "attachments", skip_serializing_if = "Option::is_none")] + pub attachments: Option>, +} + +impl CommentNew { + pub fn new(id: String) -> CommentNew { + CommentNew { + id, + timestamp: None, + thread_id: None, + user_properties: None, + messages: None, + text_format: None, + attachments: None, + } + } +} + diff --git a/api/src/models/comment_prediction.rs b/api/src/models/comment_prediction.rs new file mode 100644 index 00000000..9275169f --- /dev/null +++ b/api/src/models/comment_prediction.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentPrediction { + /// Comment id + #[serde(rename = "uid")] + pub uid: String, + /// List of predicted labels + #[serde(rename = "labels")] + pub labels: Vec, + /// List of predicted entities + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + /// List of predicted label properties + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>, + /// Predicted sentiment + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, + /// List of translations + #[serde(rename = "translations", skip_serializing_if = "Option::is_none")] + pub translations: Option>, +} + +impl CommentPrediction { + pub fn new(uid: String, labels: Vec) -> CommentPrediction { + CommentPrediction { + uid, + labels, + entities: None, + label_properties: None, + sentiment: None, + translations: None, + } + } +} + diff --git a/api/src/models/comment_sentiment.rs b/api/src/models/comment_sentiment.rs new file mode 100644 index 00000000..95db4ab2 --- /dev/null +++ b/api/src/models/comment_sentiment.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentSentiment { + #[serde(rename = "total")] + pub total: f64, +} + +impl CommentSentiment { + pub fn new(total: f64) -> CommentSentiment { + CommentSentiment { + total, + } + } +} + diff --git a/api/src/models/comment_span_new_char.rs b/api/src/models/comment_span_new_char.rs new file mode 100644 index 00000000..e0635f6b --- /dev/null +++ b/api/src/models/comment_span_new_char.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// CommentSpanNewChar : Definition of a comment span to be created +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentSpanNewChar { + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "char_start")] + pub char_start: i32, + #[serde(rename = "char_end")] + pub char_end: i32, +} + +impl CommentSpanNewChar { + /// Definition of a comment span to be created + pub fn new(content_part: models::ContentPart, message_index: i32, char_start: i32, char_end: i32) -> CommentSpanNewChar { + CommentSpanNewChar { + content_part, + message_index, + char_start, + char_end, + } + } +} + diff --git a/api/src/models/comment_span_new_utf16.rs b/api/src/models/comment_span_new_utf16.rs new file mode 100644 index 00000000..741fb64e --- /dev/null +++ b/api/src/models/comment_span_new_utf16.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// CommentSpanNewUtf16 : Definition of a new comment span +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentSpanNewUtf16 { + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, +} + +impl CommentSpanNewUtf16 { + /// Definition of a new comment span + pub fn new(content_part: models::ContentPart, message_index: i32, utf16_byte_start: i32, utf16_byte_end: i32) -> CommentSpanNewUtf16 { + CommentSpanNewUtf16 { + content_part, + message_index, + utf16_byte_start, + utf16_byte_end, + } + } +} + diff --git a/api/src/models/comment_thread.rs b/api/src/models/comment_thread.rs new file mode 100644 index 00000000..9701d816 --- /dev/null +++ b/api/src/models/comment_thread.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CommentThread { + /// Thread ID + #[serde(rename = "thread_id")] + pub thread_id: String, + /// List of comments + #[serde(rename = "comments")] + pub comments: Vec, +} + +impl CommentThread { + pub fn new(thread_id: String, comments: Vec) -> CommentThread { + CommentThread { + thread_id, + comments, + } + } +} + diff --git a/api/src/models/comparison.rs b/api/src/models/comparison.rs new file mode 100644 index 00000000..264d6954 --- /dev/null +++ b/api/src/models/comparison.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Comparison { + #[serde(rename = "num_comments")] + pub num_comments: Vec, + #[serde(rename = "label_counts")] + pub label_counts: std::collections::HashMap, +} + +impl Comparison { + pub fn new(num_comments: Vec, label_counts: std::collections::HashMap) -> Comparison { + Comparison { + num_comments, + label_counts, + } + } +} + diff --git a/api/src/models/connection_model.rs b/api/src/models/connection_model.rs new file mode 100644 index 00000000..6ab9b3aa --- /dev/null +++ b/api/src/models/connection_model.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ConnectionModel { + #[serde(rename = "application")] + pub application: Box, + #[serde(rename = "access")] + pub access: Box, + #[serde(rename = "microsoft_api")] + pub microsoft_api: Box, + #[serde(rename = "ews_endpoint", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub ews_endpoint: Option>, + #[serde(rename = "build_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub build_version: Option>, +} + +impl ConnectionModel { + pub fn new(application: models::Application, access: models::Access, microsoft_api: models::MicrosoftApi) -> ConnectionModel { + ConnectionModel { + application: Box::new(application), + access: Box::new(access), + microsoft_api: Box::new(microsoft_api), + ews_endpoint: None, + build_version: None, + } + } +} + diff --git a/api/src/models/content_part.rs b/api/src/models/content_part.rs new file mode 100644 index 00000000..ff8c41fb --- /dev/null +++ b/api/src/models/content_part.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ContentPart : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ContentPart { + #[serde(rename = "body")] + Body, + #[serde(rename = "subject")] + Subject, + #[serde(rename = "signature")] + Signature, + +} + +impl std::fmt::Display for ContentPart { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Body => write!(f, "body"), + Self::Subject => write!(f, "subject"), + Self::Signature => write!(f, "signature"), + } + } +} + +impl Default for ContentPart { + fn default() -> ContentPart { + Self::Body + } +} + diff --git a/api/src/models/contribution.rs b/api/src/models/contribution.rs new file mode 100644 index 00000000..b3b91d77 --- /dev/null +++ b/api/src/models/contribution.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Contribution { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "value")] + pub value: f64, +} + +impl Contribution { + pub fn new(name: String, value: f64) -> Contribution { + Contribution { + name, + value, + } + } +} + diff --git a/api/src/models/contributor.rs b/api/src/models/contributor.rs new file mode 100644 index 00000000..3a20ed80 --- /dev/null +++ b/api/src/models/contributor.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Contributor { + #[serde(rename = "kind")] + pub kind: models::ContributorKind, + #[serde(rename = "value")] + pub value: f64, +} + +impl Contributor { + pub fn new(kind: models::ContributorKind, value: f64) -> Contributor { + Contributor { + kind, + value, + } + } +} + diff --git a/api/src/models/contributor_kind.rs b/api/src/models/contributor_kind.rs new file mode 100644 index 00000000..0b6fed0c --- /dev/null +++ b/api/src/models/contributor_kind.rs @@ -0,0 +1,81 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ContributorKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ContributorKind { + #[serde(rename = "bias_model_score")] + BiasModelScore, + #[serde(rename = "rebalance_ratio")] + RebalanceRatio, + #[serde(rename = "shuffle_ratio")] + ShuffleRatio, + #[serde(rename = "text_search_ratio")] + TextSearchRatio, + #[serde(rename = "coverage")] + Coverage, + #[serde(rename = "p_any_label")] + PAnyLabel, + #[serde(rename = "expected_num_labels")] + ExpectedNumLabels, + #[serde(rename = "p_uninformative")] + PUninformative, + #[serde(rename = "label_only_coverage")] + LabelOnlyCoverage, + #[serde(rename = "mean_ap")] + MeanAp, + #[serde(rename = "weighted_map")] + WeightedMap, + #[serde(rename = "num_poor_labels")] + NumPoorLabels, + #[serde(rename = "num_average_labels")] + NumAverageLabels, + #[serde(rename = "lowest_labels_poor_ratio")] + LowestLabelsPoorRatio, + #[serde(rename = "lowest_labels_average_ratio")] + LowestLabelsAverageRatio, + #[serde(rename = "lowest_labels_map")] + LowestLabelsMap, + +} + +impl std::fmt::Display for ContributorKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::BiasModelScore => write!(f, "bias_model_score"), + Self::RebalanceRatio => write!(f, "rebalance_ratio"), + Self::ShuffleRatio => write!(f, "shuffle_ratio"), + Self::TextSearchRatio => write!(f, "text_search_ratio"), + Self::Coverage => write!(f, "coverage"), + Self::PAnyLabel => write!(f, "p_any_label"), + Self::ExpectedNumLabels => write!(f, "expected_num_labels"), + Self::PUninformative => write!(f, "p_uninformative"), + Self::LabelOnlyCoverage => write!(f, "label_only_coverage"), + Self::MeanAp => write!(f, "mean_ap"), + Self::WeightedMap => write!(f, "weighted_map"), + Self::NumPoorLabels => write!(f, "num_poor_labels"), + Self::NumAverageLabels => write!(f, "num_average_labels"), + Self::LowestLabelsPoorRatio => write!(f, "lowest_labels_poor_ratio"), + Self::LowestLabelsAverageRatio => write!(f, "lowest_labels_average_ratio"), + Self::LowestLabelsMap => write!(f, "lowest_labels_map"), + } + } +} + +impl Default for ContributorKind { + fn default() -> ContributorKind { + Self::BiasModelScore + } +} + diff --git a/api/src/models/conversational_filter_request.rs b/api/src/models/conversational_filter_request.rs new file mode 100644 index 00000000..ba6554ff --- /dev/null +++ b/api/src/models/conversational_filter_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ConversationalFilterRequest { + #[serde(rename = "query")] + pub query: String, + #[serde(rename = "previous_filter", skip_serializing_if = "Option::is_none")] + pub previous_filter: Option, +} + +impl ConversationalFilterRequest { + pub fn new(query: String) -> ConversationalFilterRequest { + ConversationalFilterRequest { + query, + previous_filter: None, + } + } +} + diff --git a/api/src/models/conversational_filter_response.rs b/api/src/models/conversational_filter_response.rs new file mode 100644 index 00000000..b39edea1 --- /dev/null +++ b/api/src/models/conversational_filter_response.rs @@ -0,0 +1,59 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ConversationalFilterResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "filter", skip_serializing_if = "Option::is_none")] + pub filter: Option, + #[serde(rename = "attribute_filters", skip_serializing_if = "Option::is_none")] + pub attribute_filters: Option>, + #[serde(rename = "reply", skip_serializing_if = "Option::is_none")] + pub reply: Option, + #[serde(rename = "request_id", skip_serializing_if = "Option::is_none")] + pub request_id: Option, + #[serde(rename = "resolved")] + pub resolved: i32, + #[serde(rename = "unresolved")] + pub unresolved: i32, + #[serde(rename = "thread_mode")] + pub thread_mode: bool, +} + +impl ConversationalFilterResponse { + pub fn new(status: Status, resolved: i32, unresolved: i32, thread_mode: bool) -> ConversationalFilterResponse { + ConversationalFilterResponse { + status, + filter: None, + attribute_filters: None, + reply: None, + request_id: None, + resolved, + unresolved, + thread_mode, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/coocurrence.rs b/api/src/models/coocurrence.rs new file mode 100644 index 00000000..98200101 --- /dev/null +++ b/api/src/models/coocurrence.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Coocurrence { + #[serde(rename = "row_major_matrix")] + pub row_major_matrix: Vec, + #[serde(rename = "label_indices")] + pub label_indices: Vec, +} + +impl Coocurrence { + pub fn new(row_major_matrix: Vec, label_indices: Vec) -> Coocurrence { + Coocurrence { + row_major_matrix, + label_indices, + } + } +} + diff --git a/api/src/models/coocurrence_labels.rs b/api/src/models/coocurrence_labels.rs new file mode 100644 index 00000000..ce669b4b --- /dev/null +++ b/api/src/models/coocurrence_labels.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CoocurrenceLabels { + #[serde(rename = "rates")] + pub rates: Vec, + #[serde(rename = "label_indices")] + pub label_indices: Vec, +} + +impl CoocurrenceLabels { + pub fn new(rates: Vec, label_indices: Vec) -> CoocurrenceLabels { + CoocurrenceLabels { + rates, + label_indices, + } + } +} + diff --git a/api/src/models/count.rs b/api/src/models/count.rs new file mode 100644 index 00000000..ba646ed0 --- /dev/null +++ b/api/src/models/count.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Count : Count of bucket contents +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(tag = "kind")] +pub enum Count { + #[serde(rename="lower_bound")] + LowerBound(Box), + #[serde(rename="exact")] + Exact(Box), +} + +impl Default for Count { + fn default() -> Self { + Self::LowerBound(Default::default()) + } +} + + diff --git a/api/src/models/create_alert_request.rs b/api/src/models/create_alert_request.rs new file mode 100644 index 00000000..31e02bd1 --- /dev/null +++ b/api/src/models/create_alert_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateAlertRequest { + #[serde(rename = "alert")] + pub alert: Box, +} + +impl CreateAlertRequest { + pub fn new(alert: models::AlertNew) -> CreateAlertRequest { + CreateAlertRequest { + alert: Box::new(alert), + } + } +} + diff --git a/api/src/models/create_alert_response.rs b/api/src/models/create_alert_response.rs new file mode 100644 index 00000000..9490ba07 --- /dev/null +++ b/api/src/models/create_alert_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateAlertResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "alert")] + pub alert: Box, +} + +impl CreateAlertResponse { + pub fn new(status: Status, alert: models::Alert) -> CreateAlertResponse { + CreateAlertResponse { + status, + alert: Box::new(alert), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_bucket_request.rs b/api/src/models/create_bucket_request.rs new file mode 100644 index 00000000..552cfcd1 --- /dev/null +++ b/api/src/models/create_bucket_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateBucketRequest { + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl CreateBucketRequest { + pub fn new(bucket: models::BucketNew) -> CreateBucketRequest { + CreateBucketRequest { + bucket: Box::new(bucket), + } + } +} + diff --git a/api/src/models/create_bucket_response.rs b/api/src/models/create_bucket_response.rs new file mode 100644 index 00000000..4d049ac6 --- /dev/null +++ b/api/src/models/create_bucket_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateBucketResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl CreateBucketResponse { + pub fn new(status: Status, bucket: models::Bucket) -> CreateBucketResponse { + CreateBucketResponse { + status, + bucket: Box::new(bucket), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_dashboard_request.rs b/api/src/models/create_dashboard_request.rs new file mode 100644 index 00000000..2e80d862 --- /dev/null +++ b/api/src/models/create_dashboard_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateDashboardRequest { + #[serde(rename = "dashboard")] + pub dashboard: Box, +} + +impl CreateDashboardRequest { + pub fn new(dashboard: models::NewDashboard) -> CreateDashboardRequest { + CreateDashboardRequest { + dashboard: Box::new(dashboard), + } + } +} + diff --git a/api/src/models/create_dashboard_response.rs b/api/src/models/create_dashboard_response.rs new file mode 100644 index 00000000..45c5b978 --- /dev/null +++ b/api/src/models/create_dashboard_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateDashboardResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dashboard")] + pub dashboard: Box, +} + +impl CreateDashboardResponse { + pub fn new(status: Status, dashboard: models::Dashboard) -> CreateDashboardResponse { + CreateDashboardResponse { + status, + dashboard: Box::new(dashboard), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_dataset_request.rs b/api/src/models/create_dataset_request.rs new file mode 100644 index 00000000..f5a785ff --- /dev/null +++ b/api/src/models/create_dataset_request.rs @@ -0,0 +1,29 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// CreateDatasetRequest : Request to create a new dataset +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateDatasetRequest { + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl CreateDatasetRequest { + /// Request to create a new dataset + pub fn new(dataset: models::DatasetNew) -> CreateDatasetRequest { + CreateDatasetRequest { + dataset: Box::new(dataset), + } + } +} + diff --git a/api/src/models/create_dataset_response.rs b/api/src/models/create_dataset_response.rs new file mode 100644 index 00000000..dd673b8a --- /dev/null +++ b/api/src/models/create_dataset_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dataset")] + pub dataset: Box, + #[serde(rename = "num_copied", skip_serializing_if = "Option::is_none")] + pub num_copied: Option, +} + +impl CreateDatasetResponse { + pub fn new(status: Status, dataset: models::Dataset) -> CreateDatasetResponse { + CreateDatasetResponse { + status, + dataset: Box::new(dataset), + num_copied: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_integration_request.rs b/api/src/models/create_integration_request.rs new file mode 100644 index 00000000..774e5727 --- /dev/null +++ b/api/src/models/create_integration_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateIntegrationRequest { + #[serde(rename = "integration")] + pub integration: Box, +} + +impl CreateIntegrationRequest { + pub fn new(integration: models::IntegrationNew) -> CreateIntegrationRequest { + CreateIntegrationRequest { + integration: Box::new(integration), + } + } +} + diff --git a/api/src/models/create_integration_response.rs b/api/src/models/create_integration_response.rs new file mode 100644 index 00000000..e9300ae2 --- /dev/null +++ b/api/src/models/create_integration_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateIntegrationResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integration")] + pub integration: Box, +} + +impl CreateIntegrationResponse { + pub fn new(status: Status, integration: models::Integration) -> CreateIntegrationResponse { + CreateIntegrationResponse { + status, + integration: Box::new(integration), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_ixp_dataset_request.rs b/api/src/models/create_ixp_dataset_request.rs new file mode 100644 index 00000000..3bf3e685 --- /dev/null +++ b/api/src/models/create_ixp_dataset_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateIxpDatasetRequest { + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl CreateIxpDatasetRequest { + pub fn new(dataset: models::IxpDatasetNew) -> CreateIxpDatasetRequest { + CreateIxpDatasetRequest { + dataset: Box::new(dataset), + } + } +} + diff --git a/api/src/models/create_ixp_dataset_response.rs b/api/src/models/create_ixp_dataset_response.rs new file mode 100644 index 00000000..c577c1c4 --- /dev/null +++ b/api/src/models/create_ixp_dataset_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateIxpDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl CreateIxpDatasetResponse { + pub fn new(status: Status, dataset: models::Dataset) -> CreateIxpDatasetResponse { + CreateIxpDatasetResponse { + status, + dataset: Box::new(dataset), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_label_defs_bulk_response.rs b/api/src/models/create_label_defs_bulk_response.rs new file mode 100644 index 00000000..12be5c6e --- /dev/null +++ b/api/src/models/create_label_defs_bulk_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateLabelDefsBulkResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl CreateLabelDefsBulkResponse { + pub fn new(status: Status) -> CreateLabelDefsBulkResponse { + CreateLabelDefsBulkResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_label_group_request.rs b/api/src/models/create_label_group_request.rs new file mode 100644 index 00000000..2897f7b1 --- /dev/null +++ b/api/src/models/create_label_group_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateLabelGroupRequest { + #[serde(rename = "label_collection_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub label_collection_name: Option>, + #[serde(rename = "trainable", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub trainable: Option>, + #[serde(rename = "hidden", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub hidden: Option>, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl CreateLabelGroupRequest { + pub fn new() -> CreateLabelGroupRequest { + CreateLabelGroupRequest { + label_collection_name: None, + trainable: None, + hidden: None, + instructions: None, + } + } +} + diff --git a/api/src/models/create_label_group_response.rs b/api/src/models/create_label_group_response.rs new file mode 100644 index 00000000..2adf90c7 --- /dev/null +++ b/api/src/models/create_label_group_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateLabelGroupResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label_group")] + pub label_group: Box, +} + +impl CreateLabelGroupResponse { + pub fn new(status: Status, label_group: models::LabelGroup) -> CreateLabelGroupResponse { + CreateLabelGroupResponse { + status, + label_group: Box::new(label_group), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_or_update_label_defs_bulk_request.rs b/api/src/models/create_or_update_label_defs_bulk_request.rs new file mode 100644 index 00000000..5fbadc21 --- /dev/null +++ b/api/src/models/create_or_update_label_defs_bulk_request.rs @@ -0,0 +1,29 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// CreateOrUpdateLabelDefsBulkRequest : Request to create label defs in bulk in a dataset +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateOrUpdateLabelDefsBulkRequest { + #[serde(rename = "label_defs")] + pub label_defs: Vec, +} + +impl CreateOrUpdateLabelDefsBulkRequest { + /// Request to create label defs in bulk in a dataset + pub fn new(label_defs: Vec) -> CreateOrUpdateLabelDefsBulkRequest { + CreateOrUpdateLabelDefsBulkRequest { + label_defs, + } + } +} + diff --git a/api/src/models/create_or_update_label_defs_bulk_request_label_defs_inner.rs b/api/src/models/create_or_update_label_defs_bulk_request_label_defs_inner.rs new file mode 100644 index 00000000..8066c7be --- /dev/null +++ b/api/src/models/create_or_update_label_defs_bulk_request_label_defs_inner.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateOrUpdateLabelDefsBulkRequestLabelDefsInner { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "external_id", skip_serializing_if = "Option::is_none")] + pub external_id: Option, + #[serde(rename = "pretrained", skip_serializing_if = "Option::is_none")] + pub pretrained: Option>, + #[serde(rename = "trainable", skip_serializing_if = "Option::is_none")] + pub trainable: Option, + #[serde(rename = "moon_form", skip_serializing_if = "Option::is_none")] + pub moon_form: Option>, + #[serde(rename = "properties", skip_serializing_if = "Option::is_none")] + pub properties: Option>, +} + +impl CreateOrUpdateLabelDefsBulkRequestLabelDefsInner { + pub fn new(name: String) -> CreateOrUpdateLabelDefsBulkRequestLabelDefsInner { + CreateOrUpdateLabelDefsBulkRequestLabelDefsInner { + name, + title: None, + instructions: None, + external_id: None, + pretrained: None, + trainable: None, + moon_form: None, + properties: None, + } + } +} + diff --git a/api/src/models/create_page_view_request.rs b/api/src/models/create_page_view_request.rs new file mode 100644 index 00000000..6d5069a2 --- /dev/null +++ b/api/src/models/create_page_view_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreatePageViewRequest { + #[serde(rename = "page")] + pub page: String, + #[serde(rename = "timing", skip_serializing_if = "Option::is_none")] + pub timing: Option, +} + +impl CreatePageViewRequest { + pub fn new(page: String) -> CreatePageViewRequest { + CreatePageViewRequest { + page, + timing: None, + } + } +} + diff --git a/api/src/models/create_page_view_response.rs b/api/src/models/create_page_view_response.rs new file mode 100644 index 00000000..dee408aa --- /dev/null +++ b/api/src/models/create_page_view_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreatePageViewResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl CreatePageViewResponse { + pub fn new(status: Status) -> CreatePageViewResponse { + CreatePageViewResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_project_request.rs b/api/src/models/create_project_request.rs new file mode 100644 index 00000000..e1b5edc3 --- /dev/null +++ b/api/src/models/create_project_request.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateProjectRequest { + #[serde(rename = "project")] + pub project: Box, + #[serde(rename = "user_ids", skip_serializing_if = "Option::is_none")] + pub user_ids: Option>, + #[serde(rename = "uipath_user_ids", skip_serializing_if = "Option::is_none")] + pub uipath_user_ids: Option>, +} + +impl CreateProjectRequest { + pub fn new(project: models::ProjectNew) -> CreateProjectRequest { + CreateProjectRequest { + project: Box::new(project), + user_ids: None, + uipath_user_ids: None, + } + } +} + diff --git a/api/src/models/create_project_response.rs b/api/src/models/create_project_response.rs new file mode 100644 index 00000000..81a2aefa --- /dev/null +++ b/api/src/models/create_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "project")] + pub project: Box, +} + +impl CreateProjectResponse { + pub fn new(status: Status, project: models::Project) -> CreateProjectResponse { + CreateProjectResponse { + status, + project: Box::new(project), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_project_setup_created_response.rs b/api/src/models/create_project_setup_created_response.rs new file mode 100644 index 00000000..199297e4 --- /dev/null +++ b/api/src/models/create_project_setup_created_response.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateProjectSetupCreatedResponse { + /// Whether the project was newly created + #[serde(rename = "project")] + pub project: bool, + /// Whether the source was newly created + #[serde(rename = "source")] + pub source: bool, + /// Whether the dataset was newly created + #[serde(rename = "dataset")] + pub dataset: bool, +} + +impl CreateProjectSetupCreatedResponse { + pub fn new(project: bool, source: bool, dataset: bool) -> CreateProjectSetupCreatedResponse { + CreateProjectSetupCreatedResponse { + project, + source, + dataset, + } + } +} + diff --git a/api/src/models/create_project_setup_request.rs b/api/src/models/create_project_setup_request.rs new file mode 100644 index 00000000..1409bd49 --- /dev/null +++ b/api/src/models/create_project_setup_request.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateProjectSetupRequest { + #[serde(rename = "project")] + pub project: Box, + #[serde(rename = "source")] + pub source: Box, + #[serde(rename = "dataset")] + pub dataset: Box, + #[serde(rename = "stream")] + pub stream: Box, + #[serde(rename = "users")] + pub users: Box, +} + +impl CreateProjectSetupRequest { + pub fn new(project: models::ProjectSetupNewProject, source: models::Source1, dataset: models::ProjectSetupNewDataset, stream: models::ProjectSetupNewStream, users: models::ProjectSetupNewUsers) -> CreateProjectSetupRequest { + CreateProjectSetupRequest { + project: Box::new(project), + source: Box::new(source), + dataset: Box::new(dataset), + stream: Box::new(stream), + users: Box::new(users), + } + } +} + diff --git a/api/src/models/create_project_setup_response.rs b/api/src/models/create_project_setup_response.rs new file mode 100644 index 00000000..9e2e4d22 --- /dev/null +++ b/api/src/models/create_project_setup_response.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateProjectSetupResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "created")] + pub created: Box, + #[serde(rename = "project")] + pub project: Box, + #[serde(rename = "source")] + pub source: Box, + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl CreateProjectSetupResponse { + pub fn new(status: Status, created: models::CreateProjectSetupCreatedResponse, project: models::Project, source: models::Source, dataset: models::Dataset) -> CreateProjectSetupResponse { + CreateProjectSetupResponse { + status, + created: Box::new(created), + project: Box::new(project), + source: Box::new(source), + dataset: Box::new(dataset), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_source_request.rs b/api/src/models/create_source_request.rs new file mode 100644 index 00000000..c3f438dd --- /dev/null +++ b/api/src/models/create_source_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateSourceRequest { + #[serde(rename = "source")] + pub source: Box, +} + +impl CreateSourceRequest { + pub fn new(source: models::SourceUpdate) -> CreateSourceRequest { + CreateSourceRequest { + source: Box::new(source), + } + } +} + diff --git a/api/src/models/create_source_response.rs b/api/src/models/create_source_response.rs new file mode 100644 index 00000000..3aec9978 --- /dev/null +++ b/api/src/models/create_source_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateSourceResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "source")] + pub source: Box, +} + +impl CreateSourceResponse { + pub fn new(status: Status, source: models::Source) -> CreateSourceResponse { + CreateSourceResponse { + status, + source: Box::new(source), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_stream_request.rs b/api/src/models/create_stream_request.rs new file mode 100644 index 00000000..4b4277e8 --- /dev/null +++ b/api/src/models/create_stream_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateStreamRequest { + #[serde(rename = "stream")] + pub stream: Box, +} + +impl CreateStreamRequest { + pub fn new(stream: models::TriggerNew) -> CreateStreamRequest { + CreateStreamRequest { + stream: Box::new(stream), + } + } +} + diff --git a/api/src/models/create_stream_response.rs b/api/src/models/create_stream_response.rs new file mode 100644 index 00000000..2101c407 --- /dev/null +++ b/api/src/models/create_stream_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateStreamResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "stream")] + pub stream: Box, +} + +impl CreateStreamResponse { + pub fn new(status: Status, stream: models::Trigger) -> CreateStreamResponse { + CreateStreamResponse { + status, + stream: Box::new(stream), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_tenant_request.rs b/api/src/models/create_tenant_request.rs new file mode 100644 index 00000000..1a3058d0 --- /dev/null +++ b/api/src/models/create_tenant_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateTenantRequest { + #[serde(rename = "tenant")] + pub tenant: Box, +} + +impl CreateTenantRequest { + pub fn new(tenant: models::TenantNew) -> CreateTenantRequest { + CreateTenantRequest { + tenant: Box::new(tenant), + } + } +} + diff --git a/api/src/models/create_tenant_response.rs b/api/src/models/create_tenant_response.rs new file mode 100644 index 00000000..99ac53ad --- /dev/null +++ b/api/src/models/create_tenant_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateTenantResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "tenant")] + pub tenant: Box, +} + +impl CreateTenantResponse { + pub fn new(status: Status, tenant: models::Tenant) -> CreateTenantResponse { + CreateTenantResponse { + status, + tenant: Box::new(tenant), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_trigger_request.rs b/api/src/models/create_trigger_request.rs new file mode 100644 index 00000000..e92284c5 --- /dev/null +++ b/api/src/models/create_trigger_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateTriggerRequest { + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl CreateTriggerRequest { + pub fn new(trigger: models::TriggerNew) -> CreateTriggerRequest { + CreateTriggerRequest { + trigger: Box::new(trigger), + } + } +} + diff --git a/api/src/models/create_trigger_response.rs b/api/src/models/create_trigger_response.rs new file mode 100644 index 00000000..4b3460f0 --- /dev/null +++ b/api/src/models/create_trigger_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl CreateTriggerResponse { + pub fn new(status: Status, trigger: models::Trigger) -> CreateTriggerResponse { + CreateTriggerResponse { + status, + trigger: Box::new(trigger), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/create_user_request.rs b/api/src/models/create_user_request.rs new file mode 100644 index 00000000..1a23e8a6 --- /dev/null +++ b/api/src/models/create_user_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateUserRequest { + #[serde(rename = "user")] + pub user: Box, +} + +impl CreateUserRequest { + pub fn new(user: models::UserNew) -> CreateUserRequest { + CreateUserRequest { + user: Box::new(user), + } + } +} + diff --git a/api/src/models/create_user_response.rs b/api/src/models/create_user_response.rs new file mode 100644 index 00000000..f23be467 --- /dev/null +++ b/api/src/models/create_user_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CreateUserResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "user")] + pub user: Box, +} + +impl CreateUserResponse { + pub fn new(status: Status, user: models::User) -> CreateUserResponse { + CreateUserResponse { + status, + user: Box::new(user), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/custom_action.rs b/api/src/models/custom_action.rs new file mode 100644 index 00000000..f252bc3f --- /dev/null +++ b/api/src/models/custom_action.rs @@ -0,0 +1,54 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// CustomAction : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum CustomAction { + #[serde(rename = "missing-source")] + MissingSource, + #[serde(rename = "insufficient-verbatims-in-sources")] + InsufficientVerbatimsInSources, + #[serde(rename = "insufficient-verbatims")] + InsufficientVerbatims, + #[serde(rename = "insufficient-labels")] + InsufficientLabels, + #[serde(rename = "missing-model-rating")] + MissingModelRating, + #[serde(rename = "shuffle")] + Shuffle, + #[serde(rename = "text-search")] + TextSearch, + +} + +impl std::fmt::Display for CustomAction { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::MissingSource => write!(f, "missing-source"), + Self::InsufficientVerbatimsInSources => write!(f, "insufficient-verbatims-in-sources"), + Self::InsufficientVerbatims => write!(f, "insufficient-verbatims"), + Self::InsufficientLabels => write!(f, "insufficient-labels"), + Self::MissingModelRating => write!(f, "missing-model-rating"), + Self::Shuffle => write!(f, "shuffle"), + Self::TextSearch => write!(f, "text-search"), + } + } +} + +impl Default for CustomAction { + fn default() -> CustomAction { + Self::MissingSource + } +} + diff --git a/api/src/models/custom_training_action.rs b/api/src/models/custom_training_action.rs new file mode 100644 index 00000000..4b3d00c6 --- /dev/null +++ b/api/src/models/custom_training_action.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct CustomTrainingAction { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "plan")] + pub plan: models::CustomAction, +} + +impl CustomTrainingAction { + pub fn new(id: String, kind: Kind, plan: models::CustomAction) -> CustomTrainingAction { + CustomTrainingAction { + id, + kind, + plan, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "custom")] + Custom, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Custom + } +} + diff --git a/api/src/models/dashboard.rs b/api/src/models/dashboard.rs new file mode 100644 index 00000000..ff978148 --- /dev/null +++ b/api/src/models/dashboard.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Dashboard { + #[serde(rename = "id")] + pub id: String, + /// The name of the project the dashboard is in + #[serde(rename = "owner")] + pub owner: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + /// JSON blob containing dashboard charts and their filters + #[serde(rename = "blob")] + pub blob: String, + #[serde(rename = "dataset_ids")] + pub dataset_ids: Vec, + #[serde(rename = "default_for_datasets")] + pub default_for_datasets: Vec, + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "updated_at")] + pub updated_at: String, +} + +impl Dashboard { + pub fn new(id: String, owner: String, name: String, title: String, blob: String, dataset_ids: Vec, default_for_datasets: Vec, created_at: String, updated_at: String) -> Dashboard { + Dashboard { + id, + owner, + name, + title, + blob, + dataset_ids, + default_for_datasets, + created_at, + updated_at, + } + } +} + diff --git a/api/src/models/dashboard_update.rs b/api/src/models/dashboard_update.rs new file mode 100644 index 00000000..43c51b70 --- /dev/null +++ b/api/src/models/dashboard_update.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DashboardUpdate { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + /// JSON blob containing dashboard charts and their filters + #[serde(rename = "blob", skip_serializing_if = "Option::is_none")] + pub blob: Option, + #[serde(rename = "default_for_datasets", skip_serializing_if = "Option::is_none")] + pub default_for_datasets: Option>, +} + +impl DashboardUpdate { + pub fn new() -> DashboardUpdate { + DashboardUpdate { + title: None, + blob: None, + default_for_datasets: None, + } + } +} + diff --git a/api/src/models/data.rs b/api/src/models/data.rs new file mode 100644 index 00000000..b9078e59 --- /dev/null +++ b/api/src/models/data.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Data { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl Data { + pub fn new(kind: Kind) -> Data { + Data { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "monetary")] + Monetary, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Monetary + } +} + diff --git a/api/src/models/data_type.rs b/api/src/models/data_type.rs new file mode 100644 index 00000000..83a2d0fa --- /dev/null +++ b/api/src/models/data_type.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DataType { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl DataType { + pub fn new() -> DataType { + DataType { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "number")] + Number, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Number + } +} + diff --git a/api/src/models/data_type_date.rs b/api/src/models/data_type_date.rs new file mode 100644 index 00000000..d26ea192 --- /dev/null +++ b/api/src/models/data_type_date.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DataTypeDate { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl DataTypeDate { + pub fn new() -> DataTypeDate { + DataTypeDate { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "date")] + Date, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Date + } +} + diff --git a/api/src/models/data_type_money.rs b/api/src/models/data_type_money.rs new file mode 100644 index 00000000..732f0157 --- /dev/null +++ b/api/src/models/data_type_money.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DataTypeMoney { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl DataTypeMoney { + pub fn new() -> DataTypeMoney { + DataTypeMoney { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "money")] + Money, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Money + } +} + diff --git a/api/src/models/data_type_number.rs b/api/src/models/data_type_number.rs new file mode 100644 index 00000000..cdf79f80 --- /dev/null +++ b/api/src/models/data_type_number.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DataTypeNumber { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl DataTypeNumber { + pub fn new() -> DataTypeNumber { + DataTypeNumber { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "number")] + Number, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Number + } +} + diff --git a/api/src/models/data_type_text.rs b/api/src/models/data_type_text.rs new file mode 100644 index 00000000..18ceea36 --- /dev/null +++ b/api/src/models/data_type_text.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DataTypeText { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl DataTypeText { + pub fn new() -> DataTypeText { + DataTypeText { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "text")] + Text, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Text + } +} + diff --git a/api/src/models/dataset.rs b/api/src/models/dataset.rs new file mode 100644 index 00000000..304499fa --- /dev/null +++ b/api/src/models/dataset.rs @@ -0,0 +1,111 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Dataset { + /// Unique ID of the dataset + #[serde(rename = "id")] + pub id: String, + /// The project which owns the dataset + #[serde(rename = "owner")] + pub owner: String, + /// The API name of the dataset which appears in URLs + #[serde(rename = "name")] + pub name: String, + /// A short description of the dataset + #[serde(rename = "title")] + pub title: String, + /// A longer description of the dataset + #[serde(rename = "description")] + pub description: String, + /// The date and time the dataset was created + #[serde(rename = "created")] + pub created: String, + /// The date and time the dataset was last modified + #[serde(rename = "last_modified")] + pub last_modified: String, + /// The model family used to train the dataset + #[serde(rename = "model_family")] + pub model_family: models::ModelFamily, + /// IDs of the sources contained in this dataset + #[serde(rename = "source_ids")] + pub source_ids: Vec, + /// Whether the dataset is sentimentful + #[serde(rename = "has_sentiment")] + pub has_sentiment: bool, + /// Limited Access + #[serde(rename = "limited_access")] + pub limited_access: bool, + /// Entity Defs for this Dataset + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + /// General Fields for this Dataset + #[serde(rename = "general_fields")] + pub general_fields: Vec, + /// Label Groups for this Dataset + #[serde(rename = "label_groups")] + pub label_groups: Vec, + /// Label Defs for this Dataset + #[serde(rename = "label_defs")] + pub label_defs: Vec, + /// Label Properties + #[serde(rename = "_label_properties")] + pub _label_properties: Vec, + /// The name of the IANA time zone used by the frontend to display the timestamps in local time + #[serde(rename = "_timezone")] + pub _timezone: String, + /// Preferred Locales + #[serde(rename = "_preferred_locales")] + pub _preferred_locales: Box, + /// Flags for the dataset + #[serde(rename = "_dataset_flags")] + pub _dataset_flags: Vec, + /// Debug Config JSON + #[serde(rename = "debug_config_json", skip_serializing_if = "Option::is_none")] + pub debug_config_json: Option, + /// Whether the dataset is readonly + #[serde(rename = "readonly", skip_serializing_if = "Option::is_none")] + pub readonly: Option, + #[serde(rename = "_model_config")] + pub _model_config: Box, +} + +impl Dataset { + pub fn new(id: String, owner: String, name: String, title: String, description: String, created: String, last_modified: String, model_family: models::ModelFamily, source_ids: Vec, has_sentiment: bool, limited_access: bool, entity_defs: Vec, general_fields: Vec, label_groups: Vec, label_defs: Vec, _label_properties: Vec, _timezone: String, _preferred_locales: models::PreferredLocale, _dataset_flags: Vec, _model_config: models::ModelConfig) -> Dataset { + Dataset { + id, + owner, + name, + title, + description, + created, + last_modified, + model_family, + source_ids, + has_sentiment, + limited_access, + entity_defs, + general_fields, + label_groups, + label_defs, + _label_properties, + _timezone, + _preferred_locales: Box::new(_preferred_locales), + _dataset_flags, + debug_config_json: None, + readonly: None, + _model_config: Box::new(_model_config), + } + } +} + diff --git a/api/src/models/dataset_flag.rs b/api/src/models/dataset_flag.rs new file mode 100644 index 00000000..6869a08f --- /dev/null +++ b/api/src/models/dataset_flag.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// DatasetFlag : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DatasetFlag { + #[serde(rename = "conversational_filters")] + ConversationalFilters, + #[serde(rename = "external_moon_llm")] + ExternalMoonLlm, + #[serde(rename = "generative_extraction")] + GenerativeExtraction, + #[serde(rename = "generative_prelabelling")] + GenerativePrelabelling, + #[serde(rename = "gpt4")] + Gpt4, + #[serde(rename = "llm_assisted_labelling")] + LlmAssistedLabelling, + #[serde(rename = "qos")] + Qos, + #[serde(rename = "zero_shot_labels")] + ZeroShotLabels, + #[serde(rename = "ixp")] + Ixp, + +} + +impl std::fmt::Display for DatasetFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::ConversationalFilters => write!(f, "conversational_filters"), + Self::ExternalMoonLlm => write!(f, "external_moon_llm"), + Self::GenerativeExtraction => write!(f, "generative_extraction"), + Self::GenerativePrelabelling => write!(f, "generative_prelabelling"), + Self::Gpt4 => write!(f, "gpt4"), + Self::LlmAssistedLabelling => write!(f, "llm_assisted_labelling"), + Self::Qos => write!(f, "qos"), + Self::ZeroShotLabels => write!(f, "zero_shot_labels"), + Self::Ixp => write!(f, "ixp"), + } + } +} + +impl Default for DatasetFlag { + fn default() -> DatasetFlag { + Self::ConversationalFilters + } +} + diff --git a/api/src/models/dataset_new.rs b/api/src/models/dataset_new.rs new file mode 100644 index 00000000..6d4e743b --- /dev/null +++ b/api/src/models/dataset_new.rs @@ -0,0 +1,80 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetNew { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + /// IDs of the sources contained in this dataset + #[serde(rename = "source_ids", skip_serializing_if = "Option::is_none")] + pub source_ids: Option>, + #[serde(rename = "entity_kinds", skip_serializing_if = "Option::is_none")] + pub entity_kinds: Option>, + #[serde(rename = "entity_defs", skip_serializing_if = "Option::is_none")] + pub entity_defs: Option>, + #[serde(rename = "general_fields", skip_serializing_if = "Option::is_none")] + pub general_fields: Option>, + #[serde(rename = "_label_properties", skip_serializing_if = "Option::is_none")] + pub _label_properties: Option>, + #[serde(rename = "debug_config_json", skip_serializing_if = "Option::is_none")] + pub debug_config_json: Option, + #[serde(rename = "model_family", skip_serializing_if = "Option::is_none")] + pub model_family: Option, + /// The name of the IANA time zone (UTC if missing) used by the frontend to display the timestamps in local time + #[serde(rename = "_timezone", skip_serializing_if = "Option::is_none")] + pub _timezone: Option, + #[serde(rename = "_preferred_locales", skip_serializing_if = "Option::is_none")] + pub _preferred_locales: Option>, + #[serde(rename = "_dataset_flags", skip_serializing_if = "Option::is_none")] + pub _dataset_flags: Option>, + #[serde(rename = "_model_config", skip_serializing_if = "Option::is_none")] + pub _model_config: Option>, + #[serde(rename = "has_sentiment", skip_serializing_if = "Option::is_none")] + pub has_sentiment: Option, + #[serde(rename = "experimental_async_fork_dataset", skip_serializing_if = "Option::is_none")] + pub experimental_async_fork_dataset: Option, + #[serde(rename = "label_groups", skip_serializing_if = "Option::is_none")] + pub label_groups: Option>, + #[serde(rename = "label_defs", skip_serializing_if = "Option::is_none")] + pub label_defs: Option>, + #[serde(rename = "copy_annotations_from", skip_serializing_if = "Option::is_none")] + pub copy_annotations_from: Option, +} + +impl DatasetNew { + pub fn new() -> DatasetNew { + DatasetNew { + title: None, + description: None, + source_ids: None, + entity_kinds: None, + entity_defs: None, + general_fields: None, + _label_properties: None, + debug_config_json: None, + model_family: None, + _timezone: None, + _preferred_locales: None, + _dataset_flags: None, + _model_config: None, + has_sentiment: None, + experimental_async_fork_dataset: None, + label_groups: None, + label_defs: None, + copy_annotations_from: None, + } + } +} + diff --git a/api/src/models/dataset_operation.rs b/api/src/models/dataset_operation.rs new file mode 100644 index 00000000..fbf4ef34 --- /dev/null +++ b/api/src/models/dataset_operation.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// DatasetOperation : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DatasetOperation { + #[serde(rename = "fork_taxonomy_destination")] + ForkTaxonomyDestination, + #[serde(rename = "fork_taxonomy_origin")] + ForkTaxonomyOrigin, + #[serde(rename = "reset_annotations_to_model_version")] + ResetAnnotationsToModelVersion, + #[serde(rename = "clean_up_entity_captures")] + CleanUpEntityCaptures, + +} + +impl std::fmt::Display for DatasetOperation { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::ForkTaxonomyDestination => write!(f, "fork_taxonomy_destination"), + Self::ForkTaxonomyOrigin => write!(f, "fork_taxonomy_origin"), + Self::ResetAnnotationsToModelVersion => write!(f, "reset_annotations_to_model_version"), + Self::CleanUpEntityCaptures => write!(f, "clean_up_entity_captures"), + } + } +} + +impl Default for DatasetOperation { + fn default() -> DatasetOperation { + Self::ForkTaxonomyDestination + } +} + diff --git a/api/src/models/dataset_quality.rs b/api/src/models/dataset_quality.rs new file mode 100644 index 00000000..d2579eb5 --- /dev/null +++ b/api/src/models/dataset_quality.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// DatasetQuality : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DatasetQuality { + #[serde(rename = "none")] + None, + #[serde(rename = "poor")] + Poor, + #[serde(rename = "average")] + Average, + #[serde(rename = "good")] + Good, + #[serde(rename = "excellent")] + Excellent, + +} + +impl std::fmt::Display for DatasetQuality { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::None => write!(f, "none"), + Self::Poor => write!(f, "poor"), + Self::Average => write!(f, "average"), + Self::Good => write!(f, "good"), + Self::Excellent => write!(f, "excellent"), + } + } +} + +impl Default for DatasetQuality { + fn default() -> DatasetQuality { + Self::None + } +} + diff --git a/api/src/models/dataset_status.rs b/api/src/models/dataset_status.rs new file mode 100644 index 00000000..d3fbe827 --- /dev/null +++ b/api/src/models/dataset_status.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetStatus { + #[serde(rename = "training_complete", deserialize_with = "Option::deserialize")] + pub training_complete: Option, + #[serde(rename = "validation_complete", deserialize_with = "Option::deserialize")] + pub validation_complete: Option, + #[serde(rename = "training_completion_time")] + pub training_completion_time: String, + #[serde(rename = "inference_complete")] + pub inference_complete: f64, + #[serde(rename = "total_comments_with_text")] + pub total_comments_with_text: i32, + #[serde(rename = "inference_stats_by_version")] + pub inference_stats_by_version: std::collections::HashMap, + #[serde(rename = "inference_stuck")] + pub inference_stuck: bool, + #[serde(rename = "operation", deserialize_with = "Option::deserialize")] + pub operation: Option, +} + +impl DatasetStatus { + pub fn new(training_complete: Option, validation_complete: Option, training_completion_time: String, inference_complete: f64, total_comments_with_text: i32, inference_stats_by_version: std::collections::HashMap, inference_stuck: bool, operation: Option) -> DatasetStatus { + DatasetStatus { + training_complete, + validation_complete, + training_completion_time, + inference_complete, + total_comments_with_text, + inference_stats_by_version, + inference_stuck, + operation, + } + } +} + diff --git a/api/src/models/dataset_summary.rs b/api/src/models/dataset_summary.rs new file mode 100644 index 00000000..9eb746bf --- /dev/null +++ b/api/src/models/dataset_summary.rs @@ -0,0 +1,88 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetSummary { + /// User properties + #[serde(rename = "user_properties")] + pub user_properties: Box, + /// List of label properties + #[serde(rename = "label_properties")] + pub label_properties: Vec, + /// List of label values + #[serde(rename = "source_kinds")] + pub source_kinds: Vec, + /// List of source names + #[serde(rename = "source_names")] + pub source_names: Vec, + /// Annotation metadata + #[serde(rename = "annotation_metadata")] + pub annotation_metadata: Box, + /// Labels + #[serde(rename = "labels")] + pub labels: Vec, + /// Entity definitions + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + /// Email properties + #[serde(rename = "email_properties", skip_serializing_if = "Option::is_none")] + pub email_properties: Option>, + /// Trigger exceptions + #[serde(rename = "trigger_exceptions", skip_serializing_if = "Option::is_none")] + pub trigger_exceptions: Option>, + /// Mapping between common types and file extensions to be used in attachment property filters + #[serde(rename = "attachments_common_types_extensions")] + pub attachments_common_types_extensions: std::collections::HashMap>, + /// List of file extensions to be shown in attachment property filters + #[serde(rename = "attachments_file_extensions")] + pub attachments_file_extensions: std::collections::HashMap>, +} + +impl DatasetSummary { + pub fn new(user_properties: models::DatasetUserPropertiesSummary, label_properties: Vec, source_kinds: Vec, source_names: Vec, annotation_metadata: models::AnnotationMetadataCount, labels: Vec, entity_defs: Vec, attachments_common_types_extensions: std::collections::HashMap>, attachments_file_extensions: std::collections::HashMap>) -> DatasetSummary { + DatasetSummary { + user_properties: Box::new(user_properties), + label_properties, + source_kinds, + source_names, + annotation_metadata: Box::new(annotation_metadata), + labels, + entity_defs, + email_properties: None, + trigger_exceptions: None, + attachments_common_types_extensions, + attachments_file_extensions, + } + } +} +/// List of label values +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum SourceKinds { + #[serde(rename = "call")] + Call, + #[serde(rename = "chat")] + Chat, + #[serde(rename = "unknown")] + Unknown, + #[serde(rename = "ixp_design")] + IxpDesign, + #[serde(rename = "ixp_runtime")] + IxpRuntime, +} + +impl Default for SourceKinds { + fn default() -> SourceKinds { + Self::Call + } +} + diff --git a/api/src/models/dataset_training_action.rs b/api/src/models/dataset_training_action.rs new file mode 100644 index 00000000..11d46ee2 --- /dev/null +++ b/api/src/models/dataset_training_action.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetTrainingAction { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "factor_kind")] + pub factor_kind: models::ModelRatingFactorKind, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "plan")] + pub plan: models::ModelRatingAction, +} + +impl DatasetTrainingAction { + pub fn new(id: String, kind: Kind, factor_kind: models::ModelRatingFactorKind, quality: models::DatasetQuality, plan: models::ModelRatingAction) -> DatasetTrainingAction { + DatasetTrainingAction { + id, + kind, + factor_kind, + quality, + plan, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "dataset")] + Dataset, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Dataset + } +} + diff --git a/api/src/models/dataset_update.rs b/api/src/models/dataset_update.rs new file mode 100644 index 00000000..de982df9 --- /dev/null +++ b/api/src/models/dataset_update.rs @@ -0,0 +1,69 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetUpdate { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + /// IDs of the sources contained in this dataset + #[serde(rename = "source_ids", skip_serializing_if = "Option::is_none")] + pub source_ids: Option>, + #[serde(rename = "entity_kinds", skip_serializing_if = "Option::is_none")] + pub entity_kinds: Option>, + #[serde(rename = "entity_defs", skip_serializing_if = "Option::is_none")] + pub entity_defs: Option>, + #[serde(rename = "general_fields", skip_serializing_if = "Option::is_none")] + pub general_fields: Option>, + #[serde(rename = "_label_properties", skip_serializing_if = "Option::is_none")] + pub _label_properties: Option>, + #[serde(rename = "debug_config_json", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub debug_config_json: Option>, + #[serde(rename = "model_family", skip_serializing_if = "Option::is_none")] + pub model_family: Option, + /// The name of the IANA time zone used by the frontend to display the timestamps in local time + #[serde(rename = "_timezone", skip_serializing_if = "Option::is_none")] + pub _timezone: Option, + #[serde(rename = "_preferred_locales", skip_serializing_if = "Option::is_none")] + pub _preferred_locales: Option>, + #[serde(rename = "_dataset_flags", skip_serializing_if = "Option::is_none")] + pub _dataset_flags: Option>, + #[serde(rename = "_model_config", skip_serializing_if = "Option::is_none")] + pub _model_config: Option>, + /// The instructions to apply to the default label group + #[serde(rename = "_default_label_group_instructions", skip_serializing_if = "Option::is_none")] + pub _default_label_group_instructions: Option, +} + +impl DatasetUpdate { + pub fn new() -> DatasetUpdate { + DatasetUpdate { + title: None, + description: None, + source_ids: None, + entity_kinds: None, + entity_defs: None, + general_fields: None, + _label_properties: None, + debug_config_json: None, + model_family: None, + _timezone: None, + _preferred_locales: None, + _dataset_flags: None, + _model_config: None, + _default_label_group_instructions: None, + } + } +} + diff --git a/api/src/models/dataset_update_entity_defs_inner.rs b/api/src/models/dataset_update_entity_defs_inner.rs new file mode 100644 index 00000000..91a5d1d9 --- /dev/null +++ b/api/src/models/dataset_update_entity_defs_inner.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetUpdateEntityDefsInner { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "color", skip_serializing_if = "Option::is_none")] + pub color: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "inherits_from")] + pub inherits_from: Box, + #[serde(rename = "trainable")] + pub trainable: bool, + #[serde(rename = "rules", skip_serializing_if = "Option::is_none")] + pub rules: Option>, + #[serde(rename = "_entity_def_flags", skip_serializing_if = "Option::is_none")] + pub _entity_def_flags: Option>, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl DatasetUpdateEntityDefsInner { + pub fn new(id: String, name: String, title: String, inherits_from: models::InheritsFrom, trainable: bool) -> DatasetUpdateEntityDefsInner { + DatasetUpdateEntityDefsInner { + id, + color: None, + name, + title, + inherits_from: Box::new(inherits_from), + trainable, + rules: None, + _entity_def_flags: None, + instructions: None, + } + } +} + diff --git a/api/src/models/dataset_user_properties_summary.rs b/api/src/models/dataset_user_properties_summary.rs new file mode 100644 index 00000000..bb330aa1 --- /dev/null +++ b/api/src/models/dataset_user_properties_summary.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DatasetUserPropertiesSummary { + /// List of numbers + #[serde(rename = "number")] + pub number: Vec, + /// List of strings + #[serde(rename = "string")] + pub string: Vec, +} + +impl DatasetUserPropertiesSummary { + pub fn new(number: Vec, string: Vec) -> DatasetUserPropertiesSummary { + DatasetUserPropertiesSummary { + number, + string, + } + } +} + diff --git a/api/src/models/date_field_data_private.rs b/api/src/models/date_field_data_private.rs new file mode 100644 index 00000000..bbe30e2d --- /dev/null +++ b/api/src/models/date_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DateFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl DateFieldDataPrivate { + pub fn new(kind: Kind) -> DateFieldDataPrivate { + DateFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "date")] + Date, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Date + } +} + diff --git a/api/src/models/date_field_data_type.rs b/api/src/models/date_field_data_type.rs new file mode 100644 index 00000000..7bfd2638 --- /dev/null +++ b/api/src/models/date_field_data_type.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DateFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl DateFieldDataType { + pub fn new(kind: Kind) -> DateFieldDataType { + DateFieldDataType { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "date")] + Date, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Date + } +} + diff --git a/api/src/models/delete_alert_response.rs b/api/src/models/delete_alert_response.rs new file mode 100644 index 00000000..1f59a7c8 --- /dev/null +++ b/api/src/models/delete_alert_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteAlertResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteAlertResponse { + pub fn new(status: Status) -> DeleteAlertResponse { + DeleteAlertResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_alert_subscription_reponse.rs b/api/src/models/delete_alert_subscription_reponse.rs new file mode 100644 index 00000000..8ceb2352 --- /dev/null +++ b/api/src/models/delete_alert_subscription_reponse.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteAlertSubscriptionReponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteAlertSubscriptionReponse { + pub fn new(status: Status) -> DeleteAlertSubscriptionReponse { + DeleteAlertSubscriptionReponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_bucket_response.rs b/api/src/models/delete_bucket_response.rs new file mode 100644 index 00000000..6145733d --- /dev/null +++ b/api/src/models/delete_bucket_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteBucketResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteBucketResponse { + pub fn new(status: Status) -> DeleteBucketResponse { + DeleteBucketResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_comment_response.rs b/api/src/models/delete_comment_response.rs new file mode 100644 index 00000000..88ede61a --- /dev/null +++ b/api/src/models/delete_comment_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteCommentResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteCommentResponse { + pub fn new(status: Status) -> DeleteCommentResponse { + DeleteCommentResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_dashboard_response.rs b/api/src/models/delete_dashboard_response.rs new file mode 100644 index 00000000..ed63b5ca --- /dev/null +++ b/api/src/models/delete_dashboard_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteDashboardResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteDashboardResponse { + pub fn new(status: Status) -> DeleteDashboardResponse { + DeleteDashboardResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_dataset_by_id_response.rs b/api/src/models/delete_dataset_by_id_response.rs new file mode 100644 index 00000000..ffbefccd --- /dev/null +++ b/api/src/models/delete_dataset_by_id_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteDatasetByIdResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteDatasetByIdResponse { + pub fn new(status: Status) -> DeleteDatasetByIdResponse { + DeleteDatasetByIdResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_dataset_response.rs b/api/src/models/delete_dataset_response.rs new file mode 100644 index 00000000..03f4a121 --- /dev/null +++ b/api/src/models/delete_dataset_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteDatasetResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteDatasetResponse { + pub fn new(status: Status) -> DeleteDatasetResponse { + DeleteDatasetResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_integration_response.rs b/api/src/models/delete_integration_response.rs new file mode 100644 index 00000000..4f09064b --- /dev/null +++ b/api/src/models/delete_integration_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteIntegrationResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteIntegrationResponse { + pub fn new(status: Status) -> DeleteIntegrationResponse { + DeleteIntegrationResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_ixp_dataset_response.rs b/api/src/models/delete_ixp_dataset_response.rs new file mode 100644 index 00000000..53b478bd --- /dev/null +++ b/api/src/models/delete_ixp_dataset_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteIxpDatasetResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteIxpDatasetResponse { + pub fn new(status: Status) -> DeleteIxpDatasetResponse { + DeleteIxpDatasetResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_keyed_sync_state_response.rs b/api/src/models/delete_keyed_sync_state_response.rs new file mode 100644 index 00000000..84704b66 --- /dev/null +++ b/api/src/models/delete_keyed_sync_state_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteKeyedSyncStateResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteKeyedSyncStateResponse { + pub fn new(status: Status) -> DeleteKeyedSyncStateResponse { + DeleteKeyedSyncStateResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_label_def_response.rs b/api/src/models/delete_label_def_response.rs new file mode 100644 index 00000000..37bcc697 --- /dev/null +++ b/api/src/models/delete_label_def_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteLabelDefResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "num_modified")] + pub num_modified: i32, +} + +impl DeleteLabelDefResponse { + pub fn new(status: Status, num_modified: i32) -> DeleteLabelDefResponse { + DeleteLabelDefResponse { + status, + num_modified, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_label_group_response.rs b/api/src/models/delete_label_group_response.rs new file mode 100644 index 00000000..8d771e24 --- /dev/null +++ b/api/src/models/delete_label_group_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteLabelGroupResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteLabelGroupResponse { + pub fn new(status: Status) -> DeleteLabelGroupResponse { + DeleteLabelGroupResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_model_tag_response.rs b/api/src/models/delete_model_tag_response.rs new file mode 100644 index 00000000..846e07c3 --- /dev/null +++ b/api/src/models/delete_model_tag_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteModelTagResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteModelTagResponse { + pub fn new(status: Status) -> DeleteModelTagResponse { + DeleteModelTagResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_project_response.rs b/api/src/models/delete_project_response.rs new file mode 100644 index 00000000..5a34fa54 --- /dev/null +++ b/api/src/models/delete_project_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteProjectResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteProjectResponse { + pub fn new(status: Status) -> DeleteProjectResponse { + DeleteProjectResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_source_response.rs b/api/src/models/delete_source_response.rs new file mode 100644 index 00000000..0993ca35 --- /dev/null +++ b/api/src/models/delete_source_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteSourceResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteSourceResponse { + pub fn new(status: Status) -> DeleteSourceResponse { + DeleteSourceResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_stream_exception_response.rs b/api/src/models/delete_stream_exception_response.rs new file mode 100644 index 00000000..eb0a7450 --- /dev/null +++ b/api/src/models/delete_stream_exception_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteStreamExceptionResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteStreamExceptionResponse { + pub fn new(status: Status) -> DeleteStreamExceptionResponse { + DeleteStreamExceptionResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_stream_response.rs b/api/src/models/delete_stream_response.rs new file mode 100644 index 00000000..81ccabe3 --- /dev/null +++ b/api/src/models/delete_stream_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteStreamResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteStreamResponse { + pub fn new(status: Status) -> DeleteStreamResponse { + DeleteStreamResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_tenant_default_project_permissions_response.rs b/api/src/models/delete_tenant_default_project_permissions_response.rs new file mode 100644 index 00000000..cf0ad644 --- /dev/null +++ b/api/src/models/delete_tenant_default_project_permissions_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteTenantDefaultProjectPermissionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "default_project_permissions")] + pub default_project_permissions: Vec, +} + +impl DeleteTenantDefaultProjectPermissionsResponse { + pub fn new(status: Status, default_project_permissions: Vec) -> DeleteTenantDefaultProjectPermissionsResponse { + DeleteTenantDefaultProjectPermissionsResponse { + status, + default_project_permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_tenant_response.rs b/api/src/models/delete_tenant_response.rs new file mode 100644 index 00000000..660660f3 --- /dev/null +++ b/api/src/models/delete_tenant_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteTenantResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteTenantResponse { + pub fn new(status: Status) -> DeleteTenantResponse { + DeleteTenantResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_trigger_response.rs b/api/src/models/delete_trigger_response.rs new file mode 100644 index 00000000..4279906a --- /dev/null +++ b/api/src/models/delete_trigger_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteTriggerResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteTriggerResponse { + pub fn new(status: Status) -> DeleteTriggerResponse { + DeleteTriggerResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/delete_user_response.rs b/api/src/models/delete_user_response.rs new file mode 100644 index 00000000..2e4252c7 --- /dev/null +++ b/api/src/models/delete_user_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeleteUserResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl DeleteUserResponse { + pub fn new(status: Status) -> DeleteUserResponse { + DeleteUserResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/deprecated_user_model_metadata.rs b/api/src/models/deprecated_user_model_metadata.rs new file mode 100644 index 00000000..d2ed29e9 --- /dev/null +++ b/api/src/models/deprecated_user_model_metadata.rs @@ -0,0 +1,52 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DeprecatedUserModelMetadata { + /// The dataset ID + #[serde(rename = "dataset_id")] + pub dataset_id: String, + /// The version of the model + #[serde(rename = "version")] + pub version: i32, + /// The model ID + #[serde(rename = "model_id")] + pub model_id: String, + /// The fingerprint of the model + #[serde(rename = "fingerprint")] + pub fingerprint: String, + /// Timestamp when the model was trained + #[serde(rename = "trained_time")] + pub trained_time: String, + /// Timestamp when the model was trained + #[serde(rename = "input_updated_at")] + pub input_updated_at: String, + /// Whether the model is pinned + #[serde(rename = "pinned")] + pub pinned: bool, +} + +impl DeprecatedUserModelMetadata { + pub fn new(dataset_id: String, version: i32, model_id: String, fingerprint: String, trained_time: String, input_updated_at: String, pinned: bool) -> DeprecatedUserModelMetadata { + DeprecatedUserModelMetadata { + dataset_id, + version, + model_id, + fingerprint, + trained_time, + input_updated_at, + pinned, + } + } +} + diff --git a/api/src/models/diagnostic.rs b/api/src/models/diagnostic.rs new file mode 100644 index 00000000..96a72e71 --- /dev/null +++ b/api/src/models/diagnostic.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Diagnostic { + #[serde(rename = "kind")] + pub kind: Box, + #[serde(rename = "value")] + pub value: f64, +} + +impl Diagnostic { + pub fn new(kind: models::RichDiagnosticKind, value: f64) -> Diagnostic { + Diagnostic { + kind: Box::new(kind), + value, + } + } +} + diff --git a/api/src/models/diagnostic_kind.rs b/api/src/models/diagnostic_kind.rs new file mode 100644 index 00000000..fdd8b3f7 --- /dev/null +++ b/api/src/models/diagnostic_kind.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// DiagnosticKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DiagnosticKind { + #[serde(rename = "bias")] + Bias, + #[serde(rename = "informative")] + Informative, + #[serde(rename = "label_only_neglect")] + LabelOnlyNeglect, + #[serde(rename = "neglect")] + Neglect, + #[serde(rename = "teach_entity")] + TeachEntity, + #[serde(rename = "missed_entity")] + MissedEntity, + #[serde(rename = "check_entity")] + CheckEntity, + #[serde(rename = "extraction_error_rate")] + ExtractionErrorRate, + +} + +impl std::fmt::Display for DiagnosticKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Bias => write!(f, "bias"), + Self::Informative => write!(f, "informative"), + Self::LabelOnlyNeglect => write!(f, "label_only_neglect"), + Self::Neglect => write!(f, "neglect"), + Self::TeachEntity => write!(f, "teach_entity"), + Self::MissedEntity => write!(f, "missed_entity"), + Self::CheckEntity => write!(f, "check_entity"), + Self::ExtractionErrorRate => write!(f, "extraction_error_rate"), + } + } +} + +impl Default for DiagnosticKind { + fn default() -> DiagnosticKind { + Self::Bias + } +} + diff --git a/api/src/models/direction.rs b/api/src/models/direction.rs new file mode 100644 index 00000000..ab5c1311 --- /dev/null +++ b/api/src/models/direction.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Direction : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Direction { + #[serde(rename = "greater_than")] + GreaterThan, + #[serde(rename = "less_than")] + LessThan, + +} + +impl std::fmt::Display for Direction { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::GreaterThan => write!(f, "greater_than"), + Self::LessThan => write!(f, "less_than"), + } + } +} + +impl Default for Direction { + fn default() -> Direction { + Self::GreaterThan + } +} + diff --git a/api/src/models/disable_integration_action.rs b/api/src/models/disable_integration_action.rs new file mode 100644 index 00000000..57515f15 --- /dev/null +++ b/api/src/models/disable_integration_action.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DisableIntegrationAction { + /// An identifier/type discriminator for the action taken in response to the server error + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl DisableIntegrationAction { + pub fn new(kind: Kind) -> DisableIntegrationAction { + DisableIntegrationAction { + kind, + } + } +} +/// An identifier/type discriminator for the action taken in response to the server error +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "integration_disabled")] + IntegrationDisabled, +} + +impl Default for Kind { + fn default() -> Kind { + Self::IntegrationDisabled + } +} + diff --git a/api/src/models/disable_mailbox_action.rs b/api/src/models/disable_mailbox_action.rs new file mode 100644 index 00000000..42e44ff4 --- /dev/null +++ b/api/src/models/disable_mailbox_action.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DisableMailboxAction { + /// An identifier/type discriminator for the action taken in response to the server error + #[serde(rename = "kind")] + pub kind: Kind, + /// Email address for the mailbox that has been disabled + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + /// Unique ID of the bucket where the mailbox was syncing + #[serde(rename = "bucket_id")] + pub bucket_id: String, +} + +impl DisableMailboxAction { + pub fn new(kind: Kind, mailbox_name: String, bucket_id: String) -> DisableMailboxAction { + DisableMailboxAction { + kind, + mailbox_name, + bucket_id, + } + } +} +/// An identifier/type discriminator for the action taken in response to the server error +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "mailbox_disabled")] + MailboxDisabled, +} + +impl Default for Kind { + fn default() -> Kind { + Self::MailboxDisabled + } +} + diff --git a/api/src/models/doc_path_ixp_model_config.rs b/api/src/models/doc_path_ixp_model_config.rs new file mode 100644 index 00000000..7c83d21a --- /dev/null +++ b/api/src/models/doc_path_ixp_model_config.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DocPathIxpModelConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "num_pages_per_chunk", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub num_pages_per_chunk: Option>, +} + +impl DocPathIxpModelConfig { + pub fn new() -> DocPathIxpModelConfig { + DocPathIxpModelConfig { + kind: None, + num_pages_per_chunk: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "doc_path_ixp")] + DocPathIxp, +} + +impl Default for Kind { + fn default() -> Kind { + Self::DocPathIxp + } +} + diff --git a/api/src/models/document_label_property_prediction.rs b/api/src/models/document_label_property_prediction.rs new file mode 100644 index 00000000..05fa81e9 --- /dev/null +++ b/api/src/models/document_label_property_prediction.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DocumentLabelPropertyPrediction { + #[serde(rename = "property_id")] + pub property_id: String, + #[serde(rename = "property_name")] + pub property_name: models::LabelPropertyName, + #[serde(rename = "value")] + pub value: f64, +} + +impl DocumentLabelPropertyPrediction { + pub fn new(property_id: String, property_name: models::LabelPropertyName, value: f64) -> DocumentLabelPropertyPrediction { + DocumentLabelPropertyPrediction { + property_id, + property_name, + value, + } + } +} + diff --git a/api/src/models/document_search_result.rs b/api/src/models/document_search_result.rs new file mode 100644 index 00000000..468c5ecc --- /dev/null +++ b/api/src/models/document_search_result.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DocumentSearchResult { + #[serde(rename = "page_index")] + pub page_index: i32, + #[serde(rename = "selections")] + pub selections: Vec, +} + +impl DocumentSearchResult { + pub fn new(page_index: i32, selections: Vec) -> DocumentSearchResult { + DocumentSearchResult { + page_index, + selections, + } + } +} + diff --git a/api/src/models/document_span.rs b/api/src/models/document_span.rs new file mode 100644 index 00000000..dac7aab8 --- /dev/null +++ b/api/src/models/document_span.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct DocumentSpan { + #[serde(rename = "page_index")] + pub page_index: i32, + #[serde(rename = "attachment_index")] + pub attachment_index: i32, + #[serde(rename = "polygon")] + pub polygon: Box, +} + +impl DocumentSpan { + pub fn new(page_index: i32, attachment_index: i32, polygon: models::PagePolygon) -> DocumentSpan { + DocumentSpan { + page_index, + attachment_index, + polygon: Box::new(polygon), + } + } +} + diff --git a/api/src/models/email.rs b/api/src/models/email.rs new file mode 100644 index 00000000..8394cf82 --- /dev/null +++ b/api/src/models/email.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Email { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "mailbox")] + pub mailbox: String, + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "mime_content")] + pub mime_content: String, + #[serde(rename = "metadata", deserialize_with = "Option::deserialize")] + pub metadata: Option>, + #[serde(rename = "attachments")] + pub attachments: Vec, + #[serde(rename = "created_at", deserialize_with = "Option::deserialize")] + pub created_at: Option, + #[serde(rename = "updated_at", deserialize_with = "Option::deserialize")] + pub updated_at: Option, +} + +impl Email { + pub fn new(id: String, mailbox: String, timestamp: String, mime_content: String, metadata: Option, attachments: Vec, created_at: Option, updated_at: Option) -> Email { + Email { + id, + mailbox, + timestamp, + mime_content, + metadata: metadata.map(Box::new), + attachments, + created_at, + updated_at, + } + } +} + diff --git a/api/src/models/email_metadata.rs b/api/src/models/email_metadata.rs new file mode 100644 index 00000000..bcd61e94 --- /dev/null +++ b/api/src/models/email_metadata.rs @@ -0,0 +1,54 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailMetadata { + #[serde(rename = "sensitivity", deserialize_with = "Option::deserialize")] + pub sensitivity: Option, + #[serde(rename = "size", deserialize_with = "Option::deserialize")] + pub size: Option, + #[serde(rename = "categories")] + pub categories: Vec, + #[serde(rename = "importance", deserialize_with = "Option::deserialize")] + pub importance: Option, + #[serde(rename = "has_attachments", deserialize_with = "Option::deserialize")] + pub has_attachments: Option, + #[serde(rename = "conversation_id", deserialize_with = "Option::deserialize")] + pub conversation_id: Option, + #[serde(rename = "conversation_topic", deserialize_with = "Option::deserialize")] + pub conversation_topic: Option, + #[serde(rename = "is_read", deserialize_with = "Option::deserialize")] + pub is_read: Option, + #[serde(rename = "folder")] + pub folder: Vec, + #[serde(rename = "received_at", deserialize_with = "Option::deserialize")] + pub received_at: Option, +} + +impl EmailMetadata { + pub fn new(sensitivity: Option, size: Option, categories: Vec, importance: Option, has_attachments: Option, conversation_id: Option, conversation_topic: Option, is_read: Option, folder: Vec, received_at: Option) -> EmailMetadata { + EmailMetadata { + sensitivity, + size, + categories, + importance, + has_attachments, + conversation_id, + conversation_topic, + is_read, + folder, + received_at, + } + } +} + diff --git a/api/src/models/email_metadata_new.rs b/api/src/models/email_metadata_new.rs new file mode 100644 index 00000000..a21f8cd0 --- /dev/null +++ b/api/src/models/email_metadata_new.rs @@ -0,0 +1,54 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailMetadataNew { + #[serde(rename = "sensitivity", skip_serializing_if = "Option::is_none")] + pub sensitivity: Option, + #[serde(rename = "size", skip_serializing_if = "Option::is_none")] + pub size: Option, + #[serde(rename = "categories", skip_serializing_if = "Option::is_none")] + pub categories: Option>, + #[serde(rename = "importance", skip_serializing_if = "Option::is_none")] + pub importance: Option, + #[serde(rename = "has_attachments", skip_serializing_if = "Option::is_none")] + pub has_attachments: Option, + #[serde(rename = "conversation_id", skip_serializing_if = "Option::is_none")] + pub conversation_id: Option, + #[serde(rename = "conversation_topic", skip_serializing_if = "Option::is_none")] + pub conversation_topic: Option, + #[serde(rename = "is_read", skip_serializing_if = "Option::is_none")] + pub is_read: Option, + #[serde(rename = "folder", skip_serializing_if = "Option::is_none")] + pub folder: Option>, + #[serde(rename = "received_at", skip_serializing_if = "Option::is_none")] + pub received_at: Option, +} + +impl EmailMetadataNew { + pub fn new() -> EmailMetadataNew { + EmailMetadataNew { + sensitivity: None, + size: None, + categories: None, + importance: None, + has_attachments: None, + conversation_id: None, + conversation_topic: None, + is_read: None, + folder: None, + received_at: None, + } + } +} + diff --git a/api/src/models/email_new.rs b/api/src/models/email_new.rs new file mode 100644 index 00000000..5930bd67 --- /dev/null +++ b/api/src/models/email_new.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailNew { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "mailbox")] + pub mailbox: String, + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "mime_content")] + pub mime_content: String, + #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")] + pub metadata: Option>, + #[serde(rename = "attachments", skip_serializing_if = "Option::is_none")] + pub attachments: Option>, +} + +impl EmailNew { + pub fn new(id: String, mailbox: String, timestamp: String, mime_content: String) -> EmailNew { + EmailNew { + id, + mailbox, + timestamp, + mime_content, + metadata: None, + attachments: None, + } + } +} + diff --git a/api/src/models/email_properties_summary.rs b/api/src/models/email_properties_summary.rs new file mode 100644 index 00000000..f90ac1f0 --- /dev/null +++ b/api/src/models/email_properties_summary.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertiesSummary { + #[serde(rename = "too_many_values")] + pub too_many_values: bool, + #[serde(rename = "values")] + pub values: Vec, +} + +impl EmailPropertiesSummary { + pub fn new(too_many_values: bool, values: Vec) -> EmailPropertiesSummary { + EmailPropertiesSummary { + too_many_values, + values, + } + } +} + diff --git a/api/src/models/email_properties_summary_by_property.rs b/api/src/models/email_properties_summary_by_property.rs new file mode 100644 index 00000000..ad2e54c6 --- /dev/null +++ b/api/src/models/email_properties_summary_by_property.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertiesSummaryByProperty { + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, + #[serde(rename = "sender", skip_serializing_if = "Option::is_none")] + pub sender: Option>, + #[serde(rename = "recipient_domain", skip_serializing_if = "Option::is_none")] + pub recipient_domain: Option>, + #[serde(rename = "sender_domain", skip_serializing_if = "Option::is_none")] + pub sender_domain: Option>, + #[serde(rename = "recipient_organisation", skip_serializing_if = "Option::is_none")] + pub recipient_organisation: Option>, + #[serde(rename = "sender_organisation", skip_serializing_if = "Option::is_none")] + pub sender_organisation: Option>, +} + +impl EmailPropertiesSummaryByProperty { + pub fn new() -> EmailPropertiesSummaryByProperty { + EmailPropertiesSummaryByProperty { + to: None, + cc: None, + bcc: None, + sender: None, + recipient_domain: None, + sender_domain: None, + recipient_organisation: None, + sender_organisation: None, + } + } +} + diff --git a/api/src/models/email_properties_summary_value.rs b/api/src/models/email_properties_summary_value.rs new file mode 100644 index 00000000..e1877ab7 --- /dev/null +++ b/api/src/models/email_properties_summary_value.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertiesSummaryValue { + #[serde(rename = "value")] + pub value: String, +} + +impl EmailPropertiesSummaryValue { + pub fn new(value: String) -> EmailPropertiesSummaryValue { + EmailPropertiesSummaryValue { + value, + } + } +} + diff --git a/api/src/models/email_property_counts.rs b/api/src/models/email_property_counts.rs new file mode 100644 index 00000000..e4026855 --- /dev/null +++ b/api/src/models/email_property_counts.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertyCounts { + #[serde(rename = "settings")] + pub settings: Box, + #[serde(rename = "values")] + pub values: Vec, + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "num_comments")] + pub num_comments: Vec, + #[serde(rename = "num_labels")] + pub num_labels: Vec>, + #[serde(rename = "label_property_digest", skip_serializing_if = "Option::is_none")] + pub label_property_digest: Option>, +} + +impl EmailPropertyCounts { + pub fn new(settings: models::EmailPropertyCountsSettings, values: Vec, labels: Vec, num_comments: Vec, num_labels: Vec>) -> EmailPropertyCounts { + EmailPropertyCounts { + settings: Box::new(settings), + values, + labels, + num_comments, + num_labels, + label_property_digest: None, + } + } +} + diff --git a/api/src/models/email_property_counts_by_property.rs b/api/src/models/email_property_counts_by_property.rs new file mode 100644 index 00000000..18a099ba --- /dev/null +++ b/api/src/models/email_property_counts_by_property.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertyCountsByProperty { + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, + #[serde(rename = "sender", skip_serializing_if = "Option::is_none")] + pub sender: Option>, + #[serde(rename = "recipient", skip_serializing_if = "Option::is_none")] + pub recipient: Option>, + #[serde(rename = "recipient_domain", skip_serializing_if = "Option::is_none")] + pub recipient_domain: Option>, + #[serde(rename = "sender_domain", skip_serializing_if = "Option::is_none")] + pub sender_domain: Option>, + #[serde(rename = "recipient_organisation", skip_serializing_if = "Option::is_none")] + pub recipient_organisation: Option>, + #[serde(rename = "sender_organisation", skip_serializing_if = "Option::is_none")] + pub sender_organisation: Option>, +} + +impl EmailPropertyCountsByProperty { + pub fn new() -> EmailPropertyCountsByProperty { + EmailPropertyCountsByProperty { + to: None, + cc: None, + bcc: None, + sender: None, + recipient: None, + recipient_domain: None, + sender_domain: None, + recipient_organisation: None, + sender_organisation: None, + } + } +} + diff --git a/api/src/models/email_property_counts_settings.rs b/api/src/models/email_property_counts_settings.rs new file mode 100644 index 00000000..288f6478 --- /dev/null +++ b/api/src/models/email_property_counts_settings.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertyCountsSettings { + #[serde(rename = "limit")] + pub limit: i32, + #[serde(rename = "values", skip_serializing_if = "Option::is_none")] + pub values: Option>, +} + +impl EmailPropertyCountsSettings { + pub fn new(limit: i32) -> EmailPropertyCountsSettings { + EmailPropertyCountsSettings { + limit, + values: None, + } + } +} + diff --git a/api/src/models/email_property_counts_settings_by_property.rs b/api/src/models/email_property_counts_settings_by_property.rs new file mode 100644 index 00000000..553540e8 --- /dev/null +++ b/api/src/models/email_property_counts_settings_by_property.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailPropertyCountsSettingsByProperty { + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, + #[serde(rename = "sender", skip_serializing_if = "Option::is_none")] + pub sender: Option>, + #[serde(rename = "recipient", skip_serializing_if = "Option::is_none")] + pub recipient: Option>, + #[serde(rename = "recipient_domain", skip_serializing_if = "Option::is_none")] + pub recipient_domain: Option>, + #[serde(rename = "sender_domain", skip_serializing_if = "Option::is_none")] + pub sender_domain: Option>, + #[serde(rename = "recipient_organisation", skip_serializing_if = "Option::is_none")] + pub recipient_organisation: Option>, + #[serde(rename = "sender_organisation", skip_serializing_if = "Option::is_none")] + pub sender_organisation: Option>, +} + +impl EmailPropertyCountsSettingsByProperty { + pub fn new() -> EmailPropertyCountsSettingsByProperty { + EmailPropertyCountsSettingsByProperty { + to: None, + cc: None, + bcc: None, + sender: None, + recipient: None, + recipient_domain: None, + sender_domain: None, + recipient_organisation: None, + sender_organisation: None, + } + } +} + diff --git a/api/src/models/email_transform_tag_info.rs b/api/src/models/email_transform_tag_info.rs new file mode 100644 index 00000000..bc616666 --- /dev/null +++ b/api/src/models/email_transform_tag_info.rs @@ -0,0 +1,31 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EmailTransformTagInfo { + #[serde(rename = "text_format")] + pub text_format: Box, + /// If this field exists there is an equivalent rich text transform tag. Update the source with this tag here to trigger a rich text migration + #[serde(rename = "rich_text_upgrade_tag", skip_serializing_if = "Option::is_none")] + pub rich_text_upgrade_tag: Option, +} + +impl EmailTransformTagInfo { + pub fn new(text_format: models::TextFormat) -> EmailTransformTagInfo { + EmailTransformTagInfo { + text_format: Box::new(text_format), + rich_text_upgrade_tag: None, + } + } +} + diff --git a/api/src/models/entities.rs b/api/src/models/entities.rs new file mode 100644 index 00000000..4b155bfd --- /dev/null +++ b/api/src/models/entities.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Entities { + #[serde(rename = "assigned")] + pub assigned: Vec, + #[serde(rename = "dismissed")] + pub dismissed: Vec, + #[serde(rename = "predicted")] + pub predicted: Vec, +} + +impl Entities { + pub fn new(assigned: Vec, dismissed: Vec, predicted: Vec) -> Entities { + Entities { + assigned, + dismissed, + predicted, + } + } +} + diff --git a/api/src/models/entities_new.rs b/api/src/models/entities_new.rs new file mode 100644 index 00000000..e51462f7 --- /dev/null +++ b/api/src/models/entities_new.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntitiesNew { + #[serde(rename = "assigned", skip_serializing_if = "Option::is_none")] + pub assigned: Option>, + #[serde(rename = "dismissed", skip_serializing_if = "Option::is_none")] + pub dismissed: Option>, +} + +impl EntitiesNew { + pub fn new() -> EntitiesNew { + EntitiesNew { + assigned: None, + dismissed: None, + } + } +} + diff --git a/api/src/models/entities_pr_stats.rs b/api/src/models/entities_pr_stats.rs new file mode 100644 index 00000000..3ff89134 --- /dev/null +++ b/api/src/models/entities_pr_stats.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntitiesPrStats { + #[serde(rename = "num_train_entities")] + pub num_train_entities: i32, + #[serde(rename = "num_test_entities")] + pub num_test_entities: i32, + #[serde(rename = "num_reviewed_entities")] + pub num_reviewed_entities: i32, + #[serde(rename = "num_train_documents")] + pub num_train_documents: i32, + #[serde(rename = "num_test_documents")] + pub num_test_documents: i32, + #[serde(rename = "num_reviewed_documents")] + pub num_reviewed_documents: i32, + #[serde(rename = "error_count")] + pub error_count: i32, + #[serde(rename = "entities_by_def_id")] + pub entities_by_def_id: std::collections::HashMap, + #[serde(rename = "precision", skip_serializing_if = "Option::is_none")] + pub precision: Option, + #[serde(rename = "recall", skip_serializing_if = "Option::is_none")] + pub recall: Option, + #[serde(rename = "f1_score", skip_serializing_if = "Option::is_none")] + pub f1_score: Option, +} + +impl EntitiesPrStats { + pub fn new(num_train_entities: i32, num_test_entities: i32, num_reviewed_entities: i32, num_train_documents: i32, num_test_documents: i32, num_reviewed_documents: i32, error_count: i32, entities_by_def_id: std::collections::HashMap) -> EntitiesPrStats { + EntitiesPrStats { + num_train_entities, + num_test_entities, + num_reviewed_entities, + num_train_documents, + num_test_documents, + num_reviewed_documents, + error_count, + entities_by_def_id, + precision: None, + recall: None, + f1_score: None, + } + } +} + diff --git a/api/src/models/entities_rules.rs b/api/src/models/entities_rules.rs new file mode 100644 index 00000000..c054f4d4 --- /dev/null +++ b/api/src/models/entities_rules.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntitiesRules { + #[serde(rename = "presence", skip_serializing_if = "Option::is_none")] + pub presence: Option>, +} + +impl EntitiesRules { + pub fn new() -> EntitiesRules { + EntitiesRules { + presence: None, + } + } +} + diff --git a/api/src/models/entities_rules_presence_inner.rs b/api/src/models/entities_rules_presence_inner.rs new file mode 100644 index 00000000..6c082840 --- /dev/null +++ b/api/src/models/entities_rules_presence_inner.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntitiesRulesPresenceInner { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "rule")] + pub rule: String, + #[serde(rename = "kind")] + pub kind: String, +} + +impl EntitiesRulesPresenceInner { + pub fn new(id: String, rule: String, kind: String) -> EntitiesRulesPresenceInner { + EntitiesRulesPresenceInner { + id, + rule, + kind, + } + } +} + diff --git a/api/src/models/entity.rs b/api/src/models/entity.rs new file mode 100644 index 00000000..e56d9694 --- /dev/null +++ b/api/src/models/entity.rs @@ -0,0 +1,46 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Entity { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "kind")] + pub kind: String, + /// Deprecated. Wil be populated by first span if there's exactly one span, for backwards compatibility. + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + #[serde(rename = "spans")] + pub spans: Vec, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "field_id")] + pub field_id: String, +} + +impl Entity { + pub fn new(id: String, name: String, kind: String, spans: Vec, formatted_value: String, field_id: String) -> Entity { + Entity { + id, + name, + kind, + span: None, + spans, + formatted_value, + field_id, + } + } +} + diff --git a/api/src/models/entity_average_stats.rs b/api/src/models/entity_average_stats.rs new file mode 100644 index 00000000..70b0f2b9 --- /dev/null +++ b/api/src/models/entity_average_stats.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityAverageStats { + #[serde(rename = "num_train_entities")] + pub num_train_entities: i32, + #[serde(rename = "num_test_entities")] + pub num_test_entities: i32, + #[serde(rename = "num_reviewed_entities")] + pub num_reviewed_entities: i32, + #[serde(rename = "num_train_documents")] + pub num_train_documents: i32, + #[serde(rename = "num_test_documents")] + pub num_test_documents: i32, + #[serde(rename = "num_reviewed_documents")] + pub num_reviewed_documents: i32, + #[serde(rename = "error_count")] + pub error_count: i32, + #[serde(rename = "is_safe")] + pub is_safe: bool, + #[serde(rename = "precision", skip_serializing_if = "Option::is_none")] + pub precision: Option, + #[serde(rename = "recall", skip_serializing_if = "Option::is_none")] + pub recall: Option, + #[serde(rename = "f1_score", skip_serializing_if = "Option::is_none")] + pub f1_score: Option, +} + +impl EntityAverageStats { + pub fn new(num_train_entities: i32, num_test_entities: i32, num_reviewed_entities: i32, num_train_documents: i32, num_test_documents: i32, num_reviewed_documents: i32, error_count: i32, is_safe: bool) -> EntityAverageStats { + EntityAverageStats { + num_train_entities, + num_test_entities, + num_reviewed_entities, + num_train_documents, + num_test_documents, + num_reviewed_documents, + error_count, + is_safe, + precision: None, + recall: None, + f1_score: None, + } + } +} + diff --git a/api/src/models/entity_def.rs b/api/src/models/entity_def.rs new file mode 100644 index 00000000..e40ab025 --- /dev/null +++ b/api/src/models/entity_def.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDef { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "color")] + pub color: i32, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "inherits_from")] + pub inherits_from: Vec, + #[serde(rename = "trainable")] + pub trainable: bool, + #[serde(rename = "rules", skip_serializing_if = "Option::is_none")] + pub rules: Option>, + #[serde(rename = "_entity_def_flags")] + pub _entity_def_flags: Vec, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl EntityDef { + pub fn new(id: String, color: i32, name: String, title: String, inherits_from: Vec, trainable: bool, _entity_def_flags: Vec) -> EntityDef { + EntityDef { + id, + color, + name, + title, + inherits_from, + trainable, + rules: None, + _entity_def_flags, + instructions: None, + } + } +} + diff --git a/api/src/models/entity_def_flag.rs b/api/src/models/entity_def_flag.rs new file mode 100644 index 00000000..fb5ba7d8 --- /dev/null +++ b/api/src/models/entity_def_flag.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// EntityDefFlag : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum EntityDefFlag { + #[serde(rename = "appears_verbatim")] + AppearsVerbatim, + #[serde(rename = "allow_out_of_domain")] + AllowOutOfDomain, + +} + +impl std::fmt::Display for EntityDefFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::AppearsVerbatim => write!(f, "appears_verbatim"), + Self::AllowOutOfDomain => write!(f, "allow_out_of_domain"), + } + } +} + +impl Default for EntityDefFlag { + fn default() -> EntityDefFlag { + Self::AppearsVerbatim + } +} + diff --git a/api/src/models/entity_def_id_stat.rs b/api/src/models/entity_def_id_stat.rs new file mode 100644 index 00000000..06ac0cf5 --- /dev/null +++ b/api/src/models/entity_def_id_stat.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDefIdStat { + #[serde(rename = "num_train_entities")] + pub num_train_entities: i32, + #[serde(rename = "num_test_entities")] + pub num_test_entities: i32, + #[serde(rename = "num_reviewed_entities")] + pub num_reviewed_entities: i32, + #[serde(rename = "num_train_documents")] + pub num_train_documents: i32, + #[serde(rename = "num_test_documents")] + pub num_test_documents: i32, + #[serde(rename = "num_reviewed_documents")] + pub num_reviewed_documents: i32, + #[serde(rename = "error_count")] + pub error_count: i32, + #[serde(rename = "is_safe")] + pub is_safe: bool, + #[serde(rename = "health")] + pub health: Box, + #[serde(rename = "recall", skip_serializing_if = "Option::is_none")] + pub recall: Option, + #[serde(rename = "precision", skip_serializing_if = "Option::is_none")] + pub precision: Option, + #[serde(rename = "f1_score", skip_serializing_if = "Option::is_none")] + pub f1_score: Option, +} + +impl EntityDefIdStat { + pub fn new(num_train_entities: i32, num_test_entities: i32, num_reviewed_entities: i32, num_train_documents: i32, num_test_documents: i32, num_reviewed_documents: i32, error_count: i32, is_safe: bool, health: models::EntityHealth) -> EntityDefIdStat { + EntityDefIdStat { + num_train_entities, + num_test_entities, + num_reviewed_entities, + num_train_documents, + num_test_documents, + num_reviewed_documents, + error_count, + is_safe, + health: Box::new(health), + recall: None, + precision: None, + f1_score: None, + } + } +} + diff --git a/api/src/models/entity_def_new.rs b/api/src/models/entity_def_new.rs new file mode 100644 index 00000000..73700faf --- /dev/null +++ b/api/src/models/entity_def_new.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDefNew { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "color", skip_serializing_if = "Option::is_none")] + pub color: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "inherits_from")] + pub inherits_from: Box, + #[serde(rename = "trainable")] + pub trainable: bool, + #[serde(rename = "rules", skip_serializing_if = "Option::is_none")] + pub rules: Option>, + #[serde(rename = "_entity_def_flags", skip_serializing_if = "Option::is_none")] + pub _entity_def_flags: Option>, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl EntityDefNew { + pub fn new(name: String, title: String, inherits_from: models::InheritsFrom, trainable: bool) -> EntityDefNew { + EntityDefNew { + id: None, + color: None, + name, + title, + inherits_from: Box::new(inherits_from), + trainable, + rules: None, + _entity_def_flags: None, + instructions: None, + } + } +} + diff --git a/api/src/models/entity_def_summary.rs b/api/src/models/entity_def_summary.rs new file mode 100644 index 00000000..7f519a05 --- /dev/null +++ b/api/src/models/entity_def_summary.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDefSummary { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "health", skip_serializing_if = "Option::is_none")] + pub health: Option>, + /// Total number of assigned entities (with no filter) of this type in the dataset + #[serde(rename = "unfiltered_assigned")] + pub unfiltered_assigned: i32, +} + +impl EntityDefSummary { + pub fn new(id: String, unfiltered_assigned: i32) -> EntityDefSummary { + EntityDefSummary { + id, + health: None, + unfiltered_assigned, + } + } +} + diff --git a/api/src/models/entity_def_update.rs b/api/src/models/entity_def_update.rs new file mode 100644 index 00000000..3243db88 --- /dev/null +++ b/api/src/models/entity_def_update.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDefUpdate { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "color", skip_serializing_if = "Option::is_none")] + pub color: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "inherits_from")] + pub inherits_from: Vec, + #[serde(rename = "trainable")] + pub trainable: bool, + #[serde(rename = "rules", skip_serializing_if = "Option::is_none")] + pub rules: Option>, + #[serde(rename = "_entity_def_flags", skip_serializing_if = "Option::is_none")] + pub _entity_def_flags: Option>, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl EntityDefUpdate { + pub fn new(id: String, name: String, title: String, inherits_from: Vec, trainable: bool) -> EntityDefUpdate { + EntityDefUpdate { + id, + color: None, + name, + title, + inherits_from, + trainable, + rules: None, + _entity_def_flags: None, + instructions: None, + } + } +} + diff --git a/api/src/models/entity_def_update_inherits_from_inner.rs b/api/src/models/entity_def_update_inherits_from_inner.rs new file mode 100644 index 00000000..e833ce8f --- /dev/null +++ b/api/src/models/entity_def_update_inherits_from_inner.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityDefUpdateInheritsFromInner { +} + +impl EntityDefUpdateInheritsFromInner { + pub fn new() -> EntityDefUpdateInheritsFromInner { + EntityDefUpdateInheritsFromInner { + } + } +} + diff --git a/api/src/models/entity_health.rs b/api/src/models/entity_health.rs new file mode 100644 index 00000000..7079042a --- /dev/null +++ b/api/src/models/entity_health.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityHealth { + #[serde(rename = "need_pinned", skip_serializing_if = "Option::is_none")] + pub need_pinned: Option, + #[serde(rename = "need_pinned_increment", skip_serializing_if = "Option::is_none")] + pub need_pinned_increment: Option, + #[serde(rename = "smart", deserialize_with = "Option::deserialize")] + pub smart: Option>, +} + +impl EntityHealth { + pub fn new(smart: Option) -> EntityHealth { + EntityHealth { + need_pinned: None, + need_pinned_increment: None, + smart: smart.map(Box::new), + } + } +} + diff --git a/api/src/models/entity_health_action.rs b/api/src/models/entity_health_action.rs new file mode 100644 index 00000000..3540ea1b --- /dev/null +++ b/api/src/models/entity_health_action.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityHealthAction { + #[serde(rename = "kind")] + pub kind: models::EntityHealthActionKind, +} + +impl EntityHealthAction { + pub fn new(kind: models::EntityHealthActionKind) -> EntityHealthAction { + EntityHealthAction { + kind, + } + } +} + diff --git a/api/src/models/entity_health_action_kind.rs b/api/src/models/entity_health_action_kind.rs new file mode 100644 index 00000000..4e7c5a7d --- /dev/null +++ b/api/src/models/entity_health_action_kind.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// EntityHealthActionKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum EntityHealthActionKind { + #[serde(rename = "teach")] + Teach, + #[serde(rename = "correct_entity")] + CorrectEntity, + #[serde(rename = "missing_entity")] + MissingEntity, + #[serde(rename = "shuffle_filter")] + ShuffleFilter, + +} + +impl std::fmt::Display for EntityHealthActionKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Teach => write!(f, "teach"), + Self::CorrectEntity => write!(f, "correct_entity"), + Self::MissingEntity => write!(f, "missing_entity"), + Self::ShuffleFilter => write!(f, "shuffle_filter"), + } + } +} + +impl Default for EntityHealthActionKind { + fn default() -> EntityHealthActionKind { + Self::Teach + } +} + diff --git a/api/src/models/entity_health_smart.rs b/api/src/models/entity_health_smart.rs new file mode 100644 index 00000000..8ae43fa5 --- /dev/null +++ b/api/src/models/entity_health_smart.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityHealthSmart { + #[serde(rename = "score")] + pub score: f64, + #[serde(rename = "warnings")] + pub warnings: Vec, + #[serde(rename = "actions")] + pub actions: Vec, +} + +impl EntityHealthSmart { + pub fn new(score: f64, warnings: Vec, actions: Vec) -> EntityHealthSmart { + EntityHealthSmart { + score, + warnings, + actions, + } + } +} + diff --git a/api/src/models/entity_health_warning.rs b/api/src/models/entity_health_warning.rs new file mode 100644 index 00000000..200effcf --- /dev/null +++ b/api/src/models/entity_health_warning.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityHealthWarning { + #[serde(rename = "kind")] + pub kind: models::EntityHealthWarningKind, +} + +impl EntityHealthWarning { + pub fn new(kind: models::EntityHealthWarningKind) -> EntityHealthWarning { + EntityHealthWarning { + kind, + } + } +} + diff --git a/api/src/models/entity_health_warning_kind.rs b/api/src/models/entity_health_warning_kind.rs new file mode 100644 index 00000000..aa4555c5 --- /dev/null +++ b/api/src/models/entity_health_warning_kind.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// EntityHealthWarningKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum EntityHealthWarningKind { + #[serde(rename = "low_reviewed_comments")] + LowReviewedComments, + #[serde(rename = "low_f1_score")] + LowF1Score, + #[serde(rename = "very_low_reviewed_comments")] + VeryLowReviewedComments, + #[serde(rename = "very_low_f1_score")] + VeryLowF1Score, + +} + +impl std::fmt::Display for EntityHealthWarningKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::LowReviewedComments => write!(f, "low_reviewed_comments"), + Self::LowF1Score => write!(f, "low_f1_score"), + Self::VeryLowReviewedComments => write!(f, "very_low_reviewed_comments"), + Self::VeryLowF1Score => write!(f, "very_low_f1_score"), + } + } +} + +impl Default for EntityHealthWarningKind { + fn default() -> EntityHealthWarningKind { + Self::LowReviewedComments + } +} + diff --git a/api/src/models/entity_kind.rs b/api/src/models/entity_kind.rs new file mode 100644 index 00000000..4652b1ec --- /dev/null +++ b/api/src/models/entity_kind.rs @@ -0,0 +1,237 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// EntityKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum EntityKind { + #[serde(rename = "beazley_claim_reference")] + BeazleyClaimReference, + #[serde(rename = "beazley_policy_number")] + BeazleyPolicyNumber, + #[serde(rename = "bic")] + Bic, + #[serde(rename = "broker_name")] + BrokerName, + #[serde(rename = "broker_number")] + BrokerNumber, + #[serde(rename = "cancellation_date")] + CancellationDate, + #[serde(rename = "cconsol")] + Cconsol, + #[serde(rename = "client_system_id")] + ClientSystemId, + #[serde(rename = "colt_bcn")] + ColtBcn, + #[serde(rename = "colt_invoice_number")] + ColtInvoiceNumber, + #[serde(rename = "colt_ocn")] + ColtOcn, + #[serde(rename = "colt_premises_number")] + ColtPremisesNumber, + #[serde(rename = "coma")] + Coma, + #[serde(rename = "country")] + Country, + #[serde(rename = "currency")] + Currency, + #[serde(rename = "cusip")] + Cusip, + #[serde(rename = "date")] + Date, + #[serde(rename = "db_cinq_id")] + DbCinqId, + #[serde(rename = "db_css_ticket")] + DbCssTicket, + #[serde(rename = "db_domain_id")] + DbDomainId, + #[serde(rename = "db_market_reference")] + DbMarketReference, + #[serde(rename = "db_nominal_quantity")] + DbNominalQuantity, + #[serde(rename = "db_system_name")] + DbSystemName, + #[serde(rename = "db_trade_reference")] + DbTradeReference, + #[serde(rename = "demo_location")] + DemoLocation, + #[serde(rename = "demo_order_number")] + DemoOrderNumber, + #[serde(rename = "email")] + Email, + #[serde(rename = "email_address")] + EmailAddress, + #[serde(rename = "hiscox_apc_policy_number")] + HiscoxApcPolicyNumber, + #[serde(rename = "hiscox_broker_number_de")] + HiscoxBrokerNumberDe, + #[serde(rename = "hiscox_broker_number_fr")] + HiscoxBrokerNumberFr, + #[serde(rename = "hiscox_policy_number_de")] + HiscoxPolicyNumberDe, + #[serde(rename = "hiscox_policy_number_fr")] + HiscoxPolicyNumberFr, + #[serde(rename = "hiscox_quote_number_de")] + HiscoxQuoteNumberDe, + #[serde(rename = "hiscox_quote_number_fr")] + HiscoxQuoteNumberFr, + #[serde(rename = "insured_name")] + InsuredName, + #[serde(rename = "isin")] + Isin, + #[serde(rename = "jpm_trade_id")] + JpmTradeId, + #[serde(rename = "lei")] + Lei, + #[serde(rename = "money")] + Money, + #[serde(rename = "mtm")] + Mtm, + #[serde(rename = "extraction_number")] + ExtractionNumber, + #[serde(rename = "extraction_boolean")] + ExtractionBoolean, + #[serde(rename = "extraction_choice")] + ExtractionChoice, + #[serde(rename = "numeral")] + Numeral, + #[serde(rename = "nwm_netting_rpa_unique_id")] + NwmNettingRpaUniqueId, + #[serde(rename = "nwm_netting_rpa_value_date")] + NwmNettingRpaValueDate, + #[serde(rename = "org")] + Org, + #[serde(rename = "person")] + Person, + #[serde(rename = "policy_number")] + PolicyNumber, + #[serde(rename = "reinfer_dev_email_end")] + ReinferDevEmailEnd, + #[serde(rename = "rxm")] + Rxm, + #[serde(rename = "sedol")] + Sedol, + #[serde(rename = "thames_water_meter_reading")] + ThamesWaterMeterReading, + #[serde(rename = "topco_po_number")] + TopcoPoNumber, + #[serde(rename = "topco_quantity_with_unit")] + TopcoQuantityWithUnit, + #[serde(rename = "topco_upc_number")] + TopcoUpcNumber, + #[serde(rename = "trade_id")] + TradeId, + #[serde(rename = "turnover")] + Turnover, + #[serde(rename = "ubs_authsso_login")] + UbsAuthssoLogin, + #[serde(rename = "ubs_collateral_synthetic_id")] + UbsCollateralSyntheticId, + #[serde(rename = "ubs_dcs_building_code")] + UbsDcsBuildingCode, + #[serde(rename = "ubs_mirror_id")] + UbsMirrorId, + #[serde(rename = "ubs_userclass")] + UbsUserclass, + #[serde(rename = "uk_postcode")] + UkPostcode, + #[serde(rename = "url")] + Url, + #[serde(rename = "us_state")] + UsState, + #[serde(rename = "value_date")] + ValueDate, + +} + +impl std::fmt::Display for EntityKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::BeazleyClaimReference => write!(f, "beazley_claim_reference"), + Self::BeazleyPolicyNumber => write!(f, "beazley_policy_number"), + Self::Bic => write!(f, "bic"), + Self::BrokerName => write!(f, "broker_name"), + Self::BrokerNumber => write!(f, "broker_number"), + Self::CancellationDate => write!(f, "cancellation_date"), + Self::Cconsol => write!(f, "cconsol"), + Self::ClientSystemId => write!(f, "client_system_id"), + Self::ColtBcn => write!(f, "colt_bcn"), + Self::ColtInvoiceNumber => write!(f, "colt_invoice_number"), + Self::ColtOcn => write!(f, "colt_ocn"), + Self::ColtPremisesNumber => write!(f, "colt_premises_number"), + Self::Coma => write!(f, "coma"), + Self::Country => write!(f, "country"), + Self::Currency => write!(f, "currency"), + Self::Cusip => write!(f, "cusip"), + Self::Date => write!(f, "date"), + Self::DbCinqId => write!(f, "db_cinq_id"), + Self::DbCssTicket => write!(f, "db_css_ticket"), + Self::DbDomainId => write!(f, "db_domain_id"), + Self::DbMarketReference => write!(f, "db_market_reference"), + Self::DbNominalQuantity => write!(f, "db_nominal_quantity"), + Self::DbSystemName => write!(f, "db_system_name"), + Self::DbTradeReference => write!(f, "db_trade_reference"), + Self::DemoLocation => write!(f, "demo_location"), + Self::DemoOrderNumber => write!(f, "demo_order_number"), + Self::Email => write!(f, "email"), + Self::EmailAddress => write!(f, "email_address"), + Self::HiscoxApcPolicyNumber => write!(f, "hiscox_apc_policy_number"), + Self::HiscoxBrokerNumberDe => write!(f, "hiscox_broker_number_de"), + Self::HiscoxBrokerNumberFr => write!(f, "hiscox_broker_number_fr"), + Self::HiscoxPolicyNumberDe => write!(f, "hiscox_policy_number_de"), + Self::HiscoxPolicyNumberFr => write!(f, "hiscox_policy_number_fr"), + Self::HiscoxQuoteNumberDe => write!(f, "hiscox_quote_number_de"), + Self::HiscoxQuoteNumberFr => write!(f, "hiscox_quote_number_fr"), + Self::InsuredName => write!(f, "insured_name"), + Self::Isin => write!(f, "isin"), + Self::JpmTradeId => write!(f, "jpm_trade_id"), + Self::Lei => write!(f, "lei"), + Self::Money => write!(f, "money"), + Self::Mtm => write!(f, "mtm"), + Self::ExtractionNumber => write!(f, "extraction_number"), + Self::ExtractionBoolean => write!(f, "extraction_boolean"), + Self::ExtractionChoice => write!(f, "extraction_choice"), + Self::Numeral => write!(f, "numeral"), + Self::NwmNettingRpaUniqueId => write!(f, "nwm_netting_rpa_unique_id"), + Self::NwmNettingRpaValueDate => write!(f, "nwm_netting_rpa_value_date"), + Self::Org => write!(f, "org"), + Self::Person => write!(f, "person"), + Self::PolicyNumber => write!(f, "policy_number"), + Self::ReinferDevEmailEnd => write!(f, "reinfer_dev_email_end"), + Self::Rxm => write!(f, "rxm"), + Self::Sedol => write!(f, "sedol"), + Self::ThamesWaterMeterReading => write!(f, "thames_water_meter_reading"), + Self::TopcoPoNumber => write!(f, "topco_po_number"), + Self::TopcoQuantityWithUnit => write!(f, "topco_quantity_with_unit"), + Self::TopcoUpcNumber => write!(f, "topco_upc_number"), + Self::TradeId => write!(f, "trade_id"), + Self::Turnover => write!(f, "turnover"), + Self::UbsAuthssoLogin => write!(f, "ubs_authsso_login"), + Self::UbsCollateralSyntheticId => write!(f, "ubs_collateral_synthetic_id"), + Self::UbsDcsBuildingCode => write!(f, "ubs_dcs_building_code"), + Self::UbsMirrorId => write!(f, "ubs_mirror_id"), + Self::UbsUserclass => write!(f, "ubs_userclass"), + Self::UkPostcode => write!(f, "uk_postcode"), + Self::Url => write!(f, "url"), + Self::UsState => write!(f, "us_state"), + Self::ValueDate => write!(f, "value_date"), + } + } +} + +impl Default for EntityKind { + fn default() -> EntityKind { + Self::BeazleyClaimReference + } +} + diff --git a/api/src/models/entity_new.rs b/api/src/models/entity_new.rs new file mode 100644 index 00000000..eb8b5be5 --- /dev/null +++ b/api/src/models/entity_new.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityNew { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + #[serde(rename = "spans", skip_serializing_if = "Option::is_none")] + pub spans: Option>, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "field_id", skip_serializing_if = "Option::is_none")] + pub field_id: Option, +} + +impl EntityNew { + pub fn new(formatted_value: String) -> EntityNew { + EntityNew { + id: None, + name: None, + kind: None, + span: None, + spans: None, + formatted_value, + field_id: None, + } + } +} + diff --git a/api/src/models/entity_new_spans_inner.rs b/api/src/models/entity_new_spans_inner.rs new file mode 100644 index 00000000..ac9855e7 --- /dev/null +++ b/api/src/models/entity_new_spans_inner.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityNewSpansInner { + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, + #[serde(rename = "char_start")] + pub char_start: i32, + #[serde(rename = "char_end")] + pub char_end: i32, +} + +impl EntityNewSpansInner { + pub fn new(content_part: models::ContentPart, message_index: i32, utf16_byte_start: i32, utf16_byte_end: i32, char_start: i32, char_end: i32) -> EntityNewSpansInner { + EntityNewSpansInner { + content_part, + message_index, + utf16_byte_start, + utf16_byte_end, + char_start, + char_end, + } + } +} + diff --git a/api/src/models/entity_presence_filter.rs b/api/src/models/entity_presence_filter.rs new file mode 100644 index 00000000..ae3993ee --- /dev/null +++ b/api/src/models/entity_presence_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityPresenceFilter { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "rule")] + pub rule: String, +} + +impl EntityPresenceFilter { + pub fn new(id: String, rule: String) -> EntityPresenceFilter { + EntityPresenceFilter { + id, + rule, + } + } +} + diff --git a/api/src/models/entity_presence_filter_with_kind.rs b/api/src/models/entity_presence_filter_with_kind.rs new file mode 100644 index 00000000..ba5d6543 --- /dev/null +++ b/api/src/models/entity_presence_filter_with_kind.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityPresenceFilterWithKind { + #[serde(rename = "kind")] + pub kind: String, + #[serde(rename = "rule")] + pub rule: String, +} + +impl EntityPresenceFilterWithKind { + pub fn new(kind: String, rule: String) -> EntityPresenceFilterWithKind { + EntityPresenceFilterWithKind { + kind, + rule, + } + } +} + diff --git a/api/src/models/entity_rule_set_api.rs b/api/src/models/entity_rule_set_api.rs new file mode 100644 index 00000000..ac1bb498 --- /dev/null +++ b/api/src/models/entity_rule_set_api.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityRuleSetApi { + #[serde(rename = "suppressors", skip_serializing_if = "Option::is_none")] + pub suppressors: Option>, + #[serde(rename = "choices", skip_serializing_if = "Option::is_none")] + pub choices: Option>, + #[serde(rename = "regex", deserialize_with = "Option::deserialize")] + pub regex: Option>, +} + +impl EntityRuleSetApi { + pub fn new(regex: Option) -> EntityRuleSetApi { + EntityRuleSetApi { + suppressors: None, + choices: None, + regex: regex.map(Box::new), + } + } +} + diff --git a/api/src/models/entity_rule_set_new_api.rs b/api/src/models/entity_rule_set_new_api.rs new file mode 100644 index 00000000..42ea0586 --- /dev/null +++ b/api/src/models/entity_rule_set_new_api.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityRuleSetNewApi { + #[serde(rename = "suppressors", skip_serializing_if = "Option::is_none")] + pub suppressors: Option>, + #[serde(rename = "choices", skip_serializing_if = "Option::is_none")] + pub choices: Option>, + #[serde(rename = "regex", deserialize_with = "Option::deserialize")] + pub regex: Option>, +} + +impl EntityRuleSetNewApi { + pub fn new(regex: Option) -> EntityRuleSetNewApi { + EntityRuleSetNewApi { + suppressors: None, + choices: None, + regex: regex.map(Box::new), + } + } +} + diff --git a/api/src/models/entity_rule_set_update_api.rs b/api/src/models/entity_rule_set_update_api.rs new file mode 100644 index 00000000..7a90d876 --- /dev/null +++ b/api/src/models/entity_rule_set_update_api.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityRuleSetUpdateApi { + #[serde(rename = "suppressors", skip_serializing_if = "Option::is_none")] + pub suppressors: Option>, + #[serde(rename = "choices", skip_serializing_if = "Option::is_none")] + pub choices: Option>, + #[serde(rename = "regex", deserialize_with = "Option::deserialize")] + pub regex: Option>, +} + +impl EntityRuleSetUpdateApi { + pub fn new(regex: Option) -> EntityRuleSetUpdateApi { + EntityRuleSetUpdateApi { + suppressors: None, + choices: None, + regex: regex.map(Box::new), + } + } +} + diff --git a/api/src/models/entity_rule_set_update_api_choices_inner.rs b/api/src/models/entity_rule_set_update_api_choices_inner.rs new file mode 100644 index 00000000..3d5b9725 --- /dev/null +++ b/api/src/models/entity_rule_set_update_api_choices_inner.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityRuleSetUpdateApiChoicesInner { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "values")] + pub values: Vec, +} + +impl EntityRuleSetUpdateApiChoicesInner { + pub fn new(id: String, name: String, values: Vec) -> EntityRuleSetUpdateApiChoicesInner { + EntityRuleSetUpdateApiChoicesInner { + id, + name, + values, + } + } +} + diff --git a/api/src/models/entity_template_properties_api.rs b/api/src/models/entity_template_properties_api.rs new file mode 100644 index 00000000..f8d7b1e4 --- /dev/null +++ b/api/src/models/entity_template_properties_api.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityTemplatePropertiesApi { + #[serde(rename = "template")] + pub template: String, + #[serde(rename = "pattern")] + pub pattern: String, +} + +impl EntityTemplatePropertiesApi { + pub fn new(template: String, pattern: String) -> EntityTemplatePropertiesApi { + EntityTemplatePropertiesApi { + template, + pattern, + } + } +} + diff --git a/api/src/models/entity_templates_properties_api.rs b/api/src/models/entity_templates_properties_api.rs new file mode 100644 index 00000000..f77f379f --- /dev/null +++ b/api/src/models/entity_templates_properties_api.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EntityTemplatesPropertiesApi { + #[serde(rename = "templates")] + pub templates: Vec, +} + +impl EntityTemplatesPropertiesApi { + pub fn new(templates: Vec) -> EntityTemplatesPropertiesApi { + EntityTemplatesPropertiesApi { + templates, + } + } +} + diff --git a/api/src/models/error_action.rs b/api/src/models/error_action.rs new file mode 100644 index 00000000..c99b11f1 --- /dev/null +++ b/api/src/models/error_action.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ErrorAction : The action take in response to the server error +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ErrorAction { + /// An identifier/type discriminator for the action taken in response to the server error + #[serde(rename = "kind")] + pub kind: Kind, + /// Email address for the mailbox that has been disabled + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + /// Unique ID of the bucket where the mailbox was syncing + #[serde(rename = "bucket_id")] + pub bucket_id: String, +} + +impl ErrorAction { + /// The action take in response to the server error + pub fn new(kind: Kind, mailbox_name: String, bucket_id: String) -> ErrorAction { + ErrorAction { + kind, + mailbox_name, + bucket_id, + } + } +} +/// An identifier/type discriminator for the action taken in response to the server error +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "mailbox_disabled")] + MailboxDisabled, +} + +impl Default for Kind { + fn default() -> Kind { + Self::MailboxDisabled + } +} + diff --git a/api/src/models/error_response.rs b/api/src/models/error_response.rs new file mode 100644 index 00000000..238e3b71 --- /dev/null +++ b/api/src/models/error_response.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ErrorResponse { + #[serde(rename = "message")] + pub message: String, + #[serde(rename = "status")] + pub status: models::ResponseStatusError, +} + +impl ErrorResponse { + pub fn new(message: String, status: models::ResponseStatusError) -> ErrorResponse { + ErrorResponse { + message, + status, + } + } +} + diff --git a/api/src/models/ews_api_model.rs b/api/src/models/ews_api_model.rs new file mode 100644 index 00000000..e3bee648 --- /dev/null +++ b/api/src/models/ews_api_model.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct EwsApiModel { + #[serde(rename = "kind")] + pub kind: models::EwsApiModelKind, +} + +impl EwsApiModel { + pub fn new(kind: models::EwsApiModelKind) -> EwsApiModel { + EwsApiModel { + kind, + } + } +} + diff --git a/api/src/models/ews_api_model_kind.rs b/api/src/models/ews_api_model_kind.rs new file mode 100644 index 00000000..ed2c1ccc --- /dev/null +++ b/api/src/models/ews_api_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// EwsApiModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum EwsApiModelKind { + #[serde(rename = "ews")] + Ews, + +} + +impl std::fmt::Display for EwsApiModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Ews => write!(f, "ews"), + } + } +} + +impl Default for EwsApiModelKind { + fn default() -> EwsApiModelKind { + Self::Ews + } +} + diff --git a/api/src/models/exception_model.rs b/api/src/models/exception_model.rs new file mode 100644 index 00000000..8632200c --- /dev/null +++ b/api/src/models/exception_model.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExceptionModel { + #[serde(rename = "uid")] + pub uid: String, + #[serde(rename = "metadata")] + pub metadata: Box, +} + +impl ExceptionModel { + pub fn new(uid: String, metadata: models::Metadata) -> ExceptionModel { + ExceptionModel { + uid, + metadata: Box::new(metadata), + } + } +} + diff --git a/api/src/models/export_dataset_request.rs b/api/src/models/export_dataset_request.rs new file mode 100644 index 00000000..bb452e46 --- /dev/null +++ b/api/src/models/export_dataset_request.rs @@ -0,0 +1,58 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportDatasetRequest { + #[serde(rename = "comment_uids", skip_serializing_if = "Option::is_none")] + pub comment_uids: Option>, + #[serde(rename = "source_ids", skip_serializing_if = "Option::is_none")] + pub source_ids: Option>, + #[serde(rename = "from", skip_serializing_if = "Option::is_none")] + pub from: Option, + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, + #[serde(rename = "order_by", skip_serializing_if = "Option::is_none")] + pub order_by: Option, + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, +} + +impl ExportDatasetRequest { + pub fn new() -> ExportDatasetRequest { + ExportDatasetRequest { + comment_uids: None, + source_ids: None, + from: None, + to: None, + continuation: None, + order_by: None, + limit: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum OrderBy { + #[serde(rename = "timestamp")] + Timestamp, + #[serde(rename = "created_at")] + CreatedAt, +} + +impl Default for OrderBy { + fn default() -> OrderBy { + Self::Timestamp + } +} + diff --git a/api/src/models/export_dataset_response.rs b/api/src/models/export_dataset_response.rs new file mode 100644 index 00000000..a1ca5810 --- /dev/null +++ b/api/src/models/export_dataset_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "comments")] + pub comments: Vec, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl ExportDatasetResponse { + pub fn new(status: Status, comments: Vec) -> ExportDatasetResponse { + ExportDatasetResponse { + status, + comments, + continuation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/exported_annotations.rs b/api/src/models/exported_annotations.rs new file mode 100644 index 00000000..df74d4b7 --- /dev/null +++ b/api/src/models/exported_annotations.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportedAnnotations { + #[serde(rename = "labels")] + pub labels: Box, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, +} + +impl ExportedAnnotations { + pub fn new(labels: models::ExportedLabels) -> ExportedAnnotations { + ExportedAnnotations { + labels: Box::new(labels), + sentiment: None, + } + } +} + diff --git a/api/src/models/exported_comment.rs b/api/src/models/exported_comment.rs new file mode 100644 index 00000000..20c31f98 --- /dev/null +++ b/api/src/models/exported_comment.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportedComment { + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "annotations")] + pub annotations: Box, + #[serde(rename = "predictions")] + pub predictions: Box, + #[serde(rename = "thread_properties", skip_serializing_if = "Option::is_none")] + pub thread_properties: Option>, +} + +impl ExportedComment { + pub fn new(comment: models::Comment, annotations: models::ExportedAnnotations, predictions: models::ExportedPredictions) -> ExportedComment { + ExportedComment { + comment: Box::new(comment), + annotations: Box::new(annotations), + predictions: Box::new(predictions), + thread_properties: None, + } + } +} + diff --git a/api/src/models/exported_label.rs b/api/src/models/exported_label.rs new file mode 100644 index 00000000..1d7120c0 --- /dev/null +++ b/api/src/models/exported_label.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportedLabel { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")] + pub metadata: Option>, +} + +impl ExportedLabel { + pub fn new(name: String) -> ExportedLabel { + ExportedLabel { + name, + sentiment: None, + instructions: None, + metadata: None, + } + } +} + diff --git a/api/src/models/exported_labels.rs b/api/src/models/exported_labels.rs new file mode 100644 index 00000000..688028d2 --- /dev/null +++ b/api/src/models/exported_labels.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportedLabels { + #[serde(rename = "assigned")] + pub assigned: Vec, +} + +impl ExportedLabels { + pub fn new(assigned: Vec) -> ExportedLabels { + ExportedLabels { + assigned, + } + } +} + diff --git a/api/src/models/exported_predictions.rs b/api/src/models/exported_predictions.rs new file mode 100644 index 00000000..08111128 --- /dev/null +++ b/api/src/models/exported_predictions.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExportedPredictions { + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, +} + +impl ExportedPredictions { + pub fn new(labels: Vec) -> ExportedPredictions { + ExportedPredictions { + labels, + sentiment: None, + } + } +} + diff --git a/api/src/models/extraction_field_definition.rs b/api/src/models/extraction_field_definition.rs new file mode 100644 index 00000000..23d26724 --- /dev/null +++ b/api/src/models/extraction_field_definition.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExtractionFieldDefinition { + /// Unique identifier for the field + #[serde(rename = "field_id")] + pub field_id: String, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub instructions: Option>, +} + +impl ExtractionFieldDefinition { + pub fn new(field_id: String, field_type_id: String, name: String) -> ExtractionFieldDefinition { + ExtractionFieldDefinition { + field_id, + field_type_id, + name, + instructions: None, + } + } +} + diff --git a/api/src/models/extraction_prediction.rs b/api/src/models/extraction_prediction.rs new file mode 100644 index 00000000..4a8625c4 --- /dev/null +++ b/api/src/models/extraction_prediction.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ExtractionPrediction { + #[serde(rename = "label", deserialize_with = "Option::deserialize")] + pub label: Option>, + #[serde(rename = "captures")] + pub captures: Vec, +} + +impl ExtractionPrediction { + pub fn new(label: Option, captures: Vec) -> ExtractionPrediction { + ExtractionPrediction { + label: label.map(Box::new), + captures, + } + } +} + diff --git a/api/src/models/fetch_from_gx_stream_request.rs b/api/src/models/fetch_from_gx_stream_request.rs new file mode 100644 index 00000000..407e2a33 --- /dev/null +++ b/api/src/models/fetch_from_gx_stream_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FetchFromGxStreamRequest { + /// The number of comments to fetch from this trigger + #[serde(rename = "size")] + pub size: i32, + /// How many comments to skip if they don't match the trigger's comment filter + #[serde(rename = "max_filtered", skip_serializing_if = "Option::is_none")] + pub max_filtered: Option, +} + +impl FetchFromGxStreamRequest { + pub fn new(size: i32) -> FetchFromGxStreamRequest { + FetchFromGxStreamRequest { + size, + max_filtered: None, + } + } +} + diff --git a/api/src/models/fetch_from_gx_stream_response.rs b/api/src/models/fetch_from_gx_stream_response.rs new file mode 100644 index 00000000..3057f878 --- /dev/null +++ b/api/src/models/fetch_from_gx_stream_response.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FetchFromGxStreamResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "filtered")] + pub filtered: i32, + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl FetchFromGxStreamResponse { + pub fn new(status: Status, results: Vec, filtered: i32, sequence_id: String) -> FetchFromGxStreamResponse { + FetchFromGxStreamResponse { + status, + results, + filtered, + sequence_id, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/fetch_from_stream_request.rs b/api/src/models/fetch_from_stream_request.rs new file mode 100644 index 00000000..b22294b4 --- /dev/null +++ b/api/src/models/fetch_from_stream_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FetchFromStreamRequest { + /// The number of comments to fetch from this trigger + #[serde(rename = "size")] + pub size: i32, + /// How many comments to skip if they don't match the trigger's comment filter + #[serde(rename = "max_filtered", skip_serializing_if = "Option::is_none")] + pub max_filtered: Option, +} + +impl FetchFromStreamRequest { + pub fn new(size: i32) -> FetchFromStreamRequest { + FetchFromStreamRequest { + size, + max_filtered: None, + } + } +} + diff --git a/api/src/models/fetch_from_stream_response.rs b/api/src/models/fetch_from_stream_response.rs new file mode 100644 index 00000000..36591beb --- /dev/null +++ b/api/src/models/fetch_from_stream_response.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FetchFromStreamResponse { + #[serde(rename = "status")] + pub status: Status, + /// How many comments were skipped + #[serde(rename = "filtered")] + pub filtered: i32, + #[serde(rename = "sequence_id")] + pub sequence_id: String, + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "is_end_sequence")] + pub is_end_sequence: bool, +} + +impl FetchFromStreamResponse { + pub fn new(status: Status, filtered: i32, sequence_id: String, results: Vec, is_end_sequence: bool) -> FetchFromStreamResponse { + FetchFromStreamResponse { + status, + filtered, + sequence_id, + results, + is_end_sequence, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/field_annotation_private.rs b/api/src/models/field_annotation_private.rs new file mode 100644 index 00000000..890756af --- /dev/null +++ b/api/src/models/field_annotation_private.rs @@ -0,0 +1,43 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldAnnotationPrivate { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "text_spans")] + pub text_spans: Vec, + #[serde(rename = "document_spans")] + pub document_spans: Vec, + #[serde(rename = "value", deserialize_with = "Option::deserialize")] + pub value: Option>, + /// Whether the field is confirmed + #[serde(rename = "confirmed", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub confirmed: Option>, +} + +impl FieldAnnotationPrivate { + pub fn new(name: String, id: String, text_spans: Vec, document_spans: Vec, value: Option) -> FieldAnnotationPrivate { + FieldAnnotationPrivate { + name, + id, + text_spans, + document_spans, + value: value.map(Box::new), + confirmed: None, + } + } +} + diff --git a/api/src/models/field_choice_api.rs b/api/src/models/field_choice_api.rs new file mode 100644 index 00000000..5934130e --- /dev/null +++ b/api/src/models/field_choice_api.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldChoiceApi { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "values")] + pub values: Vec, +} + +impl FieldChoiceApi { + pub fn new(id: String, name: String, values: Vec) -> FieldChoiceApi { + FieldChoiceApi { + id, + name, + values, + } + } +} + diff --git a/api/src/models/field_choice_new_api.rs b/api/src/models/field_choice_new_api.rs new file mode 100644 index 00000000..870acf90 --- /dev/null +++ b/api/src/models/field_choice_new_api.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldChoiceNewApi { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "values")] + pub values: Vec, +} + +impl FieldChoiceNewApi { + pub fn new(name: String, values: Vec) -> FieldChoiceNewApi { + FieldChoiceNewApi { + id: None, + name, + values, + } + } +} + diff --git a/api/src/models/field_group_annotation_private.rs b/api/src/models/field_group_annotation_private.rs new file mode 100644 index 00000000..bf27851f --- /dev/null +++ b/api/src/models/field_group_annotation_private.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldGroupAnnotationPrivate { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl FieldGroupAnnotationPrivate { + pub fn new(name: String, fields: Vec) -> FieldGroupAnnotationPrivate { + FieldGroupAnnotationPrivate { + name, + id: None, + fields, + } + } +} + diff --git a/api/src/models/field_group_prediction_private.rs b/api/src/models/field_group_prediction_private.rs new file mode 100644 index 00000000..2c50d322 --- /dev/null +++ b/api/src/models/field_group_prediction_private.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldGroupPredictionPrivate { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "occurrence_confidence")] + pub occurrence_confidence: Box, + #[serde(rename = "extraction_confidence")] + pub extraction_confidence: Box, + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl FieldGroupPredictionPrivate { + pub fn new(name: String, occurrence_confidence: models::IxpConfidence, extraction_confidence: models::IxpConfidence, fields: Vec) -> FieldGroupPredictionPrivate { + FieldGroupPredictionPrivate { + name, + id: None, + occurrence_confidence: Box::new(occurrence_confidence), + extraction_confidence: Box::new(extraction_confidence), + fields, + } + } +} + diff --git a/api/src/models/field_group_snapshot.rs b/api/src/models/field_group_snapshot.rs new file mode 100644 index 00000000..108da97d --- /dev/null +++ b/api/src/models/field_group_snapshot.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// FieldGroupSnapshot : Snapshot of a field group at a specific model version +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldGroupSnapshot { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + /// List of field IDs in this field group + #[serde(rename = "field_ids")] + pub field_ids: Vec, +} + +impl FieldGroupSnapshot { + /// Snapshot of a field group at a specific model version + pub fn new(name: String, field_ids: Vec) -> FieldGroupSnapshot { + FieldGroupSnapshot { + name, + instructions: None, + field_ids, + } + } +} + diff --git a/api/src/models/field_group_version_entry.rs b/api/src/models/field_group_version_entry.rs new file mode 100644 index 00000000..0a70d825 --- /dev/null +++ b/api/src/models/field_group_version_entry.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// FieldGroupVersionEntry : A single version entry in field group history +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldGroupVersionEntry { + /// Model version number + #[serde(rename = "model_version")] + pub model_version: i32, + /// When this version was saved + #[serde(rename = "timestamp")] + pub timestamp: String, + /// Snapshot of the field group at this version + #[serde(rename = "snapshot")] + pub snapshot: Box, +} + +impl FieldGroupVersionEntry { + /// A single version entry in field group history + pub fn new(model_version: i32, timestamp: String, snapshot: models::FieldGroupSnapshot) -> FieldGroupVersionEntry { + FieldGroupVersionEntry { + model_version, + timestamp, + snapshot: Box::new(snapshot), + } + } +} + diff --git a/api/src/models/field_prediction_private.rs b/api/src/models/field_prediction_private.rs new file mode 100644 index 00000000..f312f55e --- /dev/null +++ b/api/src/models/field_prediction_private.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldPredictionPrivate { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "confidence")] + pub confidence: Box, + #[serde(rename = "text_spans")] + pub text_spans: Vec, + #[serde(rename = "spans")] + pub spans: Vec, + #[serde(rename = "document_spans")] + pub document_spans: Vec, + #[serde(rename = "value", deserialize_with = "Option::deserialize")] + pub value: Option>, +} + +impl FieldPredictionPrivate { + pub fn new(name: String, id: String, confidence: models::IxpConfidence, text_spans: Vec, spans: Vec, document_spans: Vec, value: Option) -> FieldPredictionPrivate { + FieldPredictionPrivate { + name, + id, + confidence: Box::new(confidence), + text_spans, + spans, + document_spans, + value: value.map(Box::new), + } + } +} + diff --git a/api/src/models/field_snapshot.rs b/api/src/models/field_snapshot.rs new file mode 100644 index 00000000..08e9d44a --- /dev/null +++ b/api/src/models/field_snapshot.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// FieldSnapshot : Snapshot of a field at a specific model version +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldSnapshot { + /// ID of the field + #[serde(rename = "field_id")] + pub field_id: String, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl FieldSnapshot { + /// Snapshot of a field at a specific model version + pub fn new(field_id: String, field_type_id: String, name: String) -> FieldSnapshot { + FieldSnapshot { + field_id, + field_type_id, + name, + instructions: None, + } + } +} + diff --git a/api/src/models/field_type.rs b/api/src/models/field_type.rs new file mode 100644 index 00000000..7fa11dd7 --- /dev/null +++ b/api/src/models/field_type.rs @@ -0,0 +1,37 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldType { + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub instructions: Option>, + #[serde(rename = "data_type")] + pub data_type: Box, +} + +impl FieldType { + pub fn new(field_type_id: String, name: String, data_type: models::DataType) -> FieldType { + FieldType { + field_type_id, + name, + instructions: None, + data_type: Box::new(data_type), + } + } +} + diff --git a/api/src/models/field_uipath_context_model.rs b/api/src/models/field_uipath_context_model.rs new file mode 100644 index 00000000..30667850 --- /dev/null +++ b/api/src/models/field_uipath_context_model.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldUipathContextModel { + #[serde(rename = "account_id")] + pub account_id: String, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "environment_name")] + pub environment_name: String, +} + +impl FieldUipathContextModel { + pub fn new(account_id: String, tenant_id: String, environment_name: String) -> FieldUipathContextModel { + FieldUipathContextModel { + account_id, + tenant_id, + environment_name, + } + } +} + diff --git a/api/src/models/field_value_private.rs b/api/src/models/field_value_private.rs new file mode 100644 index 00000000..06555e40 --- /dev/null +++ b/api/src/models/field_value_private.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldValuePrivate { + #[serde(rename = "formatted")] + pub formatted: String, + #[serde(rename = "data")] + pub data: Box, +} + +impl FieldValuePrivate { + pub fn new(formatted: String, data: models::Data) -> FieldValuePrivate { + FieldValuePrivate { + formatted, + data: Box::new(data), + } + } +} + diff --git a/api/src/models/field_version_entry.rs b/api/src/models/field_version_entry.rs new file mode 100644 index 00000000..3a7a5689 --- /dev/null +++ b/api/src/models/field_version_entry.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// FieldVersionEntry : A single version entry in field history +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FieldVersionEntry { + /// Model version number + #[serde(rename = "model_version")] + pub model_version: i32, + /// When this version was saved + #[serde(rename = "timestamp")] + pub timestamp: String, + /// Snapshot of the field definition at this version + #[serde(rename = "snapshot")] + pub snapshot: Box, +} + +impl FieldVersionEntry { + /// A single version entry in field history + pub fn new(model_version: i32, timestamp: String, snapshot: models::FieldSnapshot) -> FieldVersionEntry { + FieldVersionEntry { + model_version, + timestamp, + snapshot: Box::new(snapshot), + } + } +} + diff --git a/api/src/models/filter.rs b/api/src/models/filter.rs new file mode 100644 index 00000000..42f78089 --- /dev/null +++ b/api/src/models/filter.rs @@ -0,0 +1,62 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Filter { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "any_of")] + pub any_of: Vec, + #[serde(rename = "none_of")] + pub none_of: Vec, + #[serde(rename = "minimum", skip_serializing_if = "Option::is_none")] + pub minimum: Option, + #[serde(rename = "maximum", skip_serializing_if = "Option::is_none")] + pub maximum: Option, + #[serde(rename = "any_assigned")] + pub any_assigned: Vec, + #[serde(rename = "any_predicted")] + pub any_predicted: Vec, + #[serde(rename = "none_present")] + pub none_present: Vec, + #[serde(rename = "query")] + pub query: String, +} + +impl Filter { + pub fn new(kind: Kind, any_of: Vec, none_of: Vec, any_assigned: Vec, any_predicted: Vec, none_present: Vec, query: String) -> Filter { + Filter { + kind, + any_of, + none_of, + minimum: None, + maximum: None, + any_assigned, + any_predicted, + none_present, + query, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "string_search")] + StringSearch, +} + +impl Default for Kind { + fn default() -> Kind { + Self::StringSearch + } +} + diff --git a/api/src/models/freshness.rs b/api/src/models/freshness.rs new file mode 100644 index 00000000..e506d89f --- /dev/null +++ b/api/src/models/freshness.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Freshness : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Freshness { + #[serde(rename = "fresh")] + Fresh, + #[serde(rename = "deprecated")] + Deprecated, + #[serde(rename = "unsupported")] + Unsupported, + +} + +impl std::fmt::Display for Freshness { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Fresh => write!(f, "fresh"), + Self::Deprecated => write!(f, "deprecated"), + Self::Unsupported => write!(f, "unsupported"), + } + } +} + +impl Default for Freshness { + fn default() -> Freshness { + Self::Fresh + } +} + diff --git a/api/src/models/full_participant_filter.rs b/api/src/models/full_participant_filter.rs new file mode 100644 index 00000000..fc2d527d --- /dev/null +++ b/api/src/models/full_participant_filter.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct FullParticipantFilter { + #[serde(rename = "one_of", skip_serializing_if = "Option::is_none")] + pub one_of: Option>, + #[serde(rename = "not_one_of", skip_serializing_if = "Option::is_none")] + pub not_one_of: Option>, + #[serde(rename = "domain_one_of", skip_serializing_if = "Option::is_none")] + pub domain_one_of: Option>, + #[serde(rename = "domain_not_one_of", skip_serializing_if = "Option::is_none")] + pub domain_not_one_of: Option>, + #[serde(rename = "organisation_one_of", skip_serializing_if = "Option::is_none")] + pub organisation_one_of: Option>, + #[serde(rename = "organisation_not_one_of", skip_serializing_if = "Option::is_none")] + pub organisation_not_one_of: Option>, +} + +impl FullParticipantFilter { + pub fn new() -> FullParticipantFilter { + FullParticipantFilter { + one_of: None, + not_one_of: None, + domain_one_of: None, + domain_not_one_of: None, + organisation_one_of: None, + organisation_not_one_of: None, + } + } +} + diff --git a/api/src/models/gemini_table_only_config.rs b/api/src/models/gemini_table_only_config.rs new file mode 100644 index 00000000..14e25012 --- /dev/null +++ b/api/src/models/gemini_table_only_config.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GeminiTableOnlyConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl GeminiTableOnlyConfig { + pub fn new() -> GeminiTableOnlyConfig { + GeminiTableOnlyConfig { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "gemini_table_only")] + GeminiTableOnly, +} + +impl Default for Kind { + fn default() -> Kind { + Self::GeminiTableOnly + } +} + diff --git a/api/src/models/general_field_def.rs b/api/src/models/general_field_def.rs new file mode 100644 index 00000000..de9adaba --- /dev/null +++ b/api/src/models/general_field_def.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GeneralFieldDef { + /// Unique identifier for the field + #[serde(rename = "field_id")] + pub field_id: String, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + /// The name of the field type + #[serde(rename = "field_type_name", skip_serializing_if = "Option::is_none")] + pub field_type_name: Option, + #[serde(rename = "api_name")] + pub api_name: String, + #[serde(rename = "title")] + pub title: String, +} + +impl GeneralFieldDef { + pub fn new(field_id: String, field_type_id: String, api_name: String, title: String) -> GeneralFieldDef { + GeneralFieldDef { + field_id, + field_type_id, + field_type_name: None, + api_name, + title, + } + } +} + diff --git a/api/src/models/general_field_def_new.rs b/api/src/models/general_field_def_new.rs new file mode 100644 index 00000000..e4d84924 --- /dev/null +++ b/api/src/models/general_field_def_new.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GeneralFieldDefNew { + /// Id of the field type + #[serde(rename = "field_type_id", skip_serializing_if = "Option::is_none")] + pub field_type_id: Option, + /// The name of the field type + #[serde(rename = "field_type_name", skip_serializing_if = "Option::is_none")] + pub field_type_name: Option, + #[serde(rename = "api_name")] + pub api_name: String, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, +} + +impl GeneralFieldDefNew { + pub fn new(api_name: String) -> GeneralFieldDefNew { + GeneralFieldDefNew { + field_type_id: None, + field_type_name: None, + api_name, + title: None, + } + } +} + diff --git a/api/src/models/general_field_def_update.rs b/api/src/models/general_field_def_update.rs new file mode 100644 index 00000000..8451b485 --- /dev/null +++ b/api/src/models/general_field_def_update.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GeneralFieldDefUpdate { + /// Unique identifier for the field + #[serde(rename = "field_id", skip_serializing_if = "Option::is_none")] + pub field_id: Option, + /// The ID of the field type + #[serde(rename = "field_type_id", skip_serializing_if = "Option::is_none")] + pub field_type_id: Option, + /// The name of the field type + #[serde(rename = "field_type_name", skip_serializing_if = "Option::is_none")] + pub field_type_name: Option, + #[serde(rename = "api_name")] + pub api_name: String, + #[serde(rename = "title")] + pub title: String, +} + +impl GeneralFieldDefUpdate { + pub fn new(api_name: String, title: String) -> GeneralFieldDefUpdate { + GeneralFieldDefUpdate { + field_id: None, + field_type_id: None, + field_type_name: None, + api_name, + title, + } + } +} + diff --git a/api/src/models/general_field_definition.rs b/api/src/models/general_field_definition.rs new file mode 100644 index 00000000..733fafa4 --- /dev/null +++ b/api/src/models/general_field_definition.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GeneralFieldDefinition { + /// Unique identifier for the field + #[serde(rename = "field_id")] + pub field_id: String, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub instructions: Option>, +} + +impl GeneralFieldDefinition { + pub fn new(field_id: String, field_type_id: String, name: String) -> GeneralFieldDefinition { + GeneralFieldDefinition { + field_id, + field_type_id, + name, + instructions: None, + } + } +} + diff --git a/api/src/models/get_alert_response.rs b/api/src/models/get_alert_response.rs new file mode 100644 index 00000000..1dd9784f --- /dev/null +++ b/api/src/models/get_alert_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAlertResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "alert")] + pub alert: Box, +} + +impl GetAlertResponse { + pub fn new(status: Status, alert: models::Alert) -> GetAlertResponse { + GetAlertResponse { + status, + alert: Box::new(alert), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_alert_subscriptions_response.rs b/api/src/models/get_alert_subscriptions_response.rs new file mode 100644 index 00000000..8b7167e3 --- /dev/null +++ b/api/src/models/get_alert_subscriptions_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAlertSubscriptionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "alert_subscriptions")] + pub alert_subscriptions: Vec, +} + +impl GetAlertSubscriptionsResponse { + pub fn new(status: Status, alert_subscriptions: Vec) -> GetAlertSubscriptionsResponse { + GetAlertSubscriptionsResponse { + status, + alert_subscriptions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_alerts_response.rs b/api/src/models/get_all_alerts_response.rs new file mode 100644 index 00000000..f4ecbcfb --- /dev/null +++ b/api/src/models/get_all_alerts_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllAlertsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "alerts")] + pub alerts: Vec, +} + +impl GetAllAlertsResponse { + pub fn new(status: Status, alerts: Vec) -> GetAllAlertsResponse { + GetAllAlertsResponse { + status, + alerts, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_buckets_response.rs b/api/src/models/get_all_buckets_response.rs new file mode 100644 index 00000000..5efea59c --- /dev/null +++ b/api/src/models/get_all_buckets_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllBucketsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "buckets")] + pub buckets: Vec, +} + +impl GetAllBucketsResponse { + pub fn new(status: Status, buckets: Vec) -> GetAllBucketsResponse { + GetAllBucketsResponse { + status, + buckets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_dashboards_in_dataset_response.rs b/api/src/models/get_all_dashboards_in_dataset_response.rs new file mode 100644 index 00000000..e67e6f1a --- /dev/null +++ b/api/src/models/get_all_dashboards_in_dataset_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllDashboardsInDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dashboards")] + pub dashboards: Vec, + #[serde(rename = "default", deserialize_with = "Option::deserialize")] + pub default: Option, +} + +impl GetAllDashboardsInDatasetResponse { + pub fn new(status: Status, dashboards: Vec, default: Option) -> GetAllDashboardsInDatasetResponse { + GetAllDashboardsInDatasetResponse { + status, + dashboards, + default, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_dashboards_in_project_response.rs b/api/src/models/get_all_dashboards_in_project_response.rs new file mode 100644 index 00000000..6529e28d --- /dev/null +++ b/api/src/models/get_all_dashboards_in_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllDashboardsInProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dashboards")] + pub dashboards: Vec, +} + +impl GetAllDashboardsInProjectResponse { + pub fn new(status: Status, dashboards: Vec) -> GetAllDashboardsInProjectResponse { + GetAllDashboardsInProjectResponse { + status, + dashboards, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_datasets_in_project_response.rs b/api/src/models/get_all_datasets_in_project_response.rs new file mode 100644 index 00000000..e7b4fe54 --- /dev/null +++ b/api/src/models/get_all_datasets_in_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllDatasetsInProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "datasets")] + pub datasets: Vec, +} + +impl GetAllDatasetsInProjectResponse { + pub fn new(status: Status, datasets: Vec) -> GetAllDatasetsInProjectResponse { + GetAllDatasetsInProjectResponse { + status, + datasets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_datasets_response.rs b/api/src/models/get_all_datasets_response.rs new file mode 100644 index 00000000..42dbb7be --- /dev/null +++ b/api/src/models/get_all_datasets_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllDatasetsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "datasets")] + pub datasets: Vec, +} + +impl GetAllDatasetsResponse { + pub fn new(status: Status, datasets: Vec) -> GetAllDatasetsResponse { + GetAllDatasetsResponse { + status, + datasets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_integrations_in_project_response.rs b/api/src/models/get_all_integrations_in_project_response.rs new file mode 100644 index 00000000..8c98c372 --- /dev/null +++ b/api/src/models/get_all_integrations_in_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllIntegrationsInProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integrations")] + pub integrations: Vec, +} + +impl GetAllIntegrationsInProjectResponse { + pub fn new(status: Status, integrations: Vec) -> GetAllIntegrationsInProjectResponse { + GetAllIntegrationsInProjectResponse { + status, + integrations, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_integrations_response.rs b/api/src/models/get_all_integrations_response.rs new file mode 100644 index 00000000..875f59ba --- /dev/null +++ b/api/src/models/get_all_integrations_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllIntegrationsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integrations")] + pub integrations: Vec, +} + +impl GetAllIntegrationsResponse { + pub fn new(status: Status, integrations: Vec) -> GetAllIntegrationsResponse { + GetAllIntegrationsResponse { + status, + integrations, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_ixp_models_in_project_response.rs b/api/src/models/get_all_ixp_models_in_project_response.rs new file mode 100644 index 00000000..b94cc697 --- /dev/null +++ b/api/src/models/get_all_ixp_models_in_project_response.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllIxpModelsInProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "models")] + pub models: Vec, + #[serde(rename = "tags")] + pub tags: Vec, + /// The maximum number of pinned models + #[serde(rename = "max_number_pinned_models")] + pub max_number_pinned_models: MaxNumberPinnedModels, +} + +impl GetAllIxpModelsInProjectResponse { + pub fn new(status: Status, models: Vec, tags: Vec, max_number_pinned_models: MaxNumberPinnedModels) -> GetAllIxpModelsInProjectResponse { + GetAllIxpModelsInProjectResponse { + status, + models, + tags, + max_number_pinned_models, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} +/// The maximum number of pinned models +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MaxNumberPinnedModels { + #[serde(rename = "100")] + Variant100, +} + +impl Default for MaxNumberPinnedModels { + fn default() -> MaxNumberPinnedModels { + Self::Variant100 + } +} + diff --git a/api/src/models/get_all_ixp_projects_response.rs b/api/src/models/get_all_ixp_projects_response.rs new file mode 100644 index 00000000..56813e98 --- /dev/null +++ b/api/src/models/get_all_ixp_projects_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllIxpProjectsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "projects")] + pub projects: Vec, +} + +impl GetAllIxpProjectsResponse { + pub fn new(status: Status, projects: Vec) -> GetAllIxpProjectsResponse { + GetAllIxpProjectsResponse { + status, + projects, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_label_groups_response.rs b/api/src/models/get_all_label_groups_response.rs new file mode 100644 index 00000000..89ec2d2e --- /dev/null +++ b/api/src/models/get_all_label_groups_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllLabelGroupsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label_groups")] + pub label_groups: Vec, +} + +impl GetAllLabelGroupsResponse { + pub fn new(status: Status, label_groups: Vec) -> GetAllLabelGroupsResponse { + GetAllLabelGroupsResponse { + status, + label_groups, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_models_in_dataset_request.rs b/api/src/models/get_all_models_in_dataset_request.rs new file mode 100644 index 00000000..1195c5db --- /dev/null +++ b/api/src/models/get_all_models_in_dataset_request.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllModelsInDatasetRequest { + #[serde(rename = "older_than_version", skip_serializing_if = "Option::is_none")] + pub older_than_version: Option, + #[serde(rename = "limit", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub limit: Option>, + #[serde(rename = "include_deleted", skip_serializing_if = "Option::is_none")] + pub include_deleted: Option, + #[serde(rename = "starred", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub starred: Option>, + #[serde(rename = "validated", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub validated: Option>, +} + +impl GetAllModelsInDatasetRequest { + pub fn new() -> GetAllModelsInDatasetRequest { + GetAllModelsInDatasetRequest { + older_than_version: None, + limit: None, + include_deleted: None, + starred: None, + validated: None, + } + } +} + diff --git a/api/src/models/get_all_models_in_dataset_response.rs b/api/src/models/get_all_models_in_dataset_response.rs new file mode 100644 index 00000000..d03d0f6f --- /dev/null +++ b/api/src/models/get_all_models_in_dataset_response.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllModelsInDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "labellers")] + pub labellers: Vec, + #[serde(rename = "model_tags")] + pub model_tags: Vec, + /// The maximum number of pinned models + #[serde(rename = "max_number_pinned_models")] + pub max_number_pinned_models: MaxNumberPinnedModels, +} + +impl GetAllModelsInDatasetResponse { + pub fn new(status: Status, labellers: Vec, model_tags: Vec, max_number_pinned_models: MaxNumberPinnedModels) -> GetAllModelsInDatasetResponse { + GetAllModelsInDatasetResponse { + status, + labellers, + model_tags, + max_number_pinned_models, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} +/// The maximum number of pinned models +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MaxNumberPinnedModels { + #[serde(rename = "100")] + Variant100, +} + +impl Default for MaxNumberPinnedModels { + fn default() -> MaxNumberPinnedModels { + Self::Variant100 + } +} + diff --git a/api/src/models/get_all_projects_response.rs b/api/src/models/get_all_projects_response.rs new file mode 100644 index 00000000..f18c8728 --- /dev/null +++ b/api/src/models/get_all_projects_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllProjectsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "projects")] + pub projects: Vec, +} + +impl GetAllProjectsResponse { + pub fn new(status: Status, projects: Vec) -> GetAllProjectsResponse { + GetAllProjectsResponse { + status, + projects, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_projects_v1_response.rs b/api/src/models/get_all_projects_v1_response.rs new file mode 100644 index 00000000..6485ef82 --- /dev/null +++ b/api/src/models/get_all_projects_v1_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllProjectsV1Response { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "projects")] + pub projects: Vec, +} + +impl GetAllProjectsV1Response { + pub fn new(status: Status, projects: Vec) -> GetAllProjectsV1Response { + GetAllProjectsV1Response { + status, + projects, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_sources_in_project_response.rs b/api/src/models/get_all_sources_in_project_response.rs new file mode 100644 index 00000000..8123e9f3 --- /dev/null +++ b/api/src/models/get_all_sources_in_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllSourcesInProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sources")] + pub sources: Vec, +} + +impl GetAllSourcesInProjectResponse { + pub fn new(status: Status, sources: Vec) -> GetAllSourcesInProjectResponse { + GetAllSourcesInProjectResponse { + status, + sources, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_sources_response.rs b/api/src/models/get_all_sources_response.rs new file mode 100644 index 00000000..7894eb6a --- /dev/null +++ b/api/src/models/get_all_sources_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllSourcesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sources")] + pub sources: Vec, +} + +impl GetAllSourcesResponse { + pub fn new(status: Status, sources: Vec) -> GetAllSourcesResponse { + GetAllSourcesResponse { + status, + sources, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_streams_response.rs b/api/src/models/get_all_streams_response.rs new file mode 100644 index 00000000..5e9b0500 --- /dev/null +++ b/api/src/models/get_all_streams_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllStreamsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "streams")] + pub streams: Vec, +} + +impl GetAllStreamsResponse { + pub fn new(status: Status, streams: Vec) -> GetAllStreamsResponse { + GetAllStreamsResponse { + status, + streams, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_all_triggers_in_dataset_response.rs b/api/src/models/get_all_triggers_in_dataset_response.rs new file mode 100644 index 00000000..3b64d63d --- /dev/null +++ b/api/src/models/get_all_triggers_in_dataset_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetAllTriggersInDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "triggers")] + pub triggers: Vec, +} + +impl GetAllTriggersInDatasetResponse { + pub fn new(status: Status, triggers: Vec) -> GetAllTriggersInDatasetResponse { + GetAllTriggersInDatasetResponse { + status, + triggers, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_bucket_by_id_response.rs b/api/src/models/get_bucket_by_id_response.rs new file mode 100644 index 00000000..0bf60a06 --- /dev/null +++ b/api/src/models/get_bucket_by_id_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketByIdResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl GetBucketByIdResponse { + pub fn new(status: Status, bucket: models::Bucket) -> GetBucketByIdResponse { + GetBucketByIdResponse { + status, + bucket: Box::new(bucket), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_bucket_emails_request.rs b/api/src/models/get_bucket_emails_request.rs new file mode 100644 index 00000000..1498c1bc --- /dev/null +++ b/api/src/models/get_bucket_emails_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketEmailsRequest { + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl GetBucketEmailsRequest { + pub fn new() -> GetBucketEmailsRequest { + GetBucketEmailsRequest { + limit: None, + continuation: None, + } + } +} + diff --git a/api/src/models/get_bucket_emails_response.rs b/api/src/models/get_bucket_emails_response.rs new file mode 100644 index 00000000..1dc8aa78 --- /dev/null +++ b/api/src/models/get_bucket_emails_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketEmailsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "emails")] + pub emails: Vec, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl GetBucketEmailsResponse { + pub fn new(status: Status, emails: Vec) -> GetBucketEmailsResponse { + GetBucketEmailsResponse { + status, + emails, + continuation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_bucket_response.rs b/api/src/models/get_bucket_response.rs new file mode 100644 index 00000000..4f66b9a0 --- /dev/null +++ b/api/src/models/get_bucket_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl GetBucketResponse { + pub fn new(status: Status, bucket: models::Bucket) -> GetBucketResponse { + GetBucketResponse { + status, + bucket: Box::new(bucket), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_bucket_statistics_response.rs b/api/src/models/get_bucket_statistics_response.rs new file mode 100644 index 00000000..bce6bf93 --- /dev/null +++ b/api/src/models/get_bucket_statistics_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketStatisticsResponse { + #[serde(rename = "status")] + pub status: Status, + /// Bucket statistics + #[serde(rename = "statistics")] + pub statistics: Box, +} + +impl GetBucketStatisticsResponse { + pub fn new(status: Status, statistics: models::BucketStatistics) -> GetBucketStatisticsResponse { + GetBucketStatisticsResponse { + status, + statistics: Box::new(statistics), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_bucket_sync_state_response.rs b/api/src/models/get_bucket_sync_state_response.rs new file mode 100644 index 00000000..d7cfa1cf --- /dev/null +++ b/api/src/models/get_bucket_sync_state_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketSyncStateResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "bucket_sync_state")] + pub bucket_sync_state: Box, +} + +impl GetBucketSyncStateResponse { + pub fn new(status: Status, bucket_sync_state: models::BucketSyncState) -> GetBucketSyncStateResponse { + GetBucketSyncStateResponse { + status, + bucket_sync_state: Box::new(bucket_sync_state), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_buckets_by_owner_response.rs b/api/src/models/get_buckets_by_owner_response.rs new file mode 100644 index 00000000..cd1c6f58 --- /dev/null +++ b/api/src/models/get_buckets_by_owner_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetBucketsByOwnerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "buckets")] + pub buckets: Vec, +} + +impl GetBucketsByOwnerResponse { + pub fn new(status: Status, buckets: Vec) -> GetBucketsByOwnerResponse { + GetBucketsByOwnerResponse { + status, + buckets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_comment_predictions_request.rs b/api/src/models/get_comment_predictions_request.rs new file mode 100644 index 00000000..83bb35fa --- /dev/null +++ b/api/src/models/get_comment_predictions_request.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetCommentPredictionsRequest { + /// List of comment uids to get predictions for + #[serde(rename = "uids")] + pub uids: Vec, + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option>, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, +} + +impl GetCommentPredictionsRequest { + pub fn new(uids: Vec) -> GetCommentPredictionsRequest { + GetCommentPredictionsRequest { + uids, + threshold: None, + labels: None, + } + } +} + diff --git a/api/src/models/get_comment_predictions_response.rs b/api/src/models/get_comment_predictions_response.rs new file mode 100644 index 00000000..bf204e08 --- /dev/null +++ b/api/src/models/get_comment_predictions_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetCommentPredictionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "predictions")] + pub predictions: Vec, + #[serde(rename = "model", deserialize_with = "Option::deserialize")] + pub model: Option>, +} + +impl GetCommentPredictionsResponse { + pub fn new(status: Status, predictions: Vec, model: Option) -> GetCommentPredictionsResponse { + GetCommentPredictionsResponse { + status, + predictions, + model: model.map(Box::new), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_comment_response.rs b/api/src/models/get_comment_response.rs new file mode 100644 index 00000000..d7fbc5a4 --- /dev/null +++ b/api/src/models/get_comment_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetCommentResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "comment")] + pub comment: Box, +} + +impl GetCommentResponse { + pub fn new(status: Status, comment: models::Comment) -> GetCommentResponse { + GetCommentResponse { + status, + comment: Box::new(comment), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_comparison_request.rs b/api/src/models/get_comparison_request.rs new file mode 100644 index 00000000..564d2a60 --- /dev/null +++ b/api/src/models/get_comparison_request.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetComparisonRequest { + #[serde(rename = "cohort_a", skip_serializing_if = "Option::is_none")] + pub cohort_a: Option, + #[serde(rename = "cohort_b", skip_serializing_if = "Option::is_none")] + pub cohort_b: Option, + #[serde(rename = "attribute_filters_a", skip_serializing_if = "Option::is_none")] + pub attribute_filters_a: Option>, + #[serde(rename = "attribute_filters_b", skip_serializing_if = "Option::is_none")] + pub attribute_filters_b: Option>, + #[serde(rename = "thread_mode", skip_serializing_if = "Option::is_none")] + pub thread_mode: Option, +} + +impl GetComparisonRequest { + pub fn new() -> GetComparisonRequest { + GetComparisonRequest { + cohort_a: None, + cohort_b: None, + attribute_filters_a: None, + attribute_filters_b: None, + thread_mode: None, + } + } +} + diff --git a/api/src/models/get_comparison_response.rs b/api/src/models/get_comparison_response.rs new file mode 100644 index 00000000..453f4811 --- /dev/null +++ b/api/src/models/get_comparison_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetComparisonResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "compare")] + pub compare: Box, +} + +impl GetComparisonResponse { + pub fn new(status: Status, compare: models::Comparison) -> GetComparisonResponse { + GetComparisonResponse { + status, + compare: Box::new(compare), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dashboard_response.rs b/api/src/models/get_dashboard_response.rs new file mode 100644 index 00000000..5f67e7a2 --- /dev/null +++ b/api/src/models/get_dashboard_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDashboardResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dashboard")] + pub dashboard: Box, +} + +impl GetDashboardResponse { + pub fn new(status: Status, dashboard: models::Dashboard) -> GetDashboardResponse { + GetDashboardResponse { + status, + dashboard: Box::new(dashboard), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dataset_response.rs b/api/src/models/get_dataset_response.rs new file mode 100644 index 00000000..8613d06d --- /dev/null +++ b/api/src/models/get_dataset_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl GetDatasetResponse { + pub fn new(status: Status, dataset: models::Dataset) -> GetDatasetResponse { + GetDatasetResponse { + status, + dataset: Box::new(dataset), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dataset_statistics_request.rs b/api/src/models/get_dataset_statistics_request.rs new file mode 100644 index 00000000..138a40e3 --- /dev/null +++ b/api/src/models/get_dataset_statistics_request.rs @@ -0,0 +1,69 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetStatisticsRequest { + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, + #[serde(rename = "label_filter", skip_serializing_if = "Option::is_none")] + pub label_filter: Option>, + #[serde(rename = "by_labels", skip_serializing_if = "Option::is_none")] + pub by_labels: Option>, + #[serde(rename = "by_label_properties")] + pub by_label_properties: Vec, + #[serde(rename = "time_resolution", skip_serializing_if = "Option::is_none")] + pub time_resolution: Option, + #[serde(rename = "string_user_property_counts", skip_serializing_if = "Option::is_none")] + pub string_user_property_counts: Option>, + #[serde(rename = "email_property_counts", skip_serializing_if = "Option::is_none")] + pub email_property_counts: Option>, + #[serde(rename = "source_counts", skip_serializing_if = "Option::is_none")] + pub source_counts: Option>, + #[serde(rename = "label_timeseries", skip_serializing_if = "Option::is_none")] + pub label_timeseries: Option, + #[serde(rename = "label_property_timeseries", skip_serializing_if = "Option::is_none")] + pub label_property_timeseries: Option, + #[serde(rename = "thread_histogram", skip_serializing_if = "Option::is_none")] + pub thread_histogram: Option>, + #[serde(rename = "nps_property", skip_serializing_if = "Option::is_none")] + pub nps_property: Option, + #[serde(rename = "attribute_filters", skip_serializing_if = "Option::is_none")] + pub attribute_filters: Option>, + #[serde(rename = "thread_mode", skip_serializing_if = "Option::is_none")] + pub thread_mode: Option, + #[serde(rename = "timezone", skip_serializing_if = "Option::is_none")] + pub timezone: Option, +} + +impl GetDatasetStatisticsRequest { + pub fn new(by_label_properties: Vec) -> GetDatasetStatisticsRequest { + GetDatasetStatisticsRequest { + comment_filter: None, + label_filter: None, + by_labels: None, + by_label_properties, + time_resolution: None, + string_user_property_counts: None, + email_property_counts: None, + source_counts: None, + label_timeseries: None, + label_property_timeseries: None, + thread_histogram: None, + nps_property: None, + attribute_filters: None, + thread_mode: None, + timezone: None, + } + } +} + diff --git a/api/src/models/get_dataset_statistics_response.rs b/api/src/models/get_dataset_statistics_response.rs new file mode 100644 index 00000000..0790eecc --- /dev/null +++ b/api/src/models/get_dataset_statistics_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetStatisticsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "statistics")] + pub statistics: Box, +} + +impl GetDatasetStatisticsResponse { + pub fn new(status: Status, statistics: models::Statistics) -> GetDatasetStatisticsResponse { + GetDatasetStatisticsResponse { + status, + statistics: Box::new(statistics), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dataset_status_response.rs b/api/src/models/get_dataset_status_response.rs new file mode 100644 index 00000000..f221254b --- /dev/null +++ b/api/src/models/get_dataset_status_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetStatusResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dataset_status")] + pub dataset_status: Box, +} + +impl GetDatasetStatusResponse { + pub fn new(status: Status, dataset_status: models::DatasetStatus) -> GetDatasetStatusResponse { + GetDatasetStatusResponse { + status, + dataset_status: Box::new(dataset_status), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dataset_summary_request.rs b/api/src/models/get_dataset_summary_request.rs new file mode 100644 index 00000000..a29c0136 --- /dev/null +++ b/api/src/models/get_dataset_summary_request.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetSummaryRequest { + #[serde(rename = "thread_mode", skip_serializing_if = "Option::is_none")] + pub thread_mode: Option, + #[serde(rename = "filter", skip_serializing_if = "Option::is_none")] + pub filter: Option, + /// Label Filters are deprecated, use Attribute Filters instead + #[serde(rename = "label_filter", skip_serializing_if = "Option::is_none")] + pub label_filter: Option>, + #[serde(rename = "attribute_filters", skip_serializing_if = "Option::is_none")] + pub attribute_filters: Option>, + #[serde(rename = "beta", skip_serializing_if = "Option::is_none")] + pub beta: Option, +} + +impl GetDatasetSummaryRequest { + pub fn new() -> GetDatasetSummaryRequest { + GetDatasetSummaryRequest { + thread_mode: None, + filter: None, + label_filter: None, + attribute_filters: None, + beta: None, + } + } +} + diff --git a/api/src/models/get_dataset_summary_response.rs b/api/src/models/get_dataset_summary_response.rs new file mode 100644 index 00000000..55476a0b --- /dev/null +++ b/api/src/models/get_dataset_summary_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetSummaryResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "summary")] + pub summary: Box, +} + +impl GetDatasetSummaryResponse { + pub fn new(status: Status, summary: models::DatasetSummary) -> GetDatasetSummaryResponse { + GetDatasetSummaryResponse { + status, + summary: Box::new(summary), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_dataset_user_properties_summary_response.rs b/api/src/models/get_dataset_user_properties_summary_response.rs new file mode 100644 index 00000000..152222ff --- /dev/null +++ b/api/src/models/get_dataset_user_properties_summary_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDatasetUserPropertiesSummaryResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "user_properties")] + pub user_properties: Box, +} + +impl GetDatasetUserPropertiesSummaryResponse { + pub fn new(status: Status, user_properties: models::UserPropertiesSummary) -> GetDatasetUserPropertiesSummaryResponse { + GetDatasetUserPropertiesSummaryResponse { + status, + user_properties: Box::new(user_properties), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_deprecated_user_models_response.rs b/api/src/models/get_deprecated_user_models_response.rs new file mode 100644 index 00000000..c7c886b8 --- /dev/null +++ b/api/src/models/get_deprecated_user_models_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDeprecatedUserModelsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "datasets")] + pub datasets: Vec, + #[serde(rename = "deprecated_models")] + pub deprecated_models: Vec, +} + +impl GetDeprecatedUserModelsResponse { + pub fn new(status: Status, datasets: Vec, deprecated_models: Vec) -> GetDeprecatedUserModelsResponse { + GetDeprecatedUserModelsResponse { + status, + datasets, + deprecated_models, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_derived_permission_response.rs b/api/src/models/get_derived_permission_response.rs new file mode 100644 index 00000000..442e7e10 --- /dev/null +++ b/api/src/models/get_derived_permission_response.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDerivedPermissionResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "global_permissions")] + pub global_permissions: Vec, + #[serde(rename = "organisation_permissions")] + pub organisation_permissions: Vec, + #[serde(rename = "permissions")] + pub permissions: Vec, +} + +impl GetDerivedPermissionResponse { + pub fn new(status: Status, global_permissions: Vec, organisation_permissions: Vec, permissions: Vec) -> GetDerivedPermissionResponse { + GetDerivedPermissionResponse { + status, + global_permissions, + organisation_permissions, + permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_derived_permissions_request.rs b/api/src/models/get_derived_permissions_request.rs new file mode 100644 index 00000000..6492735e --- /dev/null +++ b/api/src/models/get_derived_permissions_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDerivedPermissionsRequest { + #[serde(rename = "global_permissions", skip_serializing_if = "Option::is_none")] + pub global_permissions: Option>, + #[serde(rename = "organisation_permissions", skip_serializing_if = "Option::is_none")] + pub organisation_permissions: Option>, +} + +impl GetDerivedPermissionsRequest { + pub fn new() -> GetDerivedPermissionsRequest { + GetDerivedPermissionsRequest { + global_permissions: None, + organisation_permissions: None, + } + } +} + diff --git a/api/src/models/get_document_metadata_response.rs b/api/src/models/get_document_metadata_response.rs new file mode 100644 index 00000000..a04dc684 --- /dev/null +++ b/api/src/models/get_document_metadata_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDocumentMetadataResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "page_metadata")] + pub page_metadata: Vec, +} + +impl GetDocumentMetadataResponse { + pub fn new(status: Status, page_metadata: Vec) -> GetDocumentMetadataResponse { + GetDocumentMetadataResponse { + status, + page_metadata, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_document_search_response.rs b/api/src/models/get_document_search_response.rs new file mode 100644 index 00000000..b434ffdd --- /dev/null +++ b/api/src/models/get_document_search_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetDocumentSearchResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "search_results")] + pub search_results: Vec, +} + +impl GetDocumentSearchResponse { + pub fn new(status: Status, search_results: Vec) -> GetDocumentSearchResponse { + GetDocumentSearchResponse { + status, + search_results, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_email_from_bucket_by_id_response.rs b/api/src/models/get_email_from_bucket_by_id_response.rs new file mode 100644 index 00000000..ba0062ef --- /dev/null +++ b/api/src/models/get_email_from_bucket_by_id_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetEmailFromBucketByIdResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "emails")] + pub emails: Vec, +} + +impl GetEmailFromBucketByIdResponse { + pub fn new(status: Status, emails: Vec) -> GetEmailFromBucketByIdResponse { + GetEmailFromBucketByIdResponse { + status, + emails, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_email_transform_tag_info_response.rs b/api/src/models/get_email_transform_tag_info_response.rs new file mode 100644 index 00000000..c6af2dc4 --- /dev/null +++ b/api/src/models/get_email_transform_tag_info_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetEmailTransformTagInfoResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "email_transform_tag_info")] + pub email_transform_tag_info: Box, +} + +impl GetEmailTransformTagInfoResponse { + pub fn new(status: Status, email_transform_tag_info: models::EmailTransformTagInfo) -> GetEmailTransformTagInfoResponse { + GetEmailTransformTagInfoResponse { + status, + email_transform_tag_info: Box::new(email_transform_tag_info), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_field_group_history_response.rs b/api/src/models/get_field_group_history_response.rs new file mode 100644 index 00000000..6fed2301 --- /dev/null +++ b/api/src/models/get_field_group_history_response.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GetFieldGroupHistoryResponse : Response containing field group version history +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetFieldGroupHistoryResponse { + #[serde(rename = "status", skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Version history entries + #[serde(rename = "versions")] + pub versions: Vec, + /// To be used with older_than_version for next page. If None, there are no more versions. + #[serde(rename = "oldest_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub oldest_version: Option>, +} + +impl GetFieldGroupHistoryResponse { + /// Response containing field group version history + pub fn new(versions: Vec) -> GetFieldGroupHistoryResponse { + GetFieldGroupHistoryResponse { + status: None, + versions, + oldest_version: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_field_history_response.rs b/api/src/models/get_field_history_response.rs new file mode 100644 index 00000000..aac03a49 --- /dev/null +++ b/api/src/models/get_field_history_response.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GetFieldHistoryResponse : Response containing field version history +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetFieldHistoryResponse { + #[serde(rename = "status", skip_serializing_if = "Option::is_none")] + pub status: Option, + /// Version history entries + #[serde(rename = "versions")] + pub versions: Vec, + /// To be used with older_than_version for next page. If None, there are no more versions. + #[serde(rename = "oldest_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub oldest_version: Option>, +} + +impl GetFieldHistoryResponse { + /// Response containing field version history + pub fn new(versions: Vec) -> GetFieldHistoryResponse { + GetFieldHistoryResponse { + status: None, + versions, + oldest_version: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_integration_by_id_response.rs b/api/src/models/get_integration_by_id_response.rs new file mode 100644 index 00000000..71db0a3e --- /dev/null +++ b/api/src/models/get_integration_by_id_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIntegrationByIdResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integration")] + pub integration: Box, +} + +impl GetIntegrationByIdResponse { + pub fn new(status: Status, integration: models::Integration) -> GetIntegrationByIdResponse { + GetIntegrationByIdResponse { + status, + integration: Box::new(integration), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_integration_errors_response.rs b/api/src/models/get_integration_errors_response.rs new file mode 100644 index 00000000..86e37258 --- /dev/null +++ b/api/src/models/get_integration_errors_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIntegrationErrorsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "errors")] + pub errors: Vec, +} + +impl GetIntegrationErrorsResponse { + pub fn new(status: Status, errors: Vec) -> GetIntegrationErrorsResponse { + GetIntegrationErrorsResponse { + status, + errors, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_integration_response.rs b/api/src/models/get_integration_response.rs new file mode 100644 index 00000000..eefb9a5e --- /dev/null +++ b/api/src/models/get_integration_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIntegrationResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integration")] + pub integration: Box, +} + +impl GetIntegrationResponse { + pub fn new(status: Status, integration: models::Integration) -> GetIntegrationResponse { + GetIntegrationResponse { + status, + integration: Box::new(integration), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_issue_response.rs b/api/src/models/get_issue_response.rs new file mode 100644 index 00000000..da8ea8e4 --- /dev/null +++ b/api/src/models/get_issue_response.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIssueResponse { + #[serde(rename = "status")] + pub status: Status, + /// Pydantic model with sane defaults and better Optional handling. + #[serde(rename = "issue")] + pub issue: Box, + #[serde(rename = "alerts")] + pub alerts: Vec, +} + +impl GetIssueResponse { + pub fn new(status: Status, issue: models::Issue, alerts: Vec) -> GetIssueResponse { + GetIssueResponse { + status, + issue: Box::new(issue), + alerts, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_ixp_consumability_info_response.rs b/api/src/models/get_ixp_consumability_info_response.rs new file mode 100644 index 00000000..6aa38435 --- /dev/null +++ b/api/src/models/get_ixp_consumability_info_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIxpConsumabilityInfoResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "can_consume_runtime")] + pub can_consume_runtime: bool, + #[serde(rename = "can_consume_designtime")] + pub can_consume_designtime: bool, +} + +impl GetIxpConsumabilityInfoResponse { + pub fn new(status: Status, can_consume_runtime: bool, can_consume_designtime: bool) -> GetIxpConsumabilityInfoResponse { + GetIxpConsumabilityInfoResponse { + status, + can_consume_runtime, + can_consume_designtime, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_ixp_project_response.rs b/api/src/models/get_ixp_project_response.rs new file mode 100644 index 00000000..3a9843bc --- /dev/null +++ b/api/src/models/get_ixp_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetIxpProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "project")] + pub project: Box, +} + +impl GetIxpProjectResponse { + pub fn new(status: Status, project: models::IxpProject) -> GetIxpProjectResponse { + GetIxpProjectResponse { + status, + project: Box::new(project), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_keyed_sync_state_response.rs b/api/src/models/get_keyed_sync_state_response.rs new file mode 100644 index 00000000..9688f985 --- /dev/null +++ b/api/src/models/get_keyed_sync_state_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetKeyedSyncStateResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "keyed_sync_state")] + pub keyed_sync_state: Box, +} + +impl GetKeyedSyncStateResponse { + pub fn new(status: Status, keyed_sync_state: models::KeyedSyncState) -> GetKeyedSyncStateResponse { + GetKeyedSyncStateResponse { + status, + keyed_sync_state: Box::new(keyed_sync_state), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_label_def_response.rs b/api/src/models/get_label_def_response.rs new file mode 100644 index 00000000..6fd84656 --- /dev/null +++ b/api/src/models/get_label_def_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetLabelDefResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label")] + pub label: Box, +} + +impl GetLabelDefResponse { + pub fn new(status: Status, label: models::LabelDef) -> GetLabelDefResponse { + GetLabelDefResponse { + status, + label: Box::new(label), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_label_group_response.rs b/api/src/models/get_label_group_response.rs new file mode 100644 index 00000000..cfb4a7e8 --- /dev/null +++ b/api/src/models/get_label_group_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetLabelGroupResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label_group")] + pub label_group: Box, +} + +impl GetLabelGroupResponse { + pub fn new(status: Status, label_group: models::LabelGroup) -> GetLabelGroupResponse { + GetLabelGroupResponse { + status, + label_group: Box::new(label_group), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_label_validation_request.rs b/api/src/models/get_label_validation_request.rs new file mode 100644 index 00000000..6f954faf --- /dev/null +++ b/api/src/models/get_label_validation_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetLabelValidationRequest { + #[serde(rename = "label")] + pub label: String, + #[serde(rename = "moon", skip_serializing_if = "Option::is_none")] + pub moon: Option>, +} + +impl GetLabelValidationRequest { + pub fn new(label: String) -> GetLabelValidationRequest { + GetLabelValidationRequest { + label, + moon: None, + } + } +} + diff --git a/api/src/models/get_label_validation_response.rs b/api/src/models/get_label_validation_response.rs new file mode 100644 index 00000000..a32204f9 --- /dev/null +++ b/api/src/models/get_label_validation_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetLabelValidationResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label_validation")] + pub label_validation: Box, + #[serde(rename = "moon_validation", skip_serializing_if = "Option::is_none")] + pub moon_validation: Option>, +} + +impl GetLabelValidationResponse { + pub fn new(status: Status, label_validation: models::LabelMetrics) -> GetLabelValidationResponse { + GetLabelValidationResponse { + status, + label_validation: Box::new(label_validation), + moon_validation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_labellings_response.rs b/api/src/models/get_labellings_response.rs new file mode 100644 index 00000000..3c19adbf --- /dev/null +++ b/api/src/models/get_labellings_response.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetLabellingsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + #[serde(rename = "triggers", skip_serializing_if = "Option::is_none")] + pub triggers: Option>, + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "after", skip_serializing_if = "Option::is_none")] + pub after: Option, +} + +impl GetLabellingsResponse { + pub fn new(status: Status, entity_defs: Vec, results: Vec) -> GetLabellingsResponse { + GetLabellingsResponse { + status, + entity_defs, + triggers: None, + results, + after: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_model_tags_response.rs b/api/src/models/get_model_tags_response.rs new file mode 100644 index 00000000..569d25df --- /dev/null +++ b/api/src/models/get_model_tags_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetModelTagsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "model_tags")] + pub model_tags: Vec, +} + +impl GetModelTagsResponse { + pub fn new(status: Status, model_tags: Vec) -> GetModelTagsResponse { + GetModelTagsResponse { + status, + model_tags, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_page_selections_response.rs b/api/src/models/get_page_selections_response.rs new file mode 100644 index 00000000..c0c2253d --- /dev/null +++ b/api/src/models/get_page_selections_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetPageSelectionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "selections")] + pub selections: Vec, +} + +impl GetPageSelectionsResponse { + pub fn new(status: Status, selections: Vec) -> GetPageSelectionsResponse { + GetPageSelectionsResponse { + status, + selections, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_pretrained_labels_response.rs b/api/src/models/get_pretrained_labels_response.rs new file mode 100644 index 00000000..ece4b2f1 --- /dev/null +++ b/api/src/models/get_pretrained_labels_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetPretrainedLabelsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "label_collections")] + pub label_collections: Vec, +} + +impl GetPretrainedLabelsResponse { + pub fn new(status: Status, label_collections: Vec) -> GetPretrainedLabelsResponse { + GetPretrainedLabelsResponse { + status, + label_collections, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_project_resource_counts_response.rs b/api/src/models/get_project_resource_counts_response.rs new file mode 100644 index 00000000..fa052e40 --- /dev/null +++ b/api/src/models/get_project_resource_counts_response.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetProjectResourceCountsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "buckets")] + pub buckets: i32, + #[serde(rename = "dashboards")] + pub dashboards: i32, + #[serde(rename = "datasets")] + pub datasets: i32, + #[serde(rename = "integrations")] + pub integrations: i32, + #[serde(rename = "sources")] + pub sources: i32, + #[serde(rename = "users_with_permissions")] + pub users_with_permissions: i32, +} + +impl GetProjectResourceCountsResponse { + pub fn new(status: Status, buckets: i32, dashboards: i32, datasets: i32, integrations: i32, sources: i32, users_with_permissions: i32) -> GetProjectResourceCountsResponse { + GetProjectResourceCountsResponse { + status, + buckets, + dashboards, + datasets, + integrations, + sources, + users_with_permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_project_response.rs b/api/src/models/get_project_response.rs new file mode 100644 index 00000000..f158d569 --- /dev/null +++ b/api/src/models/get_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "project")] + pub project: Box, +} + +impl GetProjectResponse { + pub fn new(status: Status, project: models::Project) -> GetProjectResponse { + GetProjectResponse { + status, + project: Box::new(project), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_qualified_login_url_request.rs b/api/src/models/get_qualified_login_url_request.rs new file mode 100644 index 00000000..6c73fe2c --- /dev/null +++ b/api/src/models/get_qualified_login_url_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetQualifiedLoginUrlRequest { + #[serde(rename = "email")] + pub email: String, +} + +impl GetQualifiedLoginUrlRequest { + pub fn new(email: String) -> GetQualifiedLoginUrlRequest { + GetQualifiedLoginUrlRequest { + email, + } + } +} + diff --git a/api/src/models/get_qualified_login_url_response.rs b/api/src/models/get_qualified_login_url_response.rs new file mode 100644 index 00000000..8af01f5e --- /dev/null +++ b/api/src/models/get_qualified_login_url_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetQualifiedLoginUrlResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "login_url")] + pub login_url: String, +} + +impl GetQualifiedLoginUrlResponse { + pub fn new(status: Status, login_url: String) -> GetQualifiedLoginUrlResponse { + GetQualifiedLoginUrlResponse { + status, + login_url, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_quotas_for_tenant_response.rs b/api/src/models/get_quotas_for_tenant_response.rs new file mode 100644 index 00000000..0f4997f3 --- /dev/null +++ b/api/src/models/get_quotas_for_tenant_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetQuotasForTenantResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "quotas")] + pub quotas: Vec, +} + +impl GetQuotasForTenantResponse { + pub fn new(status: Status, quotas: Vec) -> GetQuotasForTenantResponse { + GetQuotasForTenantResponse { + status, + quotas, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_reduced_permissions_request.rs b/api/src/models/get_reduced_permissions_request.rs new file mode 100644 index 00000000..5db4ae25 --- /dev/null +++ b/api/src/models/get_reduced_permissions_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetReducedPermissionsRequest { + #[serde(rename = "global_permissions", skip_serializing_if = "Option::is_none")] + pub global_permissions: Option>, + #[serde(rename = "organisation_permissions", skip_serializing_if = "Option::is_none")] + pub organisation_permissions: Option>, +} + +impl GetReducedPermissionsRequest { + pub fn new() -> GetReducedPermissionsRequest { + GetReducedPermissionsRequest { + global_permissions: None, + organisation_permissions: None, + } + } +} + diff --git a/api/src/models/get_reduced_permissions_response.rs b/api/src/models/get_reduced_permissions_response.rs new file mode 100644 index 00000000..3dd46ad0 --- /dev/null +++ b/api/src/models/get_reduced_permissions_response.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetReducedPermissionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "global_permissions")] + pub global_permissions: Vec, + #[serde(rename = "organisation_permissions")] + pub organisation_permissions: Vec, + #[serde(rename = "permissions")] + pub permissions: Vec, +} + +impl GetReducedPermissionsResponse { + pub fn new(status: Status, global_permissions: Vec, organisation_permissions: Vec, permissions: Vec) -> GetReducedPermissionsResponse { + GetReducedPermissionsResponse { + status, + global_permissions, + organisation_permissions, + permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_reduced_permissions_response_permissions_inner.rs b/api/src/models/get_reduced_permissions_response_permissions_inner.rs new file mode 100644 index 00000000..9e8636cc --- /dev/null +++ b/api/src/models/get_reduced_permissions_response_permissions_inner.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetReducedPermissionsResponsePermissionsInner { +} + +impl GetReducedPermissionsResponsePermissionsInner { + pub fn new() -> GetReducedPermissionsResponsePermissionsInner { + GetReducedPermissionsResponsePermissionsInner { + } + } +} + diff --git a/api/src/models/get_source_by_id_response.rs b/api/src/models/get_source_by_id_response.rs new file mode 100644 index 00000000..be007826 --- /dev/null +++ b/api/src/models/get_source_by_id_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceByIdResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "source")] + pub source: Box, +} + +impl GetSourceByIdResponse { + pub fn new(status: Status, source: models::Source) -> GetSourceByIdResponse { + GetSourceByIdResponse { + status, + source: Box::new(source), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_source_comments_response.rs b/api/src/models/get_source_comments_response.rs new file mode 100644 index 00000000..907872eb --- /dev/null +++ b/api/src/models/get_source_comments_response.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceCommentsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "comments")] + pub comments: Vec, + #[serde(rename = "thread_properties", skip_serializing_if = "Option::is_none")] + pub thread_properties: Option>, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl GetSourceCommentsResponse { + pub fn new(status: Status, comments: Vec) -> GetSourceCommentsResponse { + GetSourceCommentsResponse { + status, + comments, + thread_properties: None, + continuation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_source_comments_response_thread_properties_inner.rs b/api/src/models/get_source_comments_response_thread_properties_inner.rs new file mode 100644 index 00000000..353154a5 --- /dev/null +++ b/api/src/models/get_source_comments_response_thread_properties_inner.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceCommentsResponseThreadPropertiesInner { + #[serde(rename = "duration")] + pub duration: f64, + #[serde(rename = "response_time")] + pub response_time: f64, + #[serde(rename = "num_messages")] + pub num_messages: i32, + #[serde(rename = "num_participants")] + pub num_participants: i32, + #[serde(rename = "first_sender")] + pub first_sender: String, + #[serde(rename = "thread_position", skip_serializing_if = "Option::is_none")] + pub thread_position: Option, +} + +impl GetSourceCommentsResponseThreadPropertiesInner { + pub fn new(duration: f64, response_time: f64, num_messages: i32, num_participants: i32, first_sender: String) -> GetSourceCommentsResponseThreadPropertiesInner { + GetSourceCommentsResponseThreadPropertiesInner { + duration, + response_time, + num_messages, + num_participants, + first_sender, + thread_position: None, + } + } +} + diff --git a/api/src/models/get_source_response.rs b/api/src/models/get_source_response.rs new file mode 100644 index 00000000..43b9e979 --- /dev/null +++ b/api/src/models/get_source_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "source")] + pub source: Box, +} + +impl GetSourceResponse { + pub fn new(status: Status, source: models::Source) -> GetSourceResponse { + GetSourceResponse { + status, + source: Box::new(source), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_source_statistics_request.rs b/api/src/models/get_source_statistics_request.rs new file mode 100644 index 00000000..669e4dd2 --- /dev/null +++ b/api/src/models/get_source_statistics_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceStatisticsRequest { + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, +} + +impl GetSourceStatisticsRequest { + pub fn new() -> GetSourceStatisticsRequest { + GetSourceStatisticsRequest { + comment_filter: None, + } + } +} + diff --git a/api/src/models/get_source_statistics_response.rs b/api/src/models/get_source_statistics_response.rs new file mode 100644 index 00000000..a1a62c29 --- /dev/null +++ b/api/src/models/get_source_statistics_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSourceStatisticsResponse { + #[serde(rename = "status")] + pub status: Status, + /// Source statistics + #[serde(rename = "statistics")] + pub statistics: Box, +} + +impl GetSourceStatisticsResponse { + pub fn new(status: Status, statistics: models::SourceStatistics) -> GetSourceStatisticsResponse { + GetSourceStatisticsResponse { + status, + statistics: Box::new(statistics), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_stream_by_name_response.rs b/api/src/models/get_stream_by_name_response.rs new file mode 100644 index 00000000..6c86b8f3 --- /dev/null +++ b/api/src/models/get_stream_by_name_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetStreamByNameResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "stream")] + pub stream: Box, +} + +impl GetStreamByNameResponse { + pub fn new(status: Status, stream: models::Trigger) -> GetStreamByNameResponse { + GetStreamByNameResponse { + status, + stream: Box::new(stream), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_stream_results_response.rs b/api/src/models/get_stream_results_response.rs new file mode 100644 index 00000000..5e9345b9 --- /dev/null +++ b/api/src/models/get_stream_results_response.rs @@ -0,0 +1,59 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetStreamResultsResponse { + /// `ok` if request was successful, `error` otherwise + #[serde(rename = "status")] + pub status: Status, + /// New comments since last advance, with their predictions if the stream has a model selected. + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "model", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model: Option>>, + /// How many comments were downloaded but filtered out by the stream's filter. + #[serde(rename = "num_filtered")] + pub num_filtered: i32, + /// True if there are more results after this batch---calling `fetch` after `advance` will return more results. + #[serde(rename = "more_results")] + pub more_results: bool, + /// An opaque token that can be used to advance the trigger past the results in `results`. Individual results also contain `continuation`-s, but if you want to advance past ALL the results from this response, use this value as it will potentially advance past additional filtered values. + #[serde(rename = "continuation")] + pub continuation: String, +} + +impl GetStreamResultsResponse { + pub fn new(status: Status, results: Vec, num_filtered: i32, more_results: bool, continuation: String) -> GetStreamResultsResponse { + GetStreamResultsResponse { + status, + results, + model: None, + num_filtered, + more_results, + continuation, + } + } +} +/// `ok` if request was successful, `error` otherwise +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_subdomain_response.rs b/api/src/models/get_subdomain_response.rs new file mode 100644 index 00000000..6269d182 --- /dev/null +++ b/api/src/models/get_subdomain_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetSubdomainResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "subdomain", deserialize_with = "Option::deserialize")] + pub subdomain: Option, +} + +impl GetSubdomainResponse { + pub fn new(status: Status, subdomain: Option) -> GetSubdomainResponse { + GetSubdomainResponse { + status, + subdomain, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenant_client_subnets_response.rs b/api/src/models/get_tenant_client_subnets_response.rs new file mode 100644 index 00000000..f2b36aae --- /dev/null +++ b/api/src/models/get_tenant_client_subnets_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantClientSubnetsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "client_subnets")] + pub client_subnets: Vec, +} + +impl GetTenantClientSubnetsResponse { + pub fn new(status: Status, client_subnets: Vec) -> GetTenantClientSubnetsResponse { + GetTenantClientSubnetsResponse { + status, + client_subnets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenant_default_project_permissions_response.rs b/api/src/models/get_tenant_default_project_permissions_response.rs new file mode 100644 index 00000000..770a7daa --- /dev/null +++ b/api/src/models/get_tenant_default_project_permissions_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantDefaultProjectPermissionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "default_project_permissions")] + pub default_project_permissions: Vec, +} + +impl GetTenantDefaultProjectPermissionsResponse { + pub fn new(status: Status, default_project_permissions: Vec) -> GetTenantDefaultProjectPermissionsResponse { + GetTenantDefaultProjectPermissionsResponse { + status, + default_project_permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenant_domains_response.rs b/api/src/models/get_tenant_domains_response.rs new file mode 100644 index 00000000..1f4a8e62 --- /dev/null +++ b/api/src/models/get_tenant_domains_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantDomainsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "domains")] + pub domains: Vec, +} + +impl GetTenantDomainsResponse { + pub fn new(status: Status, domains: Vec) -> GetTenantDomainsResponse { + GetTenantDomainsResponse { + status, + domains, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenant_entity_def_ids_response.rs b/api/src/models/get_tenant_entity_def_ids_response.rs new file mode 100644 index 00000000..073ccdb1 --- /dev/null +++ b/api/src/models/get_tenant_entity_def_ids_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantEntityDefIdsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "entity_def_ids")] + pub entity_def_ids: Vec, +} + +impl GetTenantEntityDefIdsResponse { + pub fn new(status: Status, entity_def_ids: Vec) -> GetTenantEntityDefIdsResponse { + GetTenantEntityDefIdsResponse { + status, + entity_def_ids, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenant_quota_response.rs b/api/src/models/get_tenant_quota_response.rs new file mode 100644 index 00000000..5665a50e --- /dev/null +++ b/api/src/models/get_tenant_quota_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantQuotaResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "quotas")] + pub quotas: Vec, +} + +impl GetTenantQuotaResponse { + pub fn new(status: Status, quotas: Vec) -> GetTenantQuotaResponse { + GetTenantQuotaResponse { + status, + quotas, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_tenants_response.rs b/api/src/models/get_tenants_response.rs new file mode 100644 index 00000000..ce8fc09b --- /dev/null +++ b/api/src/models/get_tenants_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTenantsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "tenants")] + pub tenants: Vec, +} + +impl GetTenantsResponse { + pub fn new(status: Status, tenants: Vec) -> GetTenantsResponse { + GetTenantsResponse { + status, + tenants, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_themes_response.rs b/api/src/models/get_themes_response.rs new file mode 100644 index 00000000..ae80053e --- /dev/null +++ b/api/src/models/get_themes_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetThemesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "theme_set", deserialize_with = "Option::deserialize")] + pub theme_set: Option>, + #[serde(rename = "available_models", skip_serializing_if = "Option::is_none")] + pub available_models: Option>, +} + +impl GetThemesResponse { + pub fn new(status: Status, theme_set: Option) -> GetThemesResponse { + GetThemesResponse { + status, + theme_set: theme_set.map(Box::new), + available_models: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_thread_themes_request.rs b/api/src/models/get_thread_themes_request.rs new file mode 100644 index 00000000..eefa5c89 --- /dev/null +++ b/api/src/models/get_thread_themes_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetThreadThemesRequest { + /// ID of the source containing the comment + #[serde(rename = "source_id")] + pub source_id: String, + /// ID of thread in external system + #[serde(rename = "thread_id")] + pub thread_id: String, +} + +impl GetThreadThemesRequest { + pub fn new(source_id: String, thread_id: String) -> GetThreadThemesRequest { + GetThreadThemesRequest { + source_id, + thread_id, + } + } +} + diff --git a/api/src/models/get_thread_themes_response.rs b/api/src/models/get_thread_themes_response.rs new file mode 100644 index 00000000..8d8f98a9 --- /dev/null +++ b/api/src/models/get_thread_themes_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetThreadThemesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "thread_themes")] + pub thread_themes: Vec, +} + +impl GetThreadThemesResponse { + pub fn new(status: Status, thread_themes: Vec) -> GetThreadThemesResponse { + GetThreadThemesResponse { + status, + thread_themes, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_threads_by_source_response.rs b/api/src/models/get_threads_by_source_response.rs new file mode 100644 index 00000000..a6ab9d1b --- /dev/null +++ b/api/src/models/get_threads_by_source_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetThreadsBySourceResponse { + #[serde(rename = "status")] + pub status: Status, + /// List of comment threads + #[serde(rename = "threads")] + pub threads: Vec, +} + +impl GetThreadsBySourceResponse { + pub fn new(status: Status, threads: Vec) -> GetThreadsBySourceResponse { + GetThreadsBySourceResponse { + status, + threads, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_training_actions_comment_uids_response.rs b/api/src/models/get_training_actions_comment_uids_response.rs new file mode 100644 index 00000000..5ae15e66 --- /dev/null +++ b/api/src/models/get_training_actions_comment_uids_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTrainingActionsCommentUidsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "comment_uids")] + pub comment_uids: Vec, +} + +impl GetTrainingActionsCommentUidsResponse { + pub fn new(status: Status, comment_uids: Vec) -> GetTrainingActionsCommentUidsResponse { + GetTrainingActionsCommentUidsResponse { + status, + comment_uids, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_training_actions_labels_response.rs b/api/src/models/get_training_actions_labels_response.rs new file mode 100644 index 00000000..304e03f2 --- /dev/null +++ b/api/src/models/get_training_actions_labels_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTrainingActionsLabelsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "training_actions_labels")] + pub training_actions_labels: Vec, +} + +impl GetTrainingActionsLabelsResponse { + pub fn new(status: Status, training_actions_labels: Vec) -> GetTrainingActionsLabelsResponse { + GetTrainingActionsLabelsResponse { + status, + training_actions_labels, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_training_actions_labels_response_training_actions_labels_inner.rs b/api/src/models/get_training_actions_labels_response_training_actions_labels_inner.rs new file mode 100644 index 00000000..0038184c --- /dev/null +++ b/api/src/models/get_training_actions_labels_response_training_actions_labels_inner.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTrainingActionsLabelsResponseTrainingActionsLabelsInner { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "plan")] + pub plan: Box, + #[serde(rename = "factor_kind")] + pub factor_kind: models::ModelRatingFactorKind, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "sub_kind")] + pub sub_kind: String, + #[serde(rename = "search_term", skip_serializing_if = "Option::is_none")] + pub search_term: Option, +} + +impl GetTrainingActionsLabelsResponseTrainingActionsLabelsInner { + pub fn new(id: String, kind: Kind, plan: models::LabelAction, factor_kind: models::ModelRatingFactorKind, quality: models::DatasetQuality, sub_kind: String) -> GetTrainingActionsLabelsResponseTrainingActionsLabelsInner { + GetTrainingActionsLabelsResponseTrainingActionsLabelsInner { + id, + kind, + plan: Box::new(plan), + factor_kind, + quality, + sub_kind, + search_term: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "label")] + Label, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Label + } +} + diff --git a/api/src/models/get_trigger_response.rs b/api/src/models/get_trigger_response.rs new file mode 100644 index 00000000..093a83bc --- /dev/null +++ b/api/src/models/get_trigger_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl GetTriggerResponse { + pub fn new(status: Status, trigger: models::Trigger) -> GetTriggerResponse { + GetTriggerResponse { + status, + trigger: Box::new(trigger), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_user_by_id_response.rs b/api/src/models/get_user_by_id_response.rs new file mode 100644 index 00000000..e35cdd60 --- /dev/null +++ b/api/src/models/get_user_by_id_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetUserByIdResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "user")] + pub user: Box, +} + +impl GetUserByIdResponse { + pub fn new(status: Status, user: models::User) -> GetUserByIdResponse { + GetUserByIdResponse { + status, + user: Box::new(user), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_users_response.rs b/api/src/models/get_users_response.rs new file mode 100644 index 00000000..231c1646 --- /dev/null +++ b/api/src/models/get_users_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetUsersResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "users")] + pub users: Vec, +} + +impl GetUsersResponse { + pub fn new(status: Status, users: Vec) -> GetUsersResponse { + GetUsersResponse { + status, + users, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_users_v1_response.rs b/api/src/models/get_users_v1_response.rs new file mode 100644 index 00000000..dd2f9fd6 --- /dev/null +++ b/api/src/models/get_users_v1_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetUsersV1Response { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "users")] + pub users: Vec, +} + +impl GetUsersV1Response { + pub fn new(status: Status, users: Vec) -> GetUsersV1Response { + GetUsersV1Response { + status, + users, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_validation_response.rs b/api/src/models/get_validation_response.rs new file mode 100644 index 00000000..7eb7a709 --- /dev/null +++ b/api/src/models/get_validation_response.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetValidationResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + #[serde(rename = "label_groups")] + pub label_groups: Vec, + #[serde(rename = "validation")] + pub validation: Box, + #[serde(rename = "moon", skip_serializing_if = "Option::is_none")] + pub moon: Option>, +} + +impl GetValidationResponse { + pub fn new(status: Status, entity_defs: Vec, label_groups: Vec, validation: models::ValidationSummary) -> GetValidationResponse { + GetValidationResponse { + status, + entity_defs, + label_groups, + validation: Box::new(validation), + moon: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/get_validation_v1_response.rs b/api/src/models/get_validation_v1_response.rs new file mode 100644 index 00000000..3ba187d9 --- /dev/null +++ b/api/src/models/get_validation_v1_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GetValidationV1Response { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "validation")] + pub validation: Box, +} + +impl GetValidationV1Response { + pub fn new(status: Status, validation: models::ValidationSummaryV1) -> GetValidationV1Response { + GetValidationV1Response { + status, + validation: Box::new(validation), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/global_permission.rs b/api/src/models/global_permission.rs new file mode 100644 index 00000000..c4f96a5d --- /dev/null +++ b/api/src/models/global_permission.rs @@ -0,0 +1,87 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GlobalPermission : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum GlobalPermission { + #[serde(rename = "root")] + Root, + #[serde(rename = "debug")] + Debug, + #[serde(rename = "demo")] + Demo, + #[serde(rename = "audit-read")] + AuditRead, + #[serde(rename = "artefacts-read")] + ArtefactsRead, + #[serde(rename = "support-users-write")] + SupportUsersWrite, + #[serde(rename = "tenant-users-read")] + TenantUsersRead, + #[serde(rename = "tenant-admin")] + TenantAdmin, + #[serde(rename = "support-tenant-admin")] + SupportTenantAdmin, + #[serde(rename = "feature-qos")] + FeatureQos, + #[serde(rename = "feature-pretrained-labels")] + FeaturePretrainedLabels, + #[serde(rename = "tenant-quota-read")] + TenantQuotaRead, + #[serde(rename = "tenant-quota-write")] + TenantQuotaWrite, + #[serde(rename = "deployment-quota-read")] + DeploymentQuotaRead, + #[serde(rename = "deployment-quota-write")] + DeploymentQuotaWrite, + #[serde(rename = "role-cm-tenant-admin")] + RoleCmTenantAdmin, + #[serde(rename = "dialog")] + Dialog, + #[serde(rename = "projects-admin")] + ProjectsAdmin, + +} + +impl std::fmt::Display for GlobalPermission { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Root => write!(f, "root"), + Self::Debug => write!(f, "debug"), + Self::Demo => write!(f, "demo"), + Self::AuditRead => write!(f, "audit-read"), + Self::ArtefactsRead => write!(f, "artefacts-read"), + Self::SupportUsersWrite => write!(f, "support-users-write"), + Self::TenantUsersRead => write!(f, "tenant-users-read"), + Self::TenantAdmin => write!(f, "tenant-admin"), + Self::SupportTenantAdmin => write!(f, "support-tenant-admin"), + Self::FeatureQos => write!(f, "feature-qos"), + Self::FeaturePretrainedLabels => write!(f, "feature-pretrained-labels"), + Self::TenantQuotaRead => write!(f, "tenant-quota-read"), + Self::TenantQuotaWrite => write!(f, "tenant-quota-write"), + Self::DeploymentQuotaRead => write!(f, "deployment-quota-read"), + Self::DeploymentQuotaWrite => write!(f, "deployment-quota-write"), + Self::RoleCmTenantAdmin => write!(f, "role-cm-tenant-admin"), + Self::Dialog => write!(f, "dialog"), + Self::ProjectsAdmin => write!(f, "projects-admin"), + } + } +} + +impl Default for GlobalPermission { + fn default() -> GlobalPermission { + Self::Root + } +} + diff --git a/api/src/models/gpt_ixp_flag.rs b/api/src/models/gpt_ixp_flag.rs new file mode 100644 index 00000000..e4beb422 --- /dev/null +++ b/api/src/models/gpt_ixp_flag.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GptIxpFlag : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum GptIxpFlag { + #[serde(rename = "append_taxonomy_descriptions")] + TaxonomyDescriptions, + #[serde(rename = "append_type_descriptions")] + TypeDescriptions, + #[serde(rename = "append_group_descriptions")] + GroupDescriptions, + #[serde(rename = "append_field_descriptions")] + FieldDescriptions, + +} + +impl std::fmt::Display for GptIxpFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::TaxonomyDescriptions => write!(f, "append_taxonomy_descriptions"), + Self::TypeDescriptions => write!(f, "append_type_descriptions"), + Self::GroupDescriptions => write!(f, "append_group_descriptions"), + Self::FieldDescriptions => write!(f, "append_field_descriptions"), + } + } +} + +impl Default for GptIxpFlag { + fn default() -> GptIxpFlag { + Self::TaxonomyDescriptions + } +} + diff --git a/api/src/models/gpt_ixp_model_config.rs b/api/src/models/gpt_ixp_model_config.rs new file mode 100644 index 00000000..60804333 --- /dev/null +++ b/api/src/models/gpt_ixp_model_config.rs @@ -0,0 +1,68 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GptIxpModelConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "model_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model_version: Option>, + #[serde(rename = "input_config", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub input_config: Option>>, + #[serde(rename = "system_prompt_override", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub system_prompt_override: Option>, + #[serde(rename = "frequency_penalty", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub frequency_penalty: Option>, + #[serde(rename = "temperature", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub temperature: Option>, + #[serde(rename = "top_p", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub top_p: Option>, + #[serde(rename = "seed", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub seed: Option>, + #[serde(rename = "flags")] + pub flags: Vec, + #[serde(rename = "iterative_config", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub iterative_config: Option>>, + #[serde(rename = "attribution_method")] + pub attribution_method: models::AttributionMethod, +} + +impl GptIxpModelConfig { + pub fn new(flags: Vec, attribution_method: models::AttributionMethod) -> GptIxpModelConfig { + GptIxpModelConfig { + kind: None, + model_version: None, + input_config: None, + system_prompt_override: None, + frequency_penalty: None, + temperature: None, + top_p: None, + seed: None, + flags, + iterative_config: None, + attribution_method, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "gpt_ixp")] + GptIxp, +} + +impl Default for Kind { + fn default() -> Kind { + Self::GptIxp + } +} + diff --git a/api/src/models/gpt_model_version.rs b/api/src/models/gpt_model_version.rs new file mode 100644 index 00000000..670b5da8 --- /dev/null +++ b/api/src/models/gpt_model_version.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GptModelVersion : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum GptModelVersion { + #[serde(rename = "gpt_4o_2024_05_13")] + Gpt4o20240513, + #[serde(rename = "gemini_2_5_flash")] + Gemini25Flash, + +} + +impl std::fmt::Display for GptModelVersion { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Gpt4o20240513 => write!(f, "gpt_4o_2024_05_13"), + Self::Gemini25Flash => write!(f, "gemini_2_5_flash"), + } + } +} + +impl Default for GptModelVersion { + fn default() -> GptModelVersion { + Self::Gpt4o20240513 + } +} + diff --git a/api/src/models/graph_api_model.rs b/api/src/models/graph_api_model.rs new file mode 100644 index 00000000..216f4453 --- /dev/null +++ b/api/src/models/graph_api_model.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GraphApiModel { + #[serde(rename = "kind")] + pub kind: models::GraphApiModelKind, +} + +impl GraphApiModel { + pub fn new(kind: models::GraphApiModelKind) -> GraphApiModel { + GraphApiModel { + kind, + } + } +} + diff --git a/api/src/models/graph_api_model_kind.rs b/api/src/models/graph_api_model_kind.rs new file mode 100644 index 00000000..c2b8b564 --- /dev/null +++ b/api/src/models/graph_api_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// GraphApiModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum GraphApiModelKind { + #[serde(rename = "graph")] + Graph, + +} + +impl std::fmt::Display for GraphApiModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Graph => write!(f, "graph"), + } + } +} + +impl Default for GraphApiModelKind { + fn default() -> GraphApiModelKind { + Self::Graph + } +} + diff --git a/api/src/models/group_labellings_request.rs b/api/src/models/group_labellings_request.rs new file mode 100644 index 00000000..64571201 --- /dev/null +++ b/api/src/models/group_labellings_request.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GroupLabellingsRequest { + #[serde(rename = "assigned", skip_serializing_if = "Option::is_none")] + pub assigned: Option>, + #[serde(rename = "dismissed", skip_serializing_if = "Option::is_none")] + pub dismissed: Option>, + #[serde(rename = "uninformative", skip_serializing_if = "Option::is_none")] + pub uninformative: Option>, + #[serde(rename = "group", skip_serializing_if = "Option::is_none")] + pub group: Option, +} + +impl GroupLabellingsRequest { + pub fn new() -> GroupLabellingsRequest { + GroupLabellingsRequest { + assigned: None, + dismissed: None, + uninformative: None, + group: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Group { + #[serde(rename = "default")] + Default, +} + +impl Default for Group { + fn default() -> Group { + Self::Default + } +} + diff --git a/api/src/models/group_predictions.rs b/api/src/models/group_predictions.rs new file mode 100644 index 00000000..97324549 --- /dev/null +++ b/api/src/models/group_predictions.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct GroupPredictions { + #[serde(rename = "group")] + pub group: Group, + #[serde(rename = "extractions")] + pub extractions: Vec, +} + +impl GroupPredictions { + pub fn new(group: Group, extractions: Vec) -> GroupPredictions { + GroupPredictions { + group, + extractions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Group { + #[serde(rename = "default")] + Default, +} + +impl Default for Group { + fn default() -> Group { + Self::Default + } +} + diff --git a/api/src/models/headers.rs b/api/src/models/headers.rs new file mode 100644 index 00000000..1603b1bc --- /dev/null +++ b/api/src/models/headers.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Headers : An object containing the headers of the email +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Headers { + #[serde(rename = "parsed")] + pub parsed: std::collections::HashMap, + #[serde(rename = "raw")] + pub raw: String, +} + +impl Headers { + /// An object containing the headers of the email + pub fn new(parsed: std::collections::HashMap, raw: String) -> Headers { + Headers { + parsed, + raw, + } + } +} + diff --git a/api/src/models/highlight.rs b/api/src/models/highlight.rs new file mode 100644 index 00000000..87fa65b6 --- /dev/null +++ b/api/src/models/highlight.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Highlight { + #[serde(rename = "span")] + pub span: Box, +} + +impl Highlight { + pub fn new(span: models::TextSpan) -> Highlight { + Highlight { + span: Box::new(span), + } + } +} + diff --git a/api/src/models/histogram_bin.rs b/api/src/models/histogram_bin.rs new file mode 100644 index 00000000..9a1afad2 --- /dev/null +++ b/api/src/models/histogram_bin.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct HistogramBin { + #[serde(rename = "min", deserialize_with = "Option::deserialize")] + pub min: Option, + #[serde(rename = "max", deserialize_with = "Option::deserialize")] + pub max: Option, + #[serde(rename = "num_comments")] + pub num_comments: f64, + #[serde(rename = "num_labels")] + pub num_labels: Vec, +} + +impl HistogramBin { + pub fn new(min: Option, max: Option, num_comments: f64, num_labels: Vec) -> HistogramBin { + HistogramBin { + min, + max, + num_comments, + num_labels, + } + } +} + diff --git a/api/src/models/image_input_config.rs b/api/src/models/image_input_config.rs new file mode 100644 index 00000000..2d444804 --- /dev/null +++ b/api/src/models/image_input_config.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ImageInputConfig { + #[serde(rename = "mode", skip_serializing_if = "Option::is_none")] + pub mode: Option, +} + +impl ImageInputConfig { + pub fn new() -> ImageInputConfig { + ImageInputConfig { + mode: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Mode { + #[serde(rename = "image_only")] + ImageOnly, +} + +impl Default for Mode { + fn default() -> Mode { + Self::ImageOnly + } +} + diff --git a/api/src/models/import_taxonomy_request.rs b/api/src/models/import_taxonomy_request.rs new file mode 100644 index 00000000..c488c73b --- /dev/null +++ b/api/src/models/import_taxonomy_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ImportTaxonomyRequest { + /// Entity Defs to be imported + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + /// Label Groups to be imported + #[serde(rename = "label_groups")] + pub label_groups: Vec, + /// Overwrite duplicates + #[serde(rename = "overwrite_duplicates")] + pub overwrite_duplicates: bool, +} + +impl ImportTaxonomyRequest { + pub fn new(entity_defs: Vec, label_groups: Vec, overwrite_duplicates: bool) -> ImportTaxonomyRequest { + ImportTaxonomyRequest { + entity_defs, + label_groups, + overwrite_duplicates, + } + } +} + diff --git a/api/src/models/import_taxonomy_response.rs b/api/src/models/import_taxonomy_response.rs new file mode 100644 index 00000000..22f52b6c --- /dev/null +++ b/api/src/models/import_taxonomy_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ImportTaxonomyResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl ImportTaxonomyResponse { + pub fn new(status: Status) -> ImportTaxonomyResponse { + ImportTaxonomyResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/inference_stats.rs b/api/src/models/inference_stats.rs new file mode 100644 index 00000000..b714e80b --- /dev/null +++ b/api/src/models/inference_stats.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct InferenceStats { + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "comments")] + pub comments: i32, + #[serde(rename = "inference_complete")] + pub inference_complete: f64, +} + +impl InferenceStats { + pub fn new(timestamp: String, comments: i32, inference_complete: f64) -> InferenceStats { + InferenceStats { + timestamp, + comments, + inference_complete, + } + } +} + diff --git a/api/src/models/inherits_from.rs b/api/src/models/inherits_from.rs new file mode 100644 index 00000000..15d493f5 --- /dev/null +++ b/api/src/models/inherits_from.rs @@ -0,0 +1,16 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use serde::{Deserialize, Serialize}; + +/// InheritsFrom - Fixed version that correctly defines InheritsFrom as Vec. +/// The generated version incorrectly created an empty struct, +/// but the OpenAPI spec defines it as an array of strings (entity IDs). +pub type InheritsFrom = Vec; diff --git a/api/src/models/input_config.rs b/api/src/models/input_config.rs new file mode 100644 index 00000000..86c6cb01 --- /dev/null +++ b/api/src/models/input_config.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct InputConfig { + #[serde(rename = "mode", skip_serializing_if = "Option::is_none")] + pub mode: Option, + #[serde(rename = "text_config")] + pub text_config: Box, +} + +impl InputConfig { + pub fn new(text_config: models::TextConfig) -> InputConfig { + InputConfig { + mode: None, + text_config: Box::new(text_config), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Mode { + #[serde(rename = "text_plus_image")] + TextPlusImage, +} + +impl Default for Mode { + fn default() -> Mode { + Self::TextPlusImage + } +} + diff --git a/api/src/models/integration.rs b/api/src/models/integration.rs new file mode 100644 index 00000000..341b0bec --- /dev/null +++ b/api/src/models/integration.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Integration { + /// Unique ID of the integration + #[serde(rename = "id")] + pub id: String, + /// The project which owns the integration + #[serde(rename = "owner")] + pub owner: String, + /// The API name of the integration + #[serde(rename = "name")] + pub name: String, + /// A short description of the source + #[serde(rename = "title")] + pub title: String, + /// Timestamp when the integration was created + #[serde(rename = "created_at")] + pub created_at: String, + /// Timestamp when the integration was last updated + #[serde(rename = "updated_at")] + pub updated_at: String, + /// Custom settings to configure the integration + #[serde(rename = "configuration")] + pub configuration: serde_json::Value, + /// If this integration is active + #[serde(rename = "enabled")] + pub enabled: bool, + /// The type of the integration + #[serde(rename = "type")] + pub r#type: models::IntegrationType, + /// Reason for which the integration was disabled + #[serde(rename = "disabled_reason", skip_serializing_if = "Option::is_none")] + pub disabled_reason: Option, +} + +impl Integration { + pub fn new(id: String, owner: String, name: String, title: String, created_at: String, updated_at: String, configuration: serde_json::Value, enabled: bool, r#type: models::IntegrationType) -> Integration { + Integration { + id, + owner, + name, + title, + created_at, + updated_at, + configuration, + enabled, + r#type, + disabled_reason: None, + } + } +} + diff --git a/api/src/models/integration_disabled_reason.rs b/api/src/models/integration_disabled_reason.rs new file mode 100644 index 00000000..09db3e86 --- /dev/null +++ b/api/src/models/integration_disabled_reason.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// IntegrationDisabledReason : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum IntegrationDisabledReason { + #[serde(rename = "user")] + User, + #[serde(rename = "quota")] + Quota, + #[serde(rename = "sync_error")] + SyncError, + +} + +impl std::fmt::Display for IntegrationDisabledReason { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::User => write!(f, "user"), + Self::Quota => write!(f, "quota"), + Self::SyncError => write!(f, "sync_error"), + } + } +} + +impl Default for IntegrationDisabledReason { + fn default() -> IntegrationDisabledReason { + Self::User + } +} + diff --git a/api/src/models/integration_error.rs b/api/src/models/integration_error.rs new file mode 100644 index 00000000..b946b698 --- /dev/null +++ b/api/src/models/integration_error.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntegrationError { + /// Unique ID of the error + #[serde(rename = "id")] + pub id: String, + /// Unique ID of the integration + #[serde(rename = "integration_id")] + pub integration_id: String, + /// The message on the thrown error + #[serde(rename = "error_text")] + pub error_text: String, + /// The type of server error that occurred + #[serde(rename = "error_details")] + pub error_details: Box, + #[serde(rename = "error_action")] + pub error_action: Box, + /// Timestamp when the error was created + #[serde(rename = "created_at")] + pub created_at: String, + /// Timestamp when a notification was sent if possible + #[serde(rename = "processed_at", skip_serializing_if = "Option::is_none")] + pub processed_at: Option, +} + +impl IntegrationError { + pub fn new(id: String, integration_id: String, error_text: String, error_details: models::IntegrationErrorDetails, error_action: models::ErrorAction, created_at: String) -> IntegrationError { + IntegrationError { + id, + integration_id, + error_text, + error_details: Box::new(error_details), + error_action: Box::new(error_action), + created_at, + processed_at: None, + } + } +} + diff --git a/api/src/models/integration_error_details.rs b/api/src/models/integration_error_details.rs new file mode 100644 index 00000000..f46362eb --- /dev/null +++ b/api/src/models/integration_error_details.rs @@ -0,0 +1,64 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntegrationErrorDetails { + /// A known error type which is explicitlyhandled for integration syncing + #[serde(rename = "kind")] + pub kind: Kind, + /// A verbose error text for the integration sync server error + #[serde(rename = "full_error_text")] + pub full_error_text: String, +} + +impl IntegrationErrorDetails { + pub fn new(kind: Kind, full_error_text: String) -> IntegrationErrorDetails { + IntegrationErrorDetails { + kind, + full_error_text, + } + } +} +/// A known error type which is explicitlyhandled for integration syncing +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "mailbox_not_found")] + MailboxNotFound, + #[serde(rename = "invalid_exchange_credentials")] + InvalidExchangeCredentials, + #[serde(rename = "comment_quota_hit")] + CommentQuotaHit, + #[serde(rename = "mailbox_inbox_not_found")] + MailboxInboxNotFound, + #[serde(rename = "mailbox_removed")] + MailboxRemoved, + #[serde(rename = "app_access_insufficient_scopes")] + AppAccessInsufficientScopes, + #[serde(rename = "unknown_forbidden_error")] + UnknownForbiddenError, + #[serde(rename = "mailbox_primary_address_not_found")] + MailboxPrimaryAddressNotFound, + #[serde(rename = "syncemail_consumption_limit_exceeded")] + SyncemailConsumptionLimitExceeded, + #[serde(rename = "mailbox_access_denied")] + MailboxAccessDenied, + #[serde(rename = "mailbox_invalid_license")] + MailboxInvalidLicense, +} + +impl Default for Kind { + fn default() -> Kind { + Self::MailboxNotFound + } +} + diff --git a/api/src/models/integration_new.rs b/api/src/models/integration_new.rs new file mode 100644 index 00000000..38ceb494 --- /dev/null +++ b/api/src/models/integration_new.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntegrationNew { + #[serde(rename = "integration_type")] + pub integration_type: models::IntegrationType, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "configuration", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub configuration: Option>, + #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")] + pub enabled: Option, + #[serde(rename = "disabled_reason", skip_serializing_if = "Option::is_none")] + pub disabled_reason: Option, +} + +impl IntegrationNew { + pub fn new(integration_type: models::IntegrationType) -> IntegrationNew { + IntegrationNew { + integration_type, + title: None, + configuration: None, + enabled: None, + disabled_reason: None, + } + } +} + diff --git a/api/src/models/integration_type.rs b/api/src/models/integration_type.rs new file mode 100644 index 00000000..67c7d0ef --- /dev/null +++ b/api/src/models/integration_type.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// IntegrationType : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum IntegrationType { + #[serde(rename = "salesforce")] + Salesforce, + #[serde(rename = "exchange_online")] + ExchangeOnline, + +} + +impl std::fmt::Display for IntegrationType { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Salesforce => write!(f, "salesforce"), + Self::ExchangeOnline => write!(f, "exchange_online"), + } + } +} + +impl Default for IntegrationType { + fn default() -> IntegrationType { + Self::Salesforce + } +} + diff --git a/api/src/models/integration_update.rs b/api/src/models/integration_update.rs new file mode 100644 index 00000000..a988717f --- /dev/null +++ b/api/src/models/integration_update.rs @@ -0,0 +1,37 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntegrationUpdate { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "configuration", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub configuration: Option>, + #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")] + pub enabled: Option, + /// Timestamp when the integration was last updated + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, +} + +impl IntegrationUpdate { + pub fn new() -> IntegrationUpdate { + IntegrationUpdate { + title: None, + configuration: None, + enabled: None, + updated_at: None, + } + } +} + diff --git a/api/src/models/integrations_o_auth2_authenticate_response.rs b/api/src/models/integrations_o_auth2_authenticate_response.rs new file mode 100644 index 00000000..108bf231 --- /dev/null +++ b/api/src/models/integrations_o_auth2_authenticate_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntegrationsOAuth2AuthenticateResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "state")] + pub state: String, + #[serde(rename = "redirect_uri")] + pub redirect_uri: String, +} + +impl IntegrationsOAuth2AuthenticateResponse { + pub fn new(status: Status, state: String, redirect_uri: String) -> IntegrationsOAuth2AuthenticateResponse { + IntegrationsOAuth2AuthenticateResponse { + status, + state, + redirect_uri, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/intent_threshold.rs b/api/src/models/intent_threshold.rs new file mode 100644 index 00000000..ce7054af --- /dev/null +++ b/api/src/models/intent_threshold.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntentThreshold { +} + +impl IntentThreshold { + pub fn new() -> IntentThreshold { + IntentThreshold { + } + } +} + diff --git a/api/src/models/intent_validation.rs b/api/src/models/intent_validation.rs new file mode 100644 index 00000000..5cf03426 --- /dev/null +++ b/api/src/models/intent_validation.rs @@ -0,0 +1,66 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntentValidation { + #[serde(rename = "average_precision", deserialize_with = "Option::deserialize")] + pub average_precision: Option, + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "recalls")] + pub recalls: Vec, + #[serde(rename = "test_error_count")] + pub test_error_count: f64, + #[serde(rename = "test_expected_count")] + pub test_expected_count: f64, + #[serde(rename = "precisions")] + pub precisions: Vec, + #[serde(rename = "thresholds")] + pub thresholds: Vec, + #[serde(rename = "optimal_thresholds", deserialize_with = "Option::deserialize")] + pub optimal_thresholds: Option>, + #[serde(rename = "health")] + pub health: Box, + #[serde(rename = "num_test_captures")] + pub num_test_captures: i32, + #[serde(rename = "num_train_captures")] + pub num_train_captures: i32, + #[serde(rename = "num_reviewed_captures")] + pub num_reviewed_captures: i32, +} + +impl IntentValidation { + pub fn new(average_precision: Option, train_size: i32, test_size: i32, reviewed_size: i32, recalls: Vec, test_error_count: f64, test_expected_count: f64, precisions: Vec, thresholds: Vec, optimal_thresholds: Option, health: models::LabelHealth, num_test_captures: i32, num_train_captures: i32, num_reviewed_captures: i32) -> IntentValidation { + IntentValidation { + average_precision, + train_size, + test_size, + reviewed_size, + recalls, + test_error_count, + test_expected_count, + precisions, + thresholds, + optimal_thresholds: optimal_thresholds.map(Box::new), + health: Box::new(health), + num_test_captures, + num_train_captures, + num_reviewed_captures, + } + } +} + diff --git a/api/src/models/intent_validation_summary.rs b/api/src/models/intent_validation_summary.rs new file mode 100644 index 00000000..30e78adb --- /dev/null +++ b/api/src/models/intent_validation_summary.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntentValidationSummary { + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "average_precision", deserialize_with = "Option::deserialize")] + pub average_precision: Option, + #[serde(rename = "optimal_thresholds", deserialize_with = "Option::deserialize")] + pub optimal_thresholds: Option>, + #[serde(rename = "health")] + pub health: Box, + #[serde(rename = "cooccurrence", skip_serializing_if = "Option::is_none")] + pub cooccurrence: Option>, + #[serde(rename = "capture_average_precision", deserialize_with = "Option::deserialize")] + pub capture_average_precision: Option, + #[serde(rename = "num_train_captures")] + pub num_train_captures: i32, + #[serde(rename = "num_test_captures")] + pub num_test_captures: i32, + #[serde(rename = "num_reviewed_captures")] + pub num_reviewed_captures: i32, +} + +impl IntentValidationSummary { + pub fn new(train_size: i32, test_size: i32, reviewed_size: i32, average_precision: Option, optimal_thresholds: Option, health: models::LabelHealth, capture_average_precision: Option, num_train_captures: i32, num_test_captures: i32, num_reviewed_captures: i32) -> IntentValidationSummary { + IntentValidationSummary { + train_size, + test_size, + reviewed_size, + average_precision, + optimal_thresholds: optimal_thresholds.map(Box::new), + health: Box::new(health), + cooccurrence: None, + capture_average_precision, + num_train_captures, + num_test_captures, + num_reviewed_captures, + } + } +} + diff --git a/api/src/models/intents_value.rs b/api/src/models/intents_value.rs new file mode 100644 index 00000000..0ed8d889 --- /dev/null +++ b/api/src/models/intents_value.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IntentsValue { + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "average_precision")] + pub average_precision: f64, + #[serde(rename = "optimal_thresholds")] + pub optimal_thresholds: Box, + #[serde(rename = "health")] + pub health: Box, + #[serde(rename = "cooccurrence", skip_serializing_if = "Option::is_none")] + pub cooccurrence: Option>, + #[serde(rename = "capture_average_precision")] + pub capture_average_precision: f64, + #[serde(rename = "num_train_captures")] + pub num_train_captures: i32, + #[serde(rename = "num_test_captures")] + pub num_test_captures: i32, + #[serde(rename = "num_reviewed_captures")] + pub num_reviewed_captures: i32, +} + +impl IntentsValue { + pub fn new(train_size: i32, test_size: i32, reviewed_size: i32, average_precision: f64, optimal_thresholds: models::OptimalThreshold, health: models::LabelHealth, capture_average_precision: f64, num_train_captures: i32, num_test_captures: i32, num_reviewed_captures: i32) -> IntentsValue { + IntentsValue { + train_size, + test_size, + reviewed_size, + average_precision, + optimal_thresholds: Box::new(optimal_thresholds), + health: Box::new(health), + cooccurrence: None, + capture_average_precision, + num_train_captures, + num_test_captures, + num_reviewed_captures, + } + } +} + diff --git a/api/src/models/interpretation_span.rs b/api/src/models/interpretation_span.rs new file mode 100644 index 00000000..25da730c --- /dev/null +++ b/api/src/models/interpretation_span.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct InterpretationSpan { + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, + /// A value between 1 (relevant) and -1 (irrelevant) which identifies how important the span of text is to the theme + #[serde(rename = "importance")] + pub importance: f64, +} + +impl InterpretationSpan { + pub fn new(utf16_byte_start: i32, utf16_byte_end: i32, importance: f64) -> InterpretationSpan { + InterpretationSpan { + utf16_byte_start, + utf16_byte_end, + importance, + } + } +} + diff --git a/api/src/models/issue.rs b/api/src/models/issue.rs new file mode 100644 index 00000000..945b2843 --- /dev/null +++ b/api/src/models/issue.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Issue { + #[serde(rename = "id")] + pub id: String, + /// The alert this issue is from. + #[serde(rename = "alert_id")] + pub alert_id: String, + /// Issue details + #[serde(rename = "detail")] + pub detail: Box, + /// Issue status + #[serde(rename = "status")] + pub status: models::IssueStatus, +} + +impl Issue { + pub fn new(id: String, alert_id: String, detail: models::IssueDetail, status: models::IssueStatus) -> Issue { + Issue { + id, + alert_id, + detail: Box::new(detail), + status, + } + } +} + diff --git a/api/src/models/issue_detail.rs b/api/src/models/issue_detail.rs new file mode 100644 index 00000000..5fc8bd75 --- /dev/null +++ b/api/src/models/issue_detail.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IssueDetail { + /// The start period (inclusive) this issue is for + #[serde(rename = "start")] + pub start: String, + /// The end period (exclusive) this issue is for + #[serde(rename = "end")] + pub end: String, + /// The value of this issue that triggered the alert. For example, for a volume based alert, the comment volume in this time period. + #[serde(rename = "value")] + pub value: f64, + /// True if this issue is currently ongoing + #[serde(rename = "ongoing")] + pub ongoing: bool, +} + +impl IssueDetail { + pub fn new(start: String, end: String, value: f64, ongoing: bool) -> IssueDetail { + IssueDetail { + start, + end, + value, + ongoing, + } + } +} + diff --git a/api/src/models/issue_status.rs b/api/src/models/issue_status.rs new file mode 100644 index 00000000..3108a7cc --- /dev/null +++ b/api/src/models/issue_status.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// IssueStatus : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum IssueStatus { + #[serde(rename = "active")] + Active, + #[serde(rename = "resolved")] + Resolved, + +} + +impl std::fmt::Display for IssueStatus { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Active => write!(f, "active"), + Self::Resolved => write!(f, "resolved"), + } + } +} + +impl Default for IssueStatus { + fn default() -> IssueStatus { + Self::Active + } +} + diff --git a/api/src/models/iterative_config.rs b/api/src/models/iterative_config.rs new file mode 100644 index 00000000..1cd94712 --- /dev/null +++ b/api/src/models/iterative_config.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IterativeConfig { + #[serde(rename = "max_num_calls", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub max_num_calls: Option>, + #[serde(rename = "chunk_size", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub chunk_size: Option>, +} + +impl IterativeConfig { + pub fn new() -> IterativeConfig { + IterativeConfig { + max_num_calls: None, + chunk_size: None, + } + } +} + diff --git a/api/src/models/ixp_confidence.rs b/api/src/models/ixp_confidence.rs new file mode 100644 index 00000000..bd165231 --- /dev/null +++ b/api/src/models/ixp_confidence.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpConfidence { + /// A confidence value between 0 and 1. + #[serde(rename = "value")] + pub value: f64, +} + +impl IxpConfidence { + pub fn new(value: f64) -> IxpConfidence { + IxpConfidence { + value, + } + } +} + diff --git a/api/src/models/ixp_dataset_new.rs b/api/src/models/ixp_dataset_new.rs new file mode 100644 index 00000000..cc978864 --- /dev/null +++ b/api/src/models/ixp_dataset_new.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpDatasetNew { + #[serde(rename = "name")] + pub name: String, +} + +impl IxpDatasetNew { + pub fn new(name: String) -> IxpDatasetNew { + IxpDatasetNew { + name, + } + } +} + diff --git a/api/src/models/ixp_extraction_status.rs b/api/src/models/ixp_extraction_status.rs new file mode 100644 index 00000000..f04366fe --- /dev/null +++ b/api/src/models/ixp_extraction_status.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// IxpExtractionStatus : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum IxpExtractionStatus { + #[serde(rename = "ready")] + Ready, + #[serde(rename = "not_ready")] + NotReady, + +} + +impl std::fmt::Display for IxpExtractionStatus { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Ready => write!(f, "ready"), + Self::NotReady => write!(f, "not_ready"), + } + } +} + +impl Default for IxpExtractionStatus { + fn default() -> IxpExtractionStatus { + Self::Ready + } +} + diff --git a/api/src/models/ixp_field.rs b/api/src/models/ixp_field.rs new file mode 100644 index 00000000..391dca42 --- /dev/null +++ b/api/src/models/ixp_field.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpField { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", deserialize_with = "Option::deserialize")] + pub instructions: Option, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "rule_set", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub rule_set: Option>>, +} + +impl IxpField { + pub fn new(id: String, name: String, instructions: Option, field_type_id: String) -> IxpField { + IxpField { + id, + name, + instructions, + field_type_id, + rule_set: None, + } + } +} + diff --git a/api/src/models/ixp_field_group.rs b/api/src/models/ixp_field_group.rs new file mode 100644 index 00000000..999143d3 --- /dev/null +++ b/api/src/models/ixp_field_group.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpFieldGroup { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "parent", deserialize_with = "Option::deserialize")] + pub parent: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub instructions: Option>, + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl IxpFieldGroup { + pub fn new(id: String, parent: Option, name: String, fields: Vec) -> IxpFieldGroup { + IxpFieldGroup { + id, + parent, + name, + instructions: None, + fields, + } + } +} + diff --git a/api/src/models/ixp_field_type.rs b/api/src/models/ixp_field_type.rs new file mode 100644 index 00000000..a9911f1d --- /dev/null +++ b/api/src/models/ixp_field_type.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpFieldType { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", deserialize_with = "Option::deserialize")] + pub instructions: Option, + #[serde(rename = "data_type")] + pub data_type: Box, +} + +impl IxpFieldType { + pub fn new(id: String, name: String, instructions: Option, data_type: models::DataType) -> IxpFieldType { + IxpFieldType { + id, + name, + instructions, + data_type: Box::new(data_type), + } + } +} + diff --git a/api/src/models/ixp_model_metadata.rs b/api/src/models/ixp_model_metadata.rs new file mode 100644 index 00000000..f8a07689 --- /dev/null +++ b/api/src/models/ixp_model_metadata.rs @@ -0,0 +1,52 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpModelMetadata { + /// The version of the model + #[serde(rename = "version")] + pub version: i32, + /// The type of model + #[serde(rename = "model_name")] + pub model_name: String, + /// Timestamp when the model was trained + #[serde(rename = "trained_time")] + pub trained_time: String, + /// The description + #[serde(rename = "description")] + pub description: String, + /// Whether the model has been validated + #[serde(rename = "validated")] + pub validated: bool, + /// Relative URL links to related pages + #[serde(rename = "relative_urls")] + pub relative_urls: Box, + /// Model Taxonomy + #[serde(rename = "taxonomy")] + pub taxonomy: Box, +} + +impl IxpModelMetadata { + pub fn new(version: i32, model_name: String, trained_time: String, description: String, validated: bool, relative_urls: models::IxpRelativeUrls, taxonomy: models::IxpTaxonomy) -> IxpModelMetadata { + IxpModelMetadata { + version, + model_name, + trained_time, + description, + validated, + relative_urls: Box::new(relative_urls), + taxonomy: Box::new(taxonomy), + } + } +} + diff --git a/api/src/models/ixp_predict_extractions_response.rs b/api/src/models/ixp_predict_extractions_response.rs new file mode 100644 index 00000000..874771d8 --- /dev/null +++ b/api/src/models/ixp_predict_extractions_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpPredictExtractionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "extraction_status")] + pub extraction_status: models::IxpExtractionStatus, + #[serde(rename = "extraction", deserialize_with = "Option::deserialize")] + pub extraction: Option>, +} + +impl IxpPredictExtractionsResponse { + pub fn new(status: Status, extraction_status: models::IxpExtractionStatus, extraction: Option) -> IxpPredictExtractionsResponse { + IxpPredictExtractionsResponse { + status, + extraction_status, + extraction: extraction.map(Box::new), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/ixp_project.rs b/api/src/models/ixp_project.rs new file mode 100644 index 00000000..d7d664a0 --- /dev/null +++ b/api/src/models/ixp_project.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpProject { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + /// Timestamp when the project was created + #[serde(rename = "created_at")] + pub created_at: String, + /// Relative URL links to related pages + #[serde(rename = "relative_urls")] + pub relative_urls: Box, +} + +impl IxpProject { + pub fn new(id: String, name: String, created_at: String, relative_urls: models::IxpRelativeUrls) -> IxpProject { + IxpProject { + id, + name, + created_at, + relative_urls: Box::new(relative_urls), + } + } +} + diff --git a/api/src/models/ixp_relative_urls.rs b/api/src/models/ixp_relative_urls.rs new file mode 100644 index 00000000..8646e337 --- /dev/null +++ b/api/src/models/ixp_relative_urls.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpRelativeUrls { + #[serde(rename = "measure")] + pub measure: String, + #[serde(rename = "build")] + pub build: String, +} + +impl IxpRelativeUrls { + pub fn new(measure: String, build: String) -> IxpRelativeUrls { + IxpRelativeUrls { + measure, + build, + } + } +} + diff --git a/api/src/models/ixp_taxonomy.rs b/api/src/models/ixp_taxonomy.rs new file mode 100644 index 00000000..b1430b82 --- /dev/null +++ b/api/src/models/ixp_taxonomy.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpTaxonomy { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", deserialize_with = "Option::deserialize")] + pub instructions: Option, + #[serde(rename = "field_groups")] + pub field_groups: Vec, + #[serde(rename = "field_types")] + pub field_types: Vec, +} + +impl IxpTaxonomy { + pub fn new(name: String, instructions: Option, field_groups: Vec, field_types: Vec) -> IxpTaxonomy { + IxpTaxonomy { + id: None, + name, + instructions, + field_groups, + field_types, + } + } +} + diff --git a/api/src/models/ixp_taxonomy_extraction.rs b/api/src/models/ixp_taxonomy_extraction.rs new file mode 100644 index 00000000..a971f483 --- /dev/null +++ b/api/src/models/ixp_taxonomy_extraction.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpTaxonomyExtraction { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "field_groups")] + pub field_groups: Vec, + #[serde(rename = "field_types")] + pub field_types: Vec, +} + +impl IxpTaxonomyExtraction { + pub fn new(name: String, field_groups: Vec, field_types: Vec) -> IxpTaxonomyExtraction { + IxpTaxonomyExtraction { + name, + id: None, + field_groups, + field_types, + } + } +} + diff --git a/api/src/models/ixp_upload_document_response.rs b/api/src/models/ixp_upload_document_response.rs new file mode 100644 index 00000000..8b1c96dd --- /dev/null +++ b/api/src/models/ixp_upload_document_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpUploadDocumentResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "document")] + pub document: Box, +} + +impl IxpUploadDocumentResponse { + pub fn new(status: Status, document: models::IxpUploadedDocument) -> IxpUploadDocumentResponse { + IxpUploadDocumentResponse { + status, + document: Box::new(document), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/ixp_uploaded_document.rs b/api/src/models/ixp_uploaded_document.rs new file mode 100644 index 00000000..89253c92 --- /dev/null +++ b/api/src/models/ixp_uploaded_document.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct IxpUploadedDocument { + #[serde(rename = "id")] + pub id: String, +} + +impl IxpUploadedDocument { + pub fn new(id: String) -> IxpUploadedDocument { + IxpUploadedDocument { + id, + } + } +} + diff --git a/api/src/models/keyed_folder_sync_state.rs b/api/src/models/keyed_folder_sync_state.rs new file mode 100644 index 00000000..ca1a4eff --- /dev/null +++ b/api/src/models/keyed_folder_sync_state.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// KeyedFolderSyncState : Sync state for a specific folder within a mailbox. +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedFolderSyncState { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "folder_id")] + pub folder_id: String, + #[serde(rename = "folder_path")] + pub folder_path: Vec, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub synced_until: Option>, + #[serde(rename = "last_synced_at")] + pub last_synced_at: String, + #[serde(rename = "fingerprint", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option>, +} + +impl KeyedFolderSyncState { + /// Sync state for a specific folder within a mailbox. + pub fn new(mailbox_name: String, folder_id: String, folder_path: Vec, status: models::SyncStatus, last_synced_at: String) -> KeyedFolderSyncState { + KeyedFolderSyncState { + mailbox_name, + folder_id, + folder_path, + status, + synced_until: None, + last_synced_at, + fingerprint: None, + } + } +} + diff --git a/api/src/models/keyed_folder_sync_state_update.rs b/api/src/models/keyed_folder_sync_state_update.rs new file mode 100644 index 00000000..a42793b1 --- /dev/null +++ b/api/src/models/keyed_folder_sync_state_update.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedFolderSyncStateUpdate { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "folder_id")] + pub folder_id: String, + #[serde(rename = "folder_path")] + pub folder_path: Vec, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub synced_until: Option>, + #[serde(rename = "last_synced_at", skip_serializing_if = "Option::is_none")] + pub last_synced_at: Option, + #[serde(rename = "fingerprint", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option>, +} + +impl KeyedFolderSyncStateUpdate { + pub fn new(mailbox_name: String, folder_id: String, folder_path: Vec, status: models::SyncStatus) -> KeyedFolderSyncStateUpdate { + KeyedFolderSyncStateUpdate { + mailbox_name, + folder_id, + folder_path, + status, + synced_until: None, + last_synced_at: None, + fingerprint: None, + } + } +} + diff --git a/api/src/models/keyed_mailbox_sync_state.rs b/api/src/models/keyed_mailbox_sync_state.rs new file mode 100644 index 00000000..96f51b45 --- /dev/null +++ b/api/src/models/keyed_mailbox_sync_state.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// KeyedMailboxSyncState : Sync state for an entire mailbox (not folder-specific). +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedMailboxSyncState { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub synced_until: Option>, + #[serde(rename = "last_synced_at")] + pub last_synced_at: String, + #[serde(rename = "fingerprint", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option>, +} + +impl KeyedMailboxSyncState { + /// Sync state for an entire mailbox (not folder-specific). + pub fn new(mailbox_name: String, status: models::SyncStatus, last_synced_at: String) -> KeyedMailboxSyncState { + KeyedMailboxSyncState { + mailbox_name, + status, + synced_until: None, + last_synced_at, + fingerprint: None, + } + } +} + diff --git a/api/src/models/keyed_mailbox_sync_state_update.rs b/api/src/models/keyed_mailbox_sync_state_update.rs new file mode 100644 index 00000000..60343a4d --- /dev/null +++ b/api/src/models/keyed_mailbox_sync_state_update.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedMailboxSyncStateUpdate { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub synced_until: Option>, + #[serde(rename = "last_synced_at", skip_serializing_if = "Option::is_none")] + pub last_synced_at: Option, + #[serde(rename = "fingerprint", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option>, +} + +impl KeyedMailboxSyncStateUpdate { + pub fn new(mailbox_name: String, status: models::SyncStatus) -> KeyedMailboxSyncStateUpdate { + KeyedMailboxSyncStateUpdate { + mailbox_name, + status, + synced_until: None, + last_synced_at: None, + fingerprint: None, + } + } +} + diff --git a/api/src/models/keyed_sync_state.rs b/api/src/models/keyed_sync_state.rs new file mode 100644 index 00000000..40519979 --- /dev/null +++ b/api/src/models/keyed_sync_state.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedSyncState { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "folder_id")] + pub folder_id: String, + #[serde(rename = "folder_path")] + pub folder_path: Vec, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", skip_serializing_if = "Option::is_none")] + pub synced_until: Option, + #[serde(rename = "last_synced_at")] + pub last_synced_at: String, + #[serde(rename = "fingerprint", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option, +} + +impl KeyedSyncState { + pub fn new(mailbox_name: String, folder_id: String, folder_path: Vec, status: models::SyncStatus, last_synced_at: String) -> KeyedSyncState { + KeyedSyncState { + mailbox_name, + folder_id, + folder_path, + status, + synced_until: None, + last_synced_at, + fingerprint: None, + } + } +} + diff --git a/api/src/models/keyed_sync_state_1.rs b/api/src/models/keyed_sync_state_1.rs new file mode 100644 index 00000000..c77d9c32 --- /dev/null +++ b/api/src/models/keyed_sync_state_1.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct KeyedSyncState1 { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "folder_id")] + pub folder_id: String, + #[serde(rename = "folder_path")] + pub folder_path: Vec, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", skip_serializing_if = "Option::is_none")] + pub synced_until: Option, + #[serde(rename = "last_synced_at", skip_serializing_if = "Option::is_none")] + pub last_synced_at: Option, + #[serde(rename = "fingerprint", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option, +} + +impl KeyedSyncState1 { + pub fn new(mailbox_name: String, folder_id: String, folder_path: Vec, status: models::SyncStatus) -> KeyedSyncState1 { + KeyedSyncState1 { + mailbox_name, + folder_id, + folder_path, + status, + synced_until: None, + last_synced_at: None, + fingerprint: None, + } + } +} + diff --git a/api/src/models/label.rs b/api/src/models/label.rs new file mode 100644 index 00000000..3a4508eb --- /dev/null +++ b/api/src/models/label.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Label { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "sentiment")] + pub sentiment: models::LabelSentiment, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")] + pub metadata: Option>, +} + +impl Label { + pub fn new(name: String, sentiment: models::LabelSentiment) -> Label { + Label { + name, + sentiment, + instructions: None, + metadata: None, + } + } +} + diff --git a/api/src/models/label_action.rs b/api/src/models/label_action.rs new file mode 100644 index 00000000..592521d4 --- /dev/null +++ b/api/src/models/label_action.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelAction { + #[serde(rename = "label")] + pub label: String, + #[serde(rename = "action")] + pub action: Box, + #[serde(rename = "warning", skip_serializing_if = "Option::is_none")] + pub warning: Option>, +} + +impl LabelAction { + pub fn new(label: String, action: models::LabelHealthAction) -> LabelAction { + LabelAction { + label, + action: Box::new(action), + warning: None, + } + } +} + diff --git a/api/src/models/label_collection.rs b/api/src/models/label_collection.rs new file mode 100644 index 00000000..190fb7c9 --- /dev/null +++ b/api/src/models/label_collection.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelCollection { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "label_defs")] + pub label_defs: Vec, +} + +impl LabelCollection { + pub fn new(name: String, label_defs: Vec) -> LabelCollection { + LabelCollection { + name, + label_defs, + } + } +} + diff --git a/api/src/models/label_comparison.rs b/api/src/models/label_comparison.rs new file mode 100644 index 00000000..d8244ff8 --- /dev/null +++ b/api/src/models/label_comparison.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelComparison { + #[serde(rename = "positive")] + pub positive: Vec, + #[serde(rename = "negative")] + pub negative: Vec, + #[serde(rename = "significance")] + pub significance: Box, +} + +impl LabelComparison { + pub fn new(positive: Vec, negative: Vec, significance: models::Significance) -> LabelComparison { + LabelComparison { + positive, + negative, + significance: Box::new(significance), + } + } +} + diff --git a/api/src/models/label_counts.rs b/api/src/models/label_counts.rs new file mode 100644 index 00000000..85206144 --- /dev/null +++ b/api/src/models/label_counts.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelCounts { + #[serde(rename = "positive")] + pub positive: i32, + #[serde(rename = "negative")] + pub negative: i32, +} + +impl LabelCounts { + pub fn new(positive: i32, negative: i32) -> LabelCounts { + LabelCounts { + positive, + negative, + } + } +} + diff --git a/api/src/models/label_def.rs b/api/src/models/label_def.rs new file mode 100644 index 00000000..cb7e6bec --- /dev/null +++ b/api/src/models/label_def.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDef { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "external_id", skip_serializing_if = "Option::is_none")] + pub external_id: Option, + #[serde(rename = "properties", skip_serializing_if = "Option::is_none")] + pub properties: Option>, + #[serde(rename = "pretrained", skip_serializing_if = "Option::is_none")] + pub pretrained: Option>, + #[serde(rename = "trainable", skip_serializing_if = "Option::is_none")] + pub trainable: Option, + #[serde(rename = "moon_form", skip_serializing_if = "Option::is_none")] + pub moon_form: Option>, + #[serde(rename = "_flags", skip_serializing_if = "Option::is_none")] + pub _flags: Option>, +} + +impl LabelDef { + pub fn new(name: String) -> LabelDef { + LabelDef { + name, + title: None, + instructions: None, + external_id: None, + properties: None, + pretrained: None, + trainable: None, + moon_form: None, + _flags: None, + } + } +} + diff --git a/api/src/models/label_def_flag.rs b/api/src/models/label_def_flag.rs new file mode 100644 index 00000000..fe3f8817 --- /dev/null +++ b/api/src/models/label_def_flag.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelDefFlag : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum LabelDefFlag { + #[serde(rename = "llm_generated")] + LlmGenerated, + +} + +impl std::fmt::Display for LabelDefFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::LlmGenerated => write!(f, "llm_generated"), + } + } +} + +impl Default for LabelDefFlag { + fn default() -> LabelDefFlag { + Self::LlmGenerated + } +} + diff --git a/api/src/models/label_def_new.rs b/api/src/models/label_def_new.rs new file mode 100644 index 00000000..19d6dd96 --- /dev/null +++ b/api/src/models/label_def_new.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelDefNew : Definition of a label def to be created +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefNew { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "external_id", skip_serializing_if = "Option::is_none")] + pub external_id: Option, + #[serde(rename = "pretrained", skip_serializing_if = "Option::is_none")] + pub pretrained: Option>, + #[serde(rename = "trainable", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub trainable: Option>, + #[serde(rename = "moon_form", skip_serializing_if = "Option::is_none")] + pub moon_form: Option>, +} + +impl LabelDefNew { + /// Definition of a label def to be created + pub fn new(name: String) -> LabelDefNew { + LabelDefNew { + name, + title: None, + instructions: None, + external_id: None, + pretrained: None, + trainable: None, + moon_form: None, + } + } +} + diff --git a/api/src/models/label_def_property.rs b/api/src/models/label_def_property.rs new file mode 100644 index 00000000..fb352ebe --- /dev/null +++ b/api/src/models/label_def_property.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefProperty { + #[serde(rename = "name")] + pub name: models::LabelPropertyName, + #[serde(rename = "value")] + pub value: f64, +} + +impl LabelDefProperty { + pub fn new(name: models::LabelPropertyName, value: f64) -> LabelDefProperty { + LabelDefProperty { + name, + value, + } + } +} + diff --git a/api/src/models/label_def_update.rs b/api/src/models/label_def_update.rs new file mode 100644 index 00000000..45350e29 --- /dev/null +++ b/api/src/models/label_def_update.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelDefUpdate : Definition of a label def to be updated +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefUpdate { + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "properties", skip_serializing_if = "Option::is_none")] + pub properties: Option>, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "external_id", skip_serializing_if = "Option::is_none")] + pub external_id: Option, + #[serde(rename = "pretrained", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub pretrained: Option>>, + #[serde(rename = "trainable", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub trainable: Option>, + #[serde(rename = "moon_form", skip_serializing_if = "Option::is_none")] + pub moon_form: Option>, +} + +impl LabelDefUpdate { + /// Definition of a label def to be updated + pub fn new() -> LabelDefUpdate { + LabelDefUpdate { + name: None, + properties: None, + title: None, + instructions: None, + external_id: None, + pretrained: None, + trainable: None, + moon_form: None, + } + } +} + diff --git a/api/src/models/label_def_update_moon_form_inner.rs b/api/src/models/label_def_update_moon_form_inner.rs new file mode 100644 index 00000000..0f28fa8d --- /dev/null +++ b/api/src/models/label_def_update_moon_form_inner.rs @@ -0,0 +1,49 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefUpdateMoonFormInner { + /// Unique identifier for the moon field + #[serde(rename = "field_id")] + pub field_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "rule_set", skip_serializing_if = "Option::is_none")] + pub rule_set: Option>, + /// Deprecated. Use field_type_id instead + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + /// ID of the field type. + #[serde(rename = "field_type_id", skip_serializing_if = "Option::is_none")] + pub field_type_id: Option, + /// The kind of moon form field + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl LabelDefUpdateMoonFormInner { + pub fn new(field_id: String, name: String) -> LabelDefUpdateMoonFormInner { + LabelDefUpdateMoonFormInner { + field_id, + name, + instructions: None, + rule_set: None, + id: None, + field_type_id: None, + kind: None, + } + } +} + diff --git a/api/src/models/label_def_update_request.rs b/api/src/models/label_def_update_request.rs new file mode 100644 index 00000000..99b540d3 --- /dev/null +++ b/api/src/models/label_def_update_request.rs @@ -0,0 +1,29 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelDefUpdateRequest : Request to update a label def in a dataset +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefUpdateRequest { + #[serde(rename = "label")] + pub label: Box, +} + +impl LabelDefUpdateRequest { + /// Request to update a label def in a dataset + pub fn new(label: models::LabelDefUpdate) -> LabelDefUpdateRequest { + LabelDefUpdateRequest { + label: Box::new(label), + } + } +} + diff --git a/api/src/models/label_definition.rs b/api/src/models/label_definition.rs new file mode 100644 index 00000000..a842aa38 --- /dev/null +++ b/api/src/models/label_definition.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelDefinition { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub instructions: Option>, + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl LabelDefinition { + pub fn new(name: String, fields: Vec) -> LabelDefinition { + LabelDefinition { + name, + instructions: None, + fields, + } + } +} + diff --git a/api/src/models/label_group.rs b/api/src/models/label_group.rs new file mode 100644 index 00000000..647557f0 --- /dev/null +++ b/api/src/models/label_group.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelGroup { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "label_defs")] + pub label_defs: Vec, + #[serde(rename = "label_collection_name", deserialize_with = "Option::deserialize")] + pub label_collection_name: Option, + #[serde(rename = "trainable")] + pub trainable: bool, + #[serde(rename = "hidden")] + pub hidden: bool, + #[serde(rename = "instructions")] + pub instructions: String, +} + +impl LabelGroup { + pub fn new(name: String, label_defs: Vec, label_collection_name: Option, trainable: bool, hidden: bool, instructions: String) -> LabelGroup { + LabelGroup { + name, + label_defs, + label_collection_name, + trainable, + hidden, + instructions, + } + } +} + diff --git a/api/src/models/label_group_new.rs b/api/src/models/label_group_new.rs new file mode 100644 index 00000000..be022f6a --- /dev/null +++ b/api/src/models/label_group_new.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelGroupNew { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "label_defs", skip_serializing_if = "Option::is_none")] + pub label_defs: Option>, + #[serde(rename = "label_collection_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub label_collection_name: Option>, + #[serde(rename = "trainable", skip_serializing_if = "Option::is_none")] + pub trainable: Option, + #[serde(rename = "hidden", skip_serializing_if = "Option::is_none")] + pub hidden: Option, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl LabelGroupNew { + pub fn new(name: String) -> LabelGroupNew { + LabelGroupNew { + name, + label_defs: None, + label_collection_name: None, + trainable: None, + hidden: None, + instructions: None, + } + } +} + diff --git a/api/src/models/label_health.rs b/api/src/models/label_health.rs new file mode 100644 index 00000000..c4aad34d --- /dev/null +++ b/api/src/models/label_health.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelHealth { + #[serde(rename = "need_pinned", skip_serializing_if = "Option::is_none")] + pub need_pinned: Option, + #[serde(rename = "need_pinned_increment", skip_serializing_if = "Option::is_none")] + pub need_pinned_increment: Option, + #[serde(rename = "smart", deserialize_with = "Option::deserialize")] + pub smart: Option>, +} + +impl LabelHealth { + pub fn new(smart: Option) -> LabelHealth { + LabelHealth { + need_pinned: None, + need_pinned_increment: None, + smart: smart.map(Box::new), + } + } +} + diff --git a/api/src/models/label_health_action.rs b/api/src/models/label_health_action.rs new file mode 100644 index 00000000..2f8799d7 --- /dev/null +++ b/api/src/models/label_health_action.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelHealthAction { + #[serde(rename = "kind")] + pub kind: models::BinaryLabelHealthActionKind, + #[serde(rename = "label")] + pub label: String, +} + +impl LabelHealthAction { + pub fn new(kind: models::BinaryLabelHealthActionKind, label: String) -> LabelHealthAction { + LabelHealthAction { + kind, + label, + } + } +} + diff --git a/api/src/models/label_health_smart.rs b/api/src/models/label_health_smart.rs new file mode 100644 index 00000000..52df2283 --- /dev/null +++ b/api/src/models/label_health_smart.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelHealthSmart { + #[serde(rename = "score")] + pub score: f64, + #[serde(rename = "warnings")] + pub warnings: Vec, + #[serde(rename = "actions")] + pub actions: Vec, +} + +impl LabelHealthSmart { + pub fn new(score: f64, warnings: Vec, actions: Vec) -> LabelHealthSmart { + LabelHealthSmart { + score, + warnings, + actions, + } + } +} + diff --git a/api/src/models/label_health_warning.rs b/api/src/models/label_health_warning.rs new file mode 100644 index 00000000..33cefa8b --- /dev/null +++ b/api/src/models/label_health_warning.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelHealthWarning { + #[serde(rename = "kind")] + pub kind: models::BinaryLabelHealthWarningKind, + #[serde(rename = "label")] + pub label: String, +} + +impl LabelHealthWarning { + pub fn new(kind: models::BinaryLabelHealthWarningKind, label: String) -> LabelHealthWarning { + LabelHealthWarning { + kind, + label, + } + } +} + diff --git a/api/src/models/label_metrics.rs b/api/src/models/label_metrics.rs new file mode 100644 index 00000000..19c088a1 --- /dev/null +++ b/api/src/models/label_metrics.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelMetrics { + #[serde(rename = "average_precision", deserialize_with = "Option::deserialize")] + pub average_precision: Option, + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "recalls")] + pub recalls: Vec, + #[serde(rename = "test_error_count")] + pub test_error_count: f64, + #[serde(rename = "test_expected_count")] + pub test_expected_count: f64, + #[serde(rename = "precisions")] + pub precisions: Vec, + #[serde(rename = "thresholds")] + pub thresholds: Vec, + #[serde(rename = "optimal_thresholds", deserialize_with = "Option::deserialize")] + pub optimal_thresholds: Option>, + #[serde(rename = "health")] + pub health: Box, +} + +impl LabelMetrics { + pub fn new(average_precision: Option, train_size: i32, test_size: i32, reviewed_size: i32, recalls: Vec, test_error_count: f64, test_expected_count: f64, precisions: Vec, thresholds: Vec, optimal_thresholds: Option, health: models::LabelHealth) -> LabelMetrics { + LabelMetrics { + average_precision, + train_size, + test_size, + reviewed_size, + recalls, + test_error_count, + test_expected_count, + precisions, + thresholds, + optimal_thresholds: optimal_thresholds.map(Box::new), + health: Box::new(health), + } + } +} + diff --git a/api/src/models/label_name_only_response.rs b/api/src/models/label_name_only_response.rs new file mode 100644 index 00000000..d2c76be4 --- /dev/null +++ b/api/src/models/label_name_only_response.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelNameOnlyResponse { + #[serde(rename = "name")] + pub name: String, +} + +impl LabelNameOnlyResponse { + pub fn new(name: String) -> LabelNameOnlyResponse { + LabelNameOnlyResponse { + name, + } + } +} + diff --git a/api/src/models/label_properties_digest.rs b/api/src/models/label_properties_digest.rs new file mode 100644 index 00000000..a30bcc15 --- /dev/null +++ b/api/src/models/label_properties_digest.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelPropertiesDigest { + #[serde(rename = "label_property_digests")] + pub label_property_digests: Vec, +} + +impl LabelPropertiesDigest { + pub fn new(label_property_digests: Vec) -> LabelPropertiesDigest { + LabelPropertiesDigest { + label_property_digests, + } + } +} + diff --git a/api/src/models/label_property.rs b/api/src/models/label_property.rs new file mode 100644 index 00000000..b6404dc1 --- /dev/null +++ b/api/src/models/label_property.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelProperty { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: models::LabelPropertyName, + #[serde(rename = "value")] + pub value: f64, + #[serde(rename = "breakdown", deserialize_with = "Option::deserialize")] + pub breakdown: Option>, +} + +impl LabelProperty { + pub fn new(id: String, name: models::LabelPropertyName, value: f64, breakdown: Option) -> LabelProperty { + LabelProperty { + id, + name, + value, + breakdown: breakdown.map(Box::new), + } + } +} + diff --git a/api/src/models/label_property_digest.rs b/api/src/models/label_property_digest.rs new file mode 100644 index 00000000..b6a1d7df --- /dev/null +++ b/api/src/models/label_property_digest.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelPropertyDigest { + #[serde(rename = "sum")] + pub sum: f64, +} + +impl LabelPropertyDigest { + pub fn new(sum: f64) -> LabelPropertyDigest { + LabelPropertyDigest { + sum, + } + } +} + diff --git a/api/src/models/label_property_id.rs b/api/src/models/label_property_id.rs new file mode 100644 index 00000000..3e0d36c1 --- /dev/null +++ b/api/src/models/label_property_id.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelPropertyId : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum LabelPropertyId { + #[serde(rename = "0000000000000001")] + Variant0000000000000001, + #[serde(rename = "0000000000000002")] + Variant0000000000000002, + +} + +impl std::fmt::Display for LabelPropertyId { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Variant0000000000000001 => write!(f, "0000000000000001"), + Self::Variant0000000000000002 => write!(f, "0000000000000002"), + } + } +} + +impl Default for LabelPropertyId { + fn default() -> LabelPropertyId { + Self::Variant0000000000000001 + } +} + diff --git a/api/src/models/label_property_name.rs b/api/src/models/label_property_name.rs new file mode 100644 index 00000000..12a0ad38 --- /dev/null +++ b/api/src/models/label_property_name.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelPropertyName : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum LabelPropertyName { + #[serde(rename = "tone")] + Tone, + #[serde(rename = "quality_of_service")] + QualityOfService, + +} + +impl std::fmt::Display for LabelPropertyName { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Tone => write!(f, "tone"), + Self::QualityOfService => write!(f, "quality_of_service"), + } + } +} + +impl Default for LabelPropertyName { + fn default() -> LabelPropertyName { + Self::Tone + } +} + diff --git a/api/src/models/label_property_summary.rs b/api/src/models/label_property_summary.rs new file mode 100644 index 00000000..1d772285 --- /dev/null +++ b/api/src/models/label_property_summary.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelPropertySummary { + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "timeseries")] + pub timeseries: Vec, + #[serde(rename = "totals")] + pub totals: Vec, +} + +impl LabelPropertySummary { + pub fn new(labels: Vec, timeseries: Vec, totals: Vec) -> LabelPropertySummary { + LabelPropertySummary { + labels, + timeseries, + totals, + } + } +} + diff --git a/api/src/models/label_property_summary_label.rs b/api/src/models/label_property_summary_label.rs new file mode 100644 index 00000000..6a6de499 --- /dev/null +++ b/api/src/models/label_property_summary_label.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelPropertySummaryLabel { + #[serde(rename = "label_name")] + pub label_name: String, + #[serde(rename = "label_property_sums")] + pub label_property_sums: Vec, +} + +impl LabelPropertySummaryLabel { + pub fn new(label_name: String, label_property_sums: Vec) -> LabelPropertySummaryLabel { + LabelPropertySummaryLabel { + label_name, + label_property_sums, + } + } +} + diff --git a/api/src/models/label_property_time_series_row.rs b/api/src/models/label_property_time_series_row.rs new file mode 100644 index 00000000..04e505eb --- /dev/null +++ b/api/src/models/label_property_time_series_row.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelPropertyTimeSeriesRow { + #[serde(rename = "timestamp_str")] + pub timestamp_str: String, + #[serde(rename = "sums")] + pub sums: Vec, +} + +impl LabelPropertyTimeSeriesRow { + pub fn new(timestamp_str: String, sums: Vec) -> LabelPropertyTimeSeriesRow { + LabelPropertyTimeSeriesRow { + timestamp_str, + sums, + } + } +} + diff --git a/api/src/models/label_sentiment.rs b/api/src/models/label_sentiment.rs new file mode 100644 index 00000000..4a26e18d --- /dev/null +++ b/api/src/models/label_sentiment.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// LabelSentiment : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum LabelSentiment { + #[serde(rename = "positive")] + Positive, + #[serde(rename = "negative")] + Negative, + +} + +impl std::fmt::Display for LabelSentiment { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Positive => write!(f, "positive"), + Self::Negative => write!(f, "negative"), + } + } +} + +impl Default for LabelSentiment { + fn default() -> LabelSentiment { + Self::Positive + } +} + diff --git a/api/src/models/label_suggestion_reasoning.rs b/api/src/models/label_suggestion_reasoning.rs new file mode 100644 index 00000000..3b592e10 --- /dev/null +++ b/api/src/models/label_suggestion_reasoning.rs @@ -0,0 +1,31 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelSuggestionReasoning { + #[serde(rename = "label_suggestions")] + pub label_suggestions: String, + /// Populated if LLM features are enabled. The taxonomy refactor reasoning. + #[serde(rename = "taxonomy_refactor", skip_serializing_if = "Option::is_none")] + pub taxonomy_refactor: Option, +} + +impl LabelSuggestionReasoning { + pub fn new(label_suggestions: String) -> LabelSuggestionReasoning { + LabelSuggestionReasoning { + label_suggestions, + taxonomy_refactor: None, + } + } +} + diff --git a/api/src/models/label_timeseries_entry.rs b/api/src/models/label_timeseries_entry.rs new file mode 100644 index 00000000..f05827c9 --- /dev/null +++ b/api/src/models/label_timeseries_entry.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelTimeseriesEntry { + #[serde(rename = "timestamp_str")] + pub timestamp_str: String, + #[serde(rename = "expected_count_any")] + pub expected_count_any: f64, + #[serde(rename = "expected_count_positive")] + pub expected_count_positive: f64, + #[serde(rename = "expected_count_negative")] + pub expected_count_negative: f64, + #[serde(rename = "label_sentiment_counts")] + pub label_sentiment_counts: Vec, +} + +impl LabelTimeseriesEntry { + pub fn new(timestamp_str: String, expected_count_any: f64, expected_count_positive: f64, expected_count_negative: f64, label_sentiment_counts: Vec) -> LabelTimeseriesEntry { + LabelTimeseriesEntry { + timestamp_str, + expected_count_any, + expected_count_positive, + expected_count_negative, + label_sentiment_counts, + } + } +} + diff --git a/api/src/models/label_training_action.rs b/api/src/models/label_training_action.rs new file mode 100644 index 00000000..c0a5e87f --- /dev/null +++ b/api/src/models/label_training_action.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelTrainingAction { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "sub_kind")] + pub sub_kind: String, + #[serde(rename = "factor_kind")] + pub factor_kind: models::ModelRatingFactorKind, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "plan")] + pub plan: Box, + #[serde(rename = "search_term", skip_serializing_if = "Option::is_none")] + pub search_term: Option, +} + +impl LabelTrainingAction { + pub fn new(id: String, kind: Kind, sub_kind: String, factor_kind: models::ModelRatingFactorKind, quality: models::DatasetQuality, plan: models::LabelAction) -> LabelTrainingAction { + LabelTrainingAction { + id, + kind, + sub_kind, + factor_kind, + quality, + plan: Box::new(plan), + search_term: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "label")] + Label, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Label + } +} + diff --git a/api/src/models/label_validation_summary.rs b/api/src/models/label_validation_summary.rs new file mode 100644 index 00000000..c7e984cb --- /dev/null +++ b/api/src/models/label_validation_summary.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabelValidationSummary { + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "average_precision", deserialize_with = "Option::deserialize")] + pub average_precision: Option, + #[serde(rename = "optimal_thresholds", deserialize_with = "Option::deserialize")] + pub optimal_thresholds: Option>, + #[serde(rename = "health")] + pub health: Box, + #[serde(rename = "cooccurrence", skip_serializing_if = "Option::is_none")] + pub cooccurrence: Option>, +} + +impl LabelValidationSummary { + pub fn new(train_size: i32, test_size: i32, reviewed_size: i32, average_precision: Option, optimal_thresholds: Option, health: models::LabelHealth) -> LabelValidationSummary { + LabelValidationSummary { + train_size, + test_size, + reviewed_size, + average_precision, + optimal_thresholds: optimal_thresholds.map(Box::new), + health: Box::new(health), + cooccurrence: None, + } + } +} + diff --git a/api/src/models/labelling_group.rs b/api/src/models/labelling_group.rs new file mode 100644 index 00000000..a6108d01 --- /dev/null +++ b/api/src/models/labelling_group.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LabellingGroup { + #[serde(rename = "group")] + pub group: Group, + #[serde(rename = "assigned")] + pub assigned: Vec, + #[serde(rename = "dismissed")] + pub dismissed: Vec, + #[serde(rename = "uninformative", skip_serializing_if = "Option::is_none")] + pub uninformative: Option>, + #[serde(rename = "predicted", skip_serializing_if = "Option::is_none")] + pub predicted: Option>, +} + +impl LabellingGroup { + pub fn new(group: Group, assigned: Vec, dismissed: Vec) -> LabellingGroup { + LabellingGroup { + group, + assigned, + dismissed, + uninformative: None, + predicted: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Group { + #[serde(rename = "default")] + Default, +} + +impl Default for Group { + fn default() -> Group { + Self::Default + } +} + diff --git a/api/src/models/language.rs b/api/src/models/language.rs new file mode 100644 index 00000000..0755ee0d --- /dev/null +++ b/api/src/models/language.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Language : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Language { + #[serde(rename = "en")] + En, + #[serde(rename = "de")] + De, + #[serde(rename = "xlm")] + Xlm, + +} + +impl std::fmt::Display for Language { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::En => write!(f, "en"), + Self::De => write!(f, "de"), + Self::Xlm => write!(f, "xlm"), + } + } +} + +impl Default for Language { + fn default() -> Language { + Self::En + } +} + diff --git a/api/src/models/legacy_entity_pattern_api.rs b/api/src/models/legacy_entity_pattern_api.rs new file mode 100644 index 00000000..5bb8e290 --- /dev/null +++ b/api/src/models/legacy_entity_pattern_api.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LegacyEntityPatternApi { + #[serde(rename = "pattern")] + pub pattern: String, +} + +impl LegacyEntityPatternApi { + pub fn new(pattern: String) -> LegacyEntityPatternApi { + LegacyEntityPatternApi { + pattern, + } + } +} + diff --git a/api/src/models/list_keyed_sync_states_response.rs b/api/src/models/list_keyed_sync_states_response.rs new file mode 100644 index 00000000..3809d369 --- /dev/null +++ b/api/src/models/list_keyed_sync_states_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ListKeyedSyncStatesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "keyed_sync_states")] + pub keyed_sync_states: Vec, +} + +impl ListKeyedSyncStatesResponse { + pub fn new(status: Status, keyed_sync_states: Vec) -> ListKeyedSyncStatesResponse { + ListKeyedSyncStatesResponse { + status, + keyed_sync_states, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/list_keyed_sync_states_response_keyed_sync_states_inner.rs b/api/src/models/list_keyed_sync_states_response_keyed_sync_states_inner.rs new file mode 100644 index 00000000..3ba24c52 --- /dev/null +++ b/api/src/models/list_keyed_sync_states_response_keyed_sync_states_inner.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ListKeyedSyncStatesResponseKeyedSyncStatesInner { + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, + #[serde(rename = "folder_id")] + pub folder_id: String, + #[serde(rename = "folder_path")] + pub folder_path: Vec, + #[serde(rename = "status")] + pub status: models::SyncStatus, + #[serde(rename = "synced_until", skip_serializing_if = "Option::is_none")] + pub synced_until: Option, + #[serde(rename = "last_synced_at")] + pub last_synced_at: String, + #[serde(rename = "fingerprint", skip_serializing_if = "Option::is_none")] + pub fingerprint: Option, +} + +impl ListKeyedSyncStatesResponseKeyedSyncStatesInner { + pub fn new(mailbox_name: String, folder_id: String, folder_path: Vec, status: models::SyncStatus, last_synced_at: String) -> ListKeyedSyncStatesResponseKeyedSyncStatesInner { + ListKeyedSyncStatesResponseKeyedSyncStatesInner { + mailbox_name, + folder_id, + folder_path, + status, + synced_until: None, + last_synced_at, + fingerprint: None, + } + } +} + diff --git a/api/src/models/locales.rs b/api/src/models/locales.rs new file mode 100644 index 00000000..ef44f27c --- /dev/null +++ b/api/src/models/locales.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Locales { + #[serde(rename = "preferences")] + pub preferences: Vec, + #[serde(rename = "default")] + pub default: String, +} + +impl Locales { + pub fn new(preferences: Vec, default: String) -> Locales { + Locales { + preferences, + default, + } + } +} + diff --git a/api/src/models/locales_preferences.rs b/api/src/models/locales_preferences.rs new file mode 100644 index 00000000..8e3c867a --- /dev/null +++ b/api/src/models/locales_preferences.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct LocalesPreferences { + #[serde(rename = "language")] + pub language: String, + #[serde(rename = "locale")] + pub locale: String, +} + +impl LocalesPreferences { + pub fn new(language: String, locale: String) -> LocalesPreferences { + LocalesPreferences { + language, + locale, + } + } +} + diff --git a/api/src/models/markup_break.rs b/api/src/models/markup_break.rs new file mode 100644 index 00000000..23fc327e --- /dev/null +++ b/api/src/models/markup_break.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupBreak { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "break_kind")] + pub break_kind: models::MarkupBreakKind, +} + +impl MarkupBreak { + pub fn new(kind: Kind, break_kind: models::MarkupBreakKind) -> MarkupBreak { + MarkupBreak { + kind, + break_kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "break")] + Break, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Break + } +} + diff --git a/api/src/models/markup_break_kind.rs b/api/src/models/markup_break_kind.rs new file mode 100644 index 00000000..7d6211fb --- /dev/null +++ b/api/src/models/markup_break_kind.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupBreakKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupBreakKind { + #[serde(rename = "br")] + Br, + #[serde(rename = "hr")] + Hr, + +} + +impl std::fmt::Display for MarkupBreakKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Br => write!(f, "br"), + Self::Hr => write!(f, "hr"), + } + } +} + +impl Default for MarkupBreakKind { + fn default() -> MarkupBreakKind { + Self::Br + } +} + diff --git a/api/src/models/markup_image.rs b/api/src/models/markup_image.rs new file mode 100644 index 00000000..4e5812e3 --- /dev/null +++ b/api/src/models/markup_image.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupImage { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "src", deserialize_with = "Option::deserialize")] + pub src: Option, + #[serde(rename = "alt", deserialize_with = "Option::deserialize")] + pub alt: Option, +} + +impl MarkupImage { + pub fn new(kind: Kind, src: Option, alt: Option) -> MarkupImage { + MarkupImage { + kind, + src, + alt, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "image")] + Image, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Image + } +} + diff --git a/api/src/models/markup_link.rs b/api/src/models/markup_link.rs new file mode 100644 index 00000000..fb3ee96a --- /dev/null +++ b/api/src/models/markup_link.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupLink { + #[serde(rename = "children")] + pub children: Vec, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "href", deserialize_with = "Option::deserialize")] + pub href: Option, +} + +impl MarkupLink { + pub fn new(children: Vec, kind: Kind, href: Option) -> MarkupLink { + MarkupLink { + children, + kind, + href, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "link")] + Link, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Link + } +} + diff --git a/api/src/models/markup_list.rs b/api/src/models/markup_list.rs new file mode 100644 index 00000000..971a8b66 --- /dev/null +++ b/api/src/models/markup_list.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupList { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "list_kind")] + pub list_kind: models::MarkupListKind, + #[serde(rename = "items")] + pub items: Vec, +} + +impl MarkupList { + pub fn new(kind: Kind, list_kind: models::MarkupListKind, items: Vec) -> MarkupList { + MarkupList { + kind, + list_kind, + items, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "list")] + List, +} + +impl Default for Kind { + fn default() -> Kind { + Self::List + } +} + diff --git a/api/src/models/markup_list_item.rs b/api/src/models/markup_list_item.rs new file mode 100644 index 00000000..3cbbf283 --- /dev/null +++ b/api/src/models/markup_list_item.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupListItem { + #[serde(rename = "children")] + pub children: Vec, +} + +impl MarkupListItem { + pub fn new(children: Vec) -> MarkupListItem { + MarkupListItem { + children, + } + } +} + diff --git a/api/src/models/markup_list_kind.rs b/api/src/models/markup_list_kind.rs new file mode 100644 index 00000000..4f5800c4 --- /dev/null +++ b/api/src/models/markup_list_kind.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupListKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupListKind { + #[serde(rename = "ul")] + Ul, + #[serde(rename = "ol")] + Ol, + +} + +impl std::fmt::Display for MarkupListKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Ul => write!(f, "ul"), + Self::Ol => write!(f, "ol"), + } + } +} + +impl Default for MarkupListKind { + fn default() -> MarkupListKind { + Self::Ul + } +} + diff --git a/api/src/models/markup_paragraph.rs b/api/src/models/markup_paragraph.rs new file mode 100644 index 00000000..c288e877 --- /dev/null +++ b/api/src/models/markup_paragraph.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupParagraph { + #[serde(rename = "children")] + pub children: Vec, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "paragraph_kind")] + pub paragraph_kind: models::MarkupParagraphKind, +} + +impl MarkupParagraph { + pub fn new(children: Vec, kind: Kind, paragraph_kind: models::MarkupParagraphKind) -> MarkupParagraph { + MarkupParagraph { + children, + kind, + paragraph_kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "paragraph")] + Paragraph, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Paragraph + } +} + diff --git a/api/src/models/markup_paragraph_kind.rs b/api/src/models/markup_paragraph_kind.rs new file mode 100644 index 00000000..f387e133 --- /dev/null +++ b/api/src/models/markup_paragraph_kind.rs @@ -0,0 +1,96 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupParagraphKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupParagraphKind { + #[serde(rename = "p")] + P, + #[serde(rename = "div")] + Div, + #[serde(rename = "address")] + Address, + #[serde(rename = "article")] + Article, + #[serde(rename = "aside")] + Aside, + #[serde(rename = "blockquote")] + Blockquote, + #[serde(rename = "center")] + Center, + #[serde(rename = "pre")] + Pre, + #[serde(rename = "details")] + Details, + #[serde(rename = "summary")] + Summary, + #[serde(rename = "section")] + Section, + #[serde(rename = "h1")] + H1, + #[serde(rename = "h2")] + H2, + #[serde(rename = "h3")] + H3, + #[serde(rename = "h4")] + H4, + #[serde(rename = "h5")] + H5, + #[serde(rename = "h6")] + H6, + #[serde(rename = "dl")] + Dl, + #[serde(rename = "dt")] + Dt, + #[serde(rename = "dd")] + Dd, + #[serde(rename = "orphan")] + Orphan, + +} + +impl std::fmt::Display for MarkupParagraphKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::P => write!(f, "p"), + Self::Div => write!(f, "div"), + Self::Address => write!(f, "address"), + Self::Article => write!(f, "article"), + Self::Aside => write!(f, "aside"), + Self::Blockquote => write!(f, "blockquote"), + Self::Center => write!(f, "center"), + Self::Pre => write!(f, "pre"), + Self::Details => write!(f, "details"), + Self::Summary => write!(f, "summary"), + Self::Section => write!(f, "section"), + Self::H1 => write!(f, "h1"), + Self::H2 => write!(f, "h2"), + Self::H3 => write!(f, "h3"), + Self::H4 => write!(f, "h4"), + Self::H5 => write!(f, "h5"), + Self::H6 => write!(f, "h6"), + Self::Dl => write!(f, "dl"), + Self::Dt => write!(f, "dt"), + Self::Dd => write!(f, "dd"), + Self::Orphan => write!(f, "orphan"), + } + } +} + +impl Default for MarkupParagraphKind { + fn default() -> MarkupParagraphKind { + Self::P + } +} + diff --git a/api/src/models/markup_style.rs b/api/src/models/markup_style.rs new file mode 100644 index 00000000..906b921a --- /dev/null +++ b/api/src/models/markup_style.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupStyle { + #[serde(rename = "children")] + pub children: Vec, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "style_kind")] + pub style_kind: models::MarkupStyleKind, +} + +impl MarkupStyle { + pub fn new(children: Vec, kind: Kind, style_kind: models::MarkupStyleKind) -> MarkupStyle { + MarkupStyle { + children, + kind, + style_kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "style")] + Style, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Style + } +} + diff --git a/api/src/models/markup_style_kind.rs b/api/src/models/markup_style_kind.rs new file mode 100644 index 00000000..17c03efc --- /dev/null +++ b/api/src/models/markup_style_kind.rs @@ -0,0 +1,108 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupStyleKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupStyleKind { + #[serde(rename = "strong")] + Strong, + #[serde(rename = "b")] + B, + #[serde(rename = "mark")] + Mark, + #[serde(rename = "em")] + Em, + #[serde(rename = "i")] + I, + #[serde(rename = "cite")] + Cite, + #[serde(rename = "var")] + Var, + #[serde(rename = "strike")] + Strike, + #[serde(rename = "del")] + Del, + #[serde(rename = "u")] + U, + #[serde(rename = "abbr")] + Abbr, + #[serde(rename = "dfn")] + Dfn, + #[serde(rename = "ins")] + Ins, + #[serde(rename = "kbd")] + Kbd, + #[serde(rename = "code")] + Code, + #[serde(rename = "samp")] + Samp, + #[serde(rename = "q")] + Q, + #[serde(rename = "big")] + Big, + #[serde(rename = "small")] + Small, + #[serde(rename = "time")] + Time, + #[serde(rename = "bdi")] + Bdi, + #[serde(rename = "ltr")] + Ltr, + #[serde(rename = "rtl")] + Rtl, + #[serde(rename = "sub")] + Sub, + #[serde(rename = "sup")] + Sup, + +} + +impl std::fmt::Display for MarkupStyleKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Strong => write!(f, "strong"), + Self::B => write!(f, "b"), + Self::Mark => write!(f, "mark"), + Self::Em => write!(f, "em"), + Self::I => write!(f, "i"), + Self::Cite => write!(f, "cite"), + Self::Var => write!(f, "var"), + Self::Strike => write!(f, "strike"), + Self::Del => write!(f, "del"), + Self::U => write!(f, "u"), + Self::Abbr => write!(f, "abbr"), + Self::Dfn => write!(f, "dfn"), + Self::Ins => write!(f, "ins"), + Self::Kbd => write!(f, "kbd"), + Self::Code => write!(f, "code"), + Self::Samp => write!(f, "samp"), + Self::Q => write!(f, "q"), + Self::Big => write!(f, "big"), + Self::Small => write!(f, "small"), + Self::Time => write!(f, "time"), + Self::Bdi => write!(f, "bdi"), + Self::Ltr => write!(f, "ltr"), + Self::Rtl => write!(f, "rtl"), + Self::Sub => write!(f, "sub"), + Self::Sup => write!(f, "sup"), + } + } +} + +impl Default for MarkupStyleKind { + fn default() -> MarkupStyleKind { + Self::Strong + } +} + diff --git a/api/src/models/markup_table.rs b/api/src/models/markup_table.rs new file mode 100644 index 00000000..b1bfdd03 --- /dev/null +++ b/api/src/models/markup_table.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupTable { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "rows")] + pub rows: Vec, + #[serde(rename = "captions")] + pub captions: Vec, + /// Whether to render this table with borders or not + #[serde(rename = "borderless")] + pub borderless: bool, +} + +impl MarkupTable { + pub fn new(kind: Kind, rows: Vec, captions: Vec, borderless: bool) -> MarkupTable { + MarkupTable { + kind, + rows, + captions, + borderless, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "table")] + Table, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Table + } +} + diff --git a/api/src/models/markup_table_caption.rs b/api/src/models/markup_table_caption.rs new file mode 100644 index 00000000..2643b3eb --- /dev/null +++ b/api/src/models/markup_table_caption.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupTableCaption { + #[serde(rename = "children")] + pub children: Vec, +} + +impl MarkupTableCaption { + pub fn new(children: Vec) -> MarkupTableCaption { + MarkupTableCaption { + children, + } + } +} + diff --git a/api/src/models/markup_table_cell.rs b/api/src/models/markup_table_cell.rs new file mode 100644 index 00000000..7a1105e2 --- /dev/null +++ b/api/src/models/markup_table_cell.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupTableCell { + #[serde(rename = "children")] + pub children: Vec, + #[serde(rename = "cell_kind")] + pub cell_kind: models::MarkupTableCellKind, + #[serde(rename = "rowspan")] + pub rowspan: i32, + #[serde(rename = "colspan")] + pub colspan: i32, +} + +impl MarkupTableCell { + pub fn new(children: Vec, cell_kind: models::MarkupTableCellKind, rowspan: i32, colspan: i32) -> MarkupTableCell { + MarkupTableCell { + children, + cell_kind, + rowspan, + colspan, + } + } +} + diff --git a/api/src/models/markup_table_cell_children_inner.rs b/api/src/models/markup_table_cell_children_inner.rs new file mode 100644 index 00000000..dc858f0f --- /dev/null +++ b/api/src/models/markup_table_cell_children_inner.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + use crate::models; + use serde::{Deserialize, Serialize}; + + #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] + #[serde(untagged)] + pub enum MarkupTableCellChildrenInner { + Text(Box), + Break(Box), + Link(Box), + Style(Box), + Paragraph(Box), + List(Box), + Table(Box), + Image(Box), + } + + impl Default for MarkupTableCellChildrenInner { + fn default() -> Self { + Self::Text(Default::default()) + } + } + \ No newline at end of file diff --git a/api/src/models/markup_table_cell_kind.rs b/api/src/models/markup_table_cell_kind.rs new file mode 100644 index 00000000..3d727605 --- /dev/null +++ b/api/src/models/markup_table_cell_kind.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupTableCellKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupTableCellKind { + #[serde(rename = "th")] + Th, + #[serde(rename = "td")] + Td, + +} + +impl std::fmt::Display for MarkupTableCellKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Th => write!(f, "th"), + Self::Td => write!(f, "td"), + } + } +} + +impl Default for MarkupTableCellKind { + fn default() -> MarkupTableCellKind { + Self::Th + } +} + diff --git a/api/src/models/markup_table_row.rs b/api/src/models/markup_table_row.rs new file mode 100644 index 00000000..488e980d --- /dev/null +++ b/api/src/models/markup_table_row.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupTableRow { + #[serde(rename = "section")] + pub section: models::MarkupTableSectionKind, + #[serde(rename = "cells")] + pub cells: Vec, +} + +impl MarkupTableRow { + pub fn new(section: models::MarkupTableSectionKind, cells: Vec) -> MarkupTableRow { + MarkupTableRow { + section, + cells, + } + } +} + diff --git a/api/src/models/markup_table_section_kind.rs b/api/src/models/markup_table_section_kind.rs new file mode 100644 index 00000000..130b713e --- /dev/null +++ b/api/src/models/markup_table_section_kind.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MarkupTableSectionKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum MarkupTableSectionKind { + #[serde(rename = "thead")] + Thead, + #[serde(rename = "tfoot")] + Tfoot, + #[serde(rename = "tbody")] + Tbody, + +} + +impl std::fmt::Display for MarkupTableSectionKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Thead => write!(f, "thead"), + Self::Tfoot => write!(f, "tfoot"), + Self::Tbody => write!(f, "tbody"), + } + } +} + +impl Default for MarkupTableSectionKind { + fn default() -> MarkupTableSectionKind { + Self::Thead + } +} + diff --git a/api/src/models/markup_text.rs b/api/src/models/markup_text.rs new file mode 100644 index 00000000..1d84c886 --- /dev/null +++ b/api/src/models/markup_text.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MarkupText { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "span")] + pub span: Box, +} + +impl MarkupText { + pub fn new(kind: Kind, span: models::MessageSpan) -> MarkupText { + MarkupText { + kind, + span: Box::new(span), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "text")] + Text, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Text + } +} + diff --git a/api/src/models/matched_field_group_extractions.rs b/api/src/models/matched_field_group_extractions.rs new file mode 100644 index 00000000..963c9ce6 --- /dev/null +++ b/api/src/models/matched_field_group_extractions.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MatchedFieldGroupExtractions { + #[serde(rename = "annotation", deserialize_with = "Option::deserialize")] + pub annotation: Option>, + #[serde(rename = "prediction", deserialize_with = "Option::deserialize")] + pub prediction: Option>, +} + +impl MatchedFieldGroupExtractions { + pub fn new(annotation: Option, prediction: Option) -> MatchedFieldGroupExtractions { + MatchedFieldGroupExtractions { + annotation: annotation.map(Box::new), + prediction: prediction.map(Box::new), + } + } +} + diff --git a/api/src/models/mean_pr_curve.rs b/api/src/models/mean_pr_curve.rs new file mode 100644 index 00000000..beddbb8c --- /dev/null +++ b/api/src/models/mean_pr_curve.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MeanPrCurve { + #[serde(rename = "precisions")] + pub precisions: Vec, + #[serde(rename = "mean", deserialize_with = "Option::deserialize")] + pub mean: Option, +} + +impl MeanPrCurve { + pub fn new(precisions: Vec, mean: Option) -> MeanPrCurve { + MeanPrCurve { + precisions, + mean, + } + } +} + diff --git a/api/src/models/message.rs b/api/src/models/message.rs new file mode 100644 index 00000000..1c3c1446 --- /dev/null +++ b/api/src/models/message.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Message { + /// Message sender + #[serde(rename = "from", skip_serializing_if = "Option::is_none")] + pub from: Option, + /// Message recipients + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + /// Message cc field + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + /// Message bcc field + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, + /// The time when the message was sent originally + #[serde(rename = "sent_at", skip_serializing_if = "Option::is_none")] + pub sent_at: Option, + /// The original language of the message + #[serde(rename = "language", skip_serializing_if = "Option::is_none")] + pub language: Option, + /// The body of the message + #[serde(rename = "body")] + pub body: Box, + /// The subject of the message + #[serde(rename = "subject", skip_serializing_if = "Option::is_none")] + pub subject: Option>, + /// The signature of the message + #[serde(rename = "signature", skip_serializing_if = "Option::is_none")] + pub signature: Option>, +} + +impl Message { + pub fn new(body: models::MessageRichText) -> Message { + Message { + from: None, + to: None, + cc: None, + bcc: None, + sent_at: None, + language: None, + body: Box::new(body), + subject: None, + signature: None, + } + } +} + diff --git a/api/src/models/message_filter.rs b/api/src/models/message_filter.rs new file mode 100644 index 00000000..65571ba5 --- /dev/null +++ b/api/src/models/message_filter.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MessageFilter { + #[serde(rename = "from", skip_serializing_if = "Option::is_none")] + pub from: Option>, + #[serde(rename = "recipient", skip_serializing_if = "Option::is_none")] + pub recipient: Option>, + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, +} + +impl MessageFilter { + pub fn new() -> MessageFilter { + MessageFilter { + from: None, + recipient: None, + to: None, + cc: None, + bcc: None, + } + } +} + diff --git a/api/src/models/message_rich_text.rs b/api/src/models/message_rich_text.rs new file mode 100644 index 00000000..680cf2a3 --- /dev/null +++ b/api/src/models/message_rich_text.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MessageRichText { + /// Text content of the message part + #[serde(rename = "text")] + pub text: String, + /// The original language from which the message was translated, if applicable + #[serde(rename = "translated_from", skip_serializing_if = "Option::is_none")] + pub translated_from: Option, + /// Markup content of the message part + #[serde(rename = "text_markup", skip_serializing_if = "Option::is_none")] + pub text_markup: Option>, + /// Markup for the translated part + #[serde(rename = "translated_from_markup", skip_serializing_if = "Option::is_none")] + pub translated_from_markup: Option>, +} + +impl MessageRichText { + pub fn new(text: String) -> MessageRichText { + MessageRichText { + text, + translated_from: None, + text_markup: None, + translated_from_markup: None, + } + } +} + diff --git a/api/src/models/message_rich_text_text_markup_inner.rs b/api/src/models/message_rich_text_text_markup_inner.rs new file mode 100644 index 00000000..19825ab3 --- /dev/null +++ b/api/src/models/message_rich_text_text_markup_inner.rs @@ -0,0 +1,93 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + + use crate::models; + use serde::{Deserialize, Serialize}; + + #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] + pub struct MessageRichTextTextMarkupInner { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + #[serde(rename = "break_kind", skip_serializing_if = "Option::is_none")] + pub break_kind: Option, + #[serde(rename = "children", skip_serializing_if = "Option::is_none")] + pub children: Option>, + #[serde(rename = "href", skip_serializing_if = "Option::is_none")] + pub href: Option, + #[serde(rename = "style_kind", skip_serializing_if = "Option::is_none")] + pub style_kind: Option, + #[serde(rename = "paragraph_kind", skip_serializing_if = "Option::is_none")] + pub paragraph_kind: Option, + #[serde(rename = "list_kind", skip_serializing_if = "Option::is_none")] + pub list_kind: Option, + #[serde(rename = "items", skip_serializing_if = "Option::is_none")] + pub items: Option>, + #[serde(rename = "rows", skip_serializing_if = "Option::is_none")] + pub rows: Option>, + #[serde(rename = "captions", skip_serializing_if = "Option::is_none")] + pub captions: Option>, + /// Whether to render this table with borders or not + #[serde(rename = "borderless", skip_serializing_if = "Option::is_none")] + pub borderless: Option, + #[serde(rename = "src", skip_serializing_if = "Option::is_none")] + pub src: Option, + #[serde(rename = "alt", skip_serializing_if = "Option::is_none")] + pub alt: Option, + } + + impl MessageRichTextTextMarkupInner { + pub fn new(kind: Kind) -> MessageRichTextTextMarkupInner { + MessageRichTextTextMarkupInner { + kind, + span: None, + break_kind: None, + children: None, + href: None, + style_kind: None, + paragraph_kind: None, + list_kind: None, + items: None, + rows: None, + captions: None, + borderless: None, + src: None, + alt: None, + } + } + } + #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] + pub enum Kind { + #[serde(rename = "text")] + Text, + #[serde(rename = "break")] + Break, + #[serde(rename = "link")] + Link, + #[serde(rename = "style")] + Style, + #[serde(rename = "paragraph")] + Paragraph, + #[serde(rename = "list")] + List, + #[serde(rename = "table")] + Table, + #[serde(rename = "image")] + Image, + } + + impl Default for Kind { + fn default() -> Kind { + Self::Image + } + } + + \ No newline at end of file diff --git a/api/src/models/message_span.rs b/api/src/models/message_span.rs new file mode 100644 index 00000000..c3f2c9b1 --- /dev/null +++ b/api/src/models/message_span.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MessageSpan { + #[serde(rename = "char_start")] + pub char_start: i32, + #[serde(rename = "char_end")] + pub char_end: i32, + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, +} + +impl MessageSpan { + pub fn new(char_start: i32, char_end: i32, utf16_byte_start: i32, utf16_byte_end: i32) -> MessageSpan { + MessageSpan { + char_start, + char_end, + utf16_byte_start, + utf16_byte_end, + } + } +} + diff --git a/api/src/models/message_text.rs b/api/src/models/message_text.rs new file mode 100644 index 00000000..dd457930 --- /dev/null +++ b/api/src/models/message_text.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MessageText { + /// Text content of the message part + #[serde(rename = "text")] + pub text: String, + /// The original language from which the message was translated, if applicable + #[serde(rename = "translated_from", skip_serializing_if = "Option::is_none")] + pub translated_from: Option, +} + +impl MessageText { + pub fn new(text: String) -> MessageText { + MessageText { + text, + translated_from: None, + } + } +} + diff --git a/api/src/models/metadata.rs b/api/src/models/metadata.rs new file mode 100644 index 00000000..c088c5f2 --- /dev/null +++ b/api/src/models/metadata.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Metadata { + #[serde(rename = "type")] + pub r#type: String, +} + +impl Metadata { + pub fn new(r#type: String) -> Metadata { + Metadata { + r#type, + } + } +} + diff --git a/api/src/models/microsoft_api.rs b/api/src/models/microsoft_api.rs new file mode 100644 index 00000000..8eaf8751 --- /dev/null +++ b/api/src/models/microsoft_api.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MicrosoftApi { + #[serde(rename = "kind")] + pub kind: models::EwsApiModelKind, +} + +impl MicrosoftApi { + pub fn new(kind: models::EwsApiModelKind) -> MicrosoftApi { + MicrosoftApi { + kind, + } + } +} + diff --git a/api/src/models/mod.rs b/api/src/models/mod.rs new file mode 100644 index 00000000..97f8defa --- /dev/null +++ b/api/src/models/mod.rs @@ -0,0 +1,1670 @@ +pub mod access; +pub use self::access::Access; +pub mod add_comments_request; +pub use self::add_comments_request::AddCommentsRequest; +pub mod add_comments_response; +pub use self::add_comments_response::AddCommentsResponse; +pub mod add_emails_to_bucket_request; +pub use self::add_emails_to_bucket_request::AddEmailsToBucketRequest; +pub mod add_emails_to_bucket_response; +pub use self::add_emails_to_bucket_response::AddEmailsToBucketResponse; +pub mod add_support_tenant_request; +pub use self::add_support_tenant_request::AddSupportTenantRequest; +pub mod add_support_tenant_response; +pub use self::add_support_tenant_response::AddSupportTenantResponse; +pub mod advance_stream_request; +pub use self::advance_stream_request::AdvanceStreamRequest; +pub mod advance_stream_response; +pub use self::advance_stream_response::AdvanceStreamResponse; +pub mod advance_trigger_request; +pub use self::advance_trigger_request::AdvanceTriggerRequest; +pub mod advance_trigger_response; +pub use self::advance_trigger_response::AdvanceTriggerResponse; +pub mod alert; +pub use self::alert::Alert; +pub mod alert_config; +pub use self::alert_config::AlertConfig; +pub mod alert_config_kind; +pub use self::alert_config_kind::AlertConfigKind; +pub mod alert_filter; +pub use self::alert_filter::AlertFilter; +pub mod alert_issues_response; +pub use self::alert_issues_response::AlertIssuesResponse; +pub mod alert_metric; +pub use self::alert_metric::AlertMetric; +pub mod alert_new; +pub use self::alert_new::AlertNew; +pub mod alert_process_threshold; +pub use self::alert_process_threshold::AlertProcessThreshold; +pub mod alert_process_variation; +pub use self::alert_process_variation::AlertProcessVariation; +pub mod alert_subscription; +pub use self::alert_subscription::AlertSubscription; +pub mod alert_update; +pub use self::alert_update::AlertUpdate; +pub mod amount_field_data_private; +pub use self::amount_field_data_private::AmountFieldDataPrivate; +pub mod annotated_comment; +pub use self::annotated_comment::AnnotatedComment; +pub mod annotation; +pub use self::annotation::Annotation; +pub mod annotation_label; +pub use self::annotation_label::AnnotationLabel; +pub mod annotation_metadata; +pub use self::annotation_metadata::AnnotationMetadata; +pub mod annotation_metadata_count; +pub use self::annotation_metadata_count::AnnotationMetadataCount; +pub mod annotations; +pub use self::annotations::Annotations; +pub mod app_access_model; +pub use self::app_access_model::AppAccessModel; +pub mod app_access_model_kind; +pub use self::app_access_model_kind::AppAccessModelKind; +pub mod application; +pub use self::application::Application; +pub mod assigned_predicted_present_filter; +pub use self::assigned_predicted_present_filter::AssignedPredictedPresentFilter; +pub mod assignment_method; +pub use self::assignment_method::AssignmentMethod; +pub mod attachment; +pub use self::attachment::Attachment; +pub mod attribute; +pub use self::attribute::Attribute; +pub mod attribute_filter; +pub use self::attribute_filter::AttributeFilter; +pub mod attribute_filter_attribute; +pub use self::attribute_filter_attribute::AttributeFilterAttribute; +pub mod attribution_method; +pub use self::attribution_method::AttributionMethod; +pub mod audit_event; +pub use self::audit_event::AuditEvent; +pub mod _audit_events_dataset; +pub use self::_audit_events_dataset::AuditEventsDataset; +pub mod _audit_events_project; +pub use self::_audit_events_project::AuditEventsProject; +pub mod _audit_events_source; +pub use self::_audit_events_source::AuditEventsSource; +pub mod _audit_events_tenant; +pub use self::_audit_events_tenant::AuditEventsTenant; +pub mod _audit_events_trigger; +pub use self::_audit_events_trigger::AuditEventsTrigger; +pub mod _audit_events_user; +pub use self::_audit_events_user::AuditEventsUser; +pub mod binary_label_health_action; +pub use self::binary_label_health_action::BinaryLabelHealthAction; +pub mod binary_label_health_action_kind; +pub use self::binary_label_health_action_kind::BinaryLabelHealthActionKind; +pub mod binary_label_health_warning; +pub use self::binary_label_health_warning::BinaryLabelHealthWarning; +pub mod binary_label_health_warning_kind; +pub use self::binary_label_health_warning_kind::BinaryLabelHealthWarningKind; +pub mod binning; +pub use self::binning::Binning; +pub mod bool_field_data_private; +pub use self::bool_field_data_private::BoolFieldDataPrivate; +pub mod bool_field_data_type; +pub use self::bool_field_data_type::BoolFieldDataType; +pub mod breakdown; +pub use self::breakdown::Breakdown; +pub mod bucket; +pub use self::bucket::Bucket; +pub mod bucket_new; +pub use self::bucket_new::BucketNew; +pub mod _bucket_statistics; +pub use self::_bucket_statistics::BucketStatistics; +pub mod bucket_sync_state; +pub use self::bucket_sync_state::BucketSyncState; +pub mod bucket_update; +pub use self::bucket_update::BucketUpdate; +pub mod bucket_updated_by; +pub use self::bucket_updated_by::BucketUpdatedBy; +pub mod builtin_label_def; +pub use self::builtin_label_def::BuiltinLabelDef; +pub mod builtin_label_def_name; +pub use self::builtin_label_def_name::BuiltinLabelDefName; +pub mod builtin_label_def_request; +pub use self::builtin_label_def_request::BuiltinLabelDefRequest; +pub mod business_rule; +pub use self::business_rule::BusinessRule; +pub mod business_rule_comparison_operator; +pub use self::business_rule_comparison_operator::BusinessRuleComparisonOperator; +pub mod business_rule_logical_operator; +pub use self::business_rule_logical_operator::BusinessRuleLogicalOperator; +pub mod business_rule_set; +pub use self::business_rule_set::BusinessRuleSet; +pub mod business_rule_set_criticality; +pub use self::business_rule_set_criticality::BusinessRuleSetCriticality; +pub mod business_rule_type; +pub use self::business_rule_type::BusinessRuleType; +pub mod by_labels; +pub use self::by_labels::ByLabels; +pub mod by_labels_include; +pub use self::by_labels_include::ByLabelsInclude; +pub mod _by_labels_include_container; +pub use self::_by_labels_include_container::ByLabelsIncludeContainer; +pub mod by_labels_top; +pub use self::by_labels_top::ByLabelsTop; +pub mod _by_labels_top_container; +pub use self::_by_labels_top_container::ByLabelsTopContainer; +pub mod capture_threshold; +pub use self::capture_threshold::CaptureThreshold; +pub mod choice_field_data_private; +pub use self::choice_field_data_private::ChoiceFieldDataPrivate; +pub mod choice_field_data_type; +pub use self::choice_field_data_type::ChoiceFieldDataType; +pub mod client_secret_application_model; +pub use self::client_secret_application_model::ClientSecretApplicationModel; +pub mod client_secret_application_model_kind; +pub use self::client_secret_application_model_kind::ClientSecretApplicationModelKind; +pub mod cm_model_config; +pub use self::cm_model_config::CmModelConfig; +pub mod comment; +pub use self::comment::Comment; +pub mod comment_extractions_predictions; +pub use self::comment_extractions_predictions::CommentExtractionsPredictions; +pub mod comment_filter; +pub use self::comment_filter::CommentFilter; +pub mod comment_new; +pub use self::comment_new::CommentNew; +pub mod comment_prediction; +pub use self::comment_prediction::CommentPrediction; +pub mod comment_sentiment; +pub use self::comment_sentiment::CommentSentiment; +pub mod comment_span_new_char; +pub use self::comment_span_new_char::CommentSpanNewChar; +pub mod comment_span_new_utf16; +pub use self::comment_span_new_utf16::CommentSpanNewUtf16; +pub mod comment_thread; +pub use self::comment_thread::CommentThread; +pub mod comparison; +pub use self::comparison::Comparison; +pub mod connection_model; +pub use self::connection_model::ConnectionModel; +pub mod content_part; +pub use self::content_part::ContentPart; +pub mod contribution; +pub use self::contribution::Contribution; +pub mod contributor; +pub use self::contributor::Contributor; +pub mod contributor_kind; +pub use self::contributor_kind::ContributorKind; +pub mod conversational_filter_request; +pub use self::conversational_filter_request::ConversationalFilterRequest; +pub mod conversational_filter_response; +pub use self::conversational_filter_response::ConversationalFilterResponse; +pub mod coocurrence; +pub use self::coocurrence::Coocurrence; +pub mod coocurrence_labels; +pub use self::coocurrence_labels::CoocurrenceLabels; +pub mod count; +pub use self::count::Count; +pub mod create_alert_request; +pub use self::create_alert_request::CreateAlertRequest; +pub mod create_alert_response; +pub use self::create_alert_response::CreateAlertResponse; +pub mod create_bucket_request; +pub use self::create_bucket_request::CreateBucketRequest; +pub mod create_bucket_response; +pub use self::create_bucket_response::CreateBucketResponse; +pub mod create_dashboard_request; +pub use self::create_dashboard_request::CreateDashboardRequest; +pub mod create_dashboard_response; +pub use self::create_dashboard_response::CreateDashboardResponse; +pub mod create_dataset_request; +pub use self::create_dataset_request::CreateDatasetRequest; +pub mod create_dataset_response; +pub use self::create_dataset_response::CreateDatasetResponse; +pub mod create_integration_request; +pub use self::create_integration_request::CreateIntegrationRequest; +pub mod create_integration_response; +pub use self::create_integration_response::CreateIntegrationResponse; +pub mod create_ixp_dataset_request; +pub use self::create_ixp_dataset_request::CreateIxpDatasetRequest; +pub mod create_ixp_dataset_response; +pub use self::create_ixp_dataset_response::CreateIxpDatasetResponse; +pub mod create_label_defs_bulk_response; +pub use self::create_label_defs_bulk_response::CreateLabelDefsBulkResponse; +pub mod create_label_group_request; +pub use self::create_label_group_request::CreateLabelGroupRequest; +pub mod create_label_group_response; +pub use self::create_label_group_response::CreateLabelGroupResponse; +pub mod create_or_update_label_defs_bulk_request; +pub use self::create_or_update_label_defs_bulk_request::CreateOrUpdateLabelDefsBulkRequest; +pub mod create_or_update_label_defs_bulk_request_label_defs_inner; +pub use self::create_or_update_label_defs_bulk_request_label_defs_inner::CreateOrUpdateLabelDefsBulkRequestLabelDefsInner; +pub mod create_page_view_request; +pub use self::create_page_view_request::CreatePageViewRequest; +pub mod create_page_view_response; +pub use self::create_page_view_response::CreatePageViewResponse; +pub mod create_project_request; +pub use self::create_project_request::CreateProjectRequest; +pub mod create_project_response; +pub use self::create_project_response::CreateProjectResponse; +pub mod create_project_setup_created_response; +pub use self::create_project_setup_created_response::CreateProjectSetupCreatedResponse; +pub mod create_project_setup_request; +pub use self::create_project_setup_request::CreateProjectSetupRequest; +pub mod create_project_setup_response; +pub use self::create_project_setup_response::CreateProjectSetupResponse; +pub mod create_source_request; +pub use self::create_source_request::CreateSourceRequest; +pub mod create_source_response; +pub use self::create_source_response::CreateSourceResponse; +pub mod create_stream_request; +pub use self::create_stream_request::CreateStreamRequest; +pub mod create_stream_response; +pub use self::create_stream_response::CreateStreamResponse; +pub mod create_tenant_request; +pub use self::create_tenant_request::CreateTenantRequest; +pub mod create_tenant_response; +pub use self::create_tenant_response::CreateTenantResponse; +pub mod create_trigger_request; +pub use self::create_trigger_request::CreateTriggerRequest; +pub mod create_trigger_response; +pub use self::create_trigger_response::CreateTriggerResponse; +pub mod create_user_request; +pub use self::create_user_request::CreateUserRequest; +pub mod create_user_response; +pub use self::create_user_response::CreateUserResponse; +pub mod custom_action; +pub use self::custom_action::CustomAction; +pub mod custom_training_action; +pub use self::custom_training_action::CustomTrainingAction; +pub mod dashboard; +pub use self::dashboard::Dashboard; +pub mod dashboard_update; +pub use self::dashboard_update::DashboardUpdate; +pub mod data; +pub use self::data::Data; +pub mod data_type; +pub use self::data_type::DataType; +pub mod data_type_date; +pub use self::data_type_date::DataTypeDate; +pub mod data_type_money; +pub use self::data_type_money::DataTypeMoney; +pub mod data_type_number; +pub use self::data_type_number::DataTypeNumber; +pub mod data_type_text; +pub use self::data_type_text::DataTypeText; +pub mod dataset; +pub use self::dataset::Dataset; +pub mod dataset_flag; +pub use self::dataset_flag::DatasetFlag; +pub mod dataset_new; +pub use self::dataset_new::DatasetNew; +pub mod dataset_operation; +pub use self::dataset_operation::DatasetOperation; +pub mod dataset_quality; +pub use self::dataset_quality::DatasetQuality; +pub mod dataset_status; +pub use self::dataset_status::DatasetStatus; +pub mod _dataset_string_summary_value; +pub use self::_dataset_string_summary_value::DatasetStringSummaryValue; +pub mod dataset_summary; +pub use self::dataset_summary::DatasetSummary; +pub mod dataset_training_action; +pub use self::dataset_training_action::DatasetTrainingAction; +pub mod dataset_update; +pub use self::dataset_update::DatasetUpdate; +pub mod dataset_update_entity_defs_inner; +pub use self::dataset_update_entity_defs_inner::DatasetUpdateEntityDefsInner; +pub mod dataset_user_properties_summary; +pub use self::dataset_user_properties_summary::DatasetUserPropertiesSummary; +pub mod _dataset_user_properties_summary_number; +pub use self::_dataset_user_properties_summary_number::DatasetUserPropertiesSummaryNumber; +pub mod _dataset_user_properties_summary_string; +pub use self::_dataset_user_properties_summary_string::DatasetUserPropertiesSummaryString; +pub mod date_field_data_private; +pub use self::date_field_data_private::DateFieldDataPrivate; +pub mod date_field_data_type; +pub use self::date_field_data_type::DateFieldDataType; +pub mod delete_alert_response; +pub use self::delete_alert_response::DeleteAlertResponse; +pub mod delete_alert_subscription_reponse; +pub use self::delete_alert_subscription_reponse::DeleteAlertSubscriptionReponse; +pub mod delete_bucket_response; +pub use self::delete_bucket_response::DeleteBucketResponse; +pub mod delete_comment_response; +pub use self::delete_comment_response::DeleteCommentResponse; +pub mod delete_dashboard_response; +pub use self::delete_dashboard_response::DeleteDashboardResponse; +pub mod delete_dataset_by_id_response; +pub use self::delete_dataset_by_id_response::DeleteDatasetByIdResponse; +pub mod delete_dataset_response; +pub use self::delete_dataset_response::DeleteDatasetResponse; +pub mod delete_integration_response; +pub use self::delete_integration_response::DeleteIntegrationResponse; +pub mod delete_ixp_dataset_response; +pub use self::delete_ixp_dataset_response::DeleteIxpDatasetResponse; +pub mod delete_keyed_sync_state_response; +pub use self::delete_keyed_sync_state_response::DeleteKeyedSyncStateResponse; +pub mod delete_label_def_response; +pub use self::delete_label_def_response::DeleteLabelDefResponse; +pub mod delete_label_group_response; +pub use self::delete_label_group_response::DeleteLabelGroupResponse; +pub mod delete_model_tag_response; +pub use self::delete_model_tag_response::DeleteModelTagResponse; +pub mod delete_project_response; +pub use self::delete_project_response::DeleteProjectResponse; +pub mod delete_source_response; +pub use self::delete_source_response::DeleteSourceResponse; +pub mod delete_stream_exception_response; +pub use self::delete_stream_exception_response::DeleteStreamExceptionResponse; +pub mod delete_stream_response; +pub use self::delete_stream_response::DeleteStreamResponse; +pub mod delete_tenant_default_project_permissions_response; +pub use self::delete_tenant_default_project_permissions_response::DeleteTenantDefaultProjectPermissionsResponse; +pub mod delete_tenant_response; +pub use self::delete_tenant_response::DeleteTenantResponse; +pub mod delete_trigger_response; +pub use self::delete_trigger_response::DeleteTriggerResponse; +pub mod delete_user_response; +pub use self::delete_user_response::DeleteUserResponse; +pub mod deprecated_user_model_metadata; +pub use self::deprecated_user_model_metadata::DeprecatedUserModelMetadata; +pub mod diagnostic; +pub use self::diagnostic::Diagnostic; +pub mod diagnostic_kind; +pub use self::diagnostic_kind::DiagnosticKind; +pub mod direction; +pub use self::direction::Direction; +pub mod disable_integration_action; +pub use self::disable_integration_action::DisableIntegrationAction; +pub mod disable_mailbox_action; +pub use self::disable_mailbox_action::DisableMailboxAction; +pub mod doc_path_ixp_model_config; +pub use self::doc_path_ixp_model_config::DocPathIxpModelConfig; +pub mod document_label_property_prediction; +pub use self::document_label_property_prediction::DocumentLabelPropertyPrediction; +pub mod document_search_result; +pub use self::document_search_result::DocumentSearchResult; +pub mod document_span; +pub use self::document_span::DocumentSpan; +pub mod email; +pub use self::email::Email; +pub mod email_metadata; +pub use self::email_metadata::EmailMetadata; +pub mod email_metadata_new; +pub use self::email_metadata_new::EmailMetadataNew; +pub mod email_new; +pub use self::email_new::EmailNew; +pub mod email_properties_summary; +pub use self::email_properties_summary::EmailPropertiesSummary; +pub mod email_properties_summary_by_property; +pub use self::email_properties_summary_by_property::EmailPropertiesSummaryByProperty; +pub mod email_properties_summary_value; +pub use self::email_properties_summary_value::EmailPropertiesSummaryValue; +pub mod email_property_counts; +pub use self::email_property_counts::EmailPropertyCounts; +pub mod email_property_counts_by_property; +pub use self::email_property_counts_by_property::EmailPropertyCountsByProperty; +pub mod email_property_counts_settings; +pub use self::email_property_counts_settings::EmailPropertyCountsSettings; +pub mod email_property_counts_settings_by_property; +pub use self::email_property_counts_settings_by_property::EmailPropertyCountsSettingsByProperty; +pub mod email_transform_tag_info; +pub use self::email_transform_tag_info::EmailTransformTagInfo; +pub mod entities; +pub use self::entities::Entities; +pub mod entities_new; +pub use self::entities_new::EntitiesNew; +pub mod entities_pr_stats; +pub use self::entities_pr_stats::EntitiesPrStats; +pub mod entities_rules; +pub use self::entities_rules::EntitiesRules; +pub mod entities_rules_presence_inner; +pub use self::entities_rules_presence_inner::EntitiesRulesPresenceInner; +pub mod entity; +pub use self::entity::Entity; +pub mod entity_average_stats; +pub use self::entity_average_stats::EntityAverageStats; +pub mod entity_def; +pub use self::entity_def::EntityDef; +pub mod entity_def_flag; +pub use self::entity_def_flag::EntityDefFlag; +pub mod entity_def_id_stat; +pub use self::entity_def_id_stat::EntityDefIdStat; +pub mod entity_def_new; +pub use self::entity_def_new::EntityDefNew; +pub mod entity_def_summary; +pub use self::entity_def_summary::EntityDefSummary; +pub mod entity_def_update; +pub use self::entity_def_update::EntityDefUpdate; +pub mod entity_def_update_inherits_from_inner; +pub use self::entity_def_update_inherits_from_inner::EntityDefUpdateInheritsFromInner; +pub mod entity_health; +pub use self::entity_health::EntityHealth; +pub mod entity_health_action; +pub use self::entity_health_action::EntityHealthAction; +pub mod entity_health_action_kind; +pub use self::entity_health_action_kind::EntityHealthActionKind; +pub mod entity_health_smart; +pub use self::entity_health_smart::EntityHealthSmart; +pub mod entity_health_warning; +pub use self::entity_health_warning::EntityHealthWarning; +pub mod entity_health_warning_kind; +pub use self::entity_health_warning_kind::EntityHealthWarningKind; +pub mod entity_kind; +pub use self::entity_kind::EntityKind; +pub mod entity_new; +pub use self::entity_new::EntityNew; +pub mod entity_new_spans_inner; +pub use self::entity_new_spans_inner::EntityNewSpansInner; +pub mod entity_presence_filter; +pub use self::entity_presence_filter::EntityPresenceFilter; +pub mod entity_presence_filter_with_kind; +pub use self::entity_presence_filter_with_kind::EntityPresenceFilterWithKind; +pub mod entity_rule_set_api; +pub use self::entity_rule_set_api::EntityRuleSetApi; +pub mod entity_rule_set_new_api; +pub use self::entity_rule_set_new_api::EntityRuleSetNewApi; +pub mod entity_rule_set_update_api; +pub use self::entity_rule_set_update_api::EntityRuleSetUpdateApi; +pub mod entity_rule_set_update_api_choices_inner; +pub use self::entity_rule_set_update_api_choices_inner::EntityRuleSetUpdateApiChoicesInner; +pub mod _entity_summary_v1; +pub use self::_entity_summary_v1::EntitySummaryV1; +pub mod entity_template_properties_api; +pub use self::entity_template_properties_api::EntityTemplatePropertiesApi; +pub mod entity_templates_properties_api; +pub use self::entity_templates_properties_api::EntityTemplatesPropertiesApi; +pub mod error_action; +pub use self::error_action::ErrorAction; +pub mod error_response; +pub use self::error_response::ErrorResponse; +pub mod ews_api_model; +pub use self::ews_api_model::EwsApiModel; +pub mod ews_api_model_kind; +pub use self::ews_api_model_kind::EwsApiModelKind; +pub mod _exact_bucket_count; +pub use self::_exact_bucket_count::ExactBucketCount; +pub mod exception_model; +pub use self::exception_model::ExceptionModel; +pub mod export_dataset_request; +pub use self::export_dataset_request::ExportDatasetRequest; +pub mod export_dataset_response; +pub use self::export_dataset_response::ExportDatasetResponse; +pub mod exported_annotations; +pub use self::exported_annotations::ExportedAnnotations; +pub mod exported_comment; +pub use self::exported_comment::ExportedComment; +pub mod exported_label; +pub use self::exported_label::ExportedLabel; +pub mod exported_labels; +pub use self::exported_labels::ExportedLabels; +pub mod exported_predictions; +pub use self::exported_predictions::ExportedPredictions; +pub mod extraction_field_definition; +pub use self::extraction_field_definition::ExtractionFieldDefinition; +pub mod extraction_prediction; +pub use self::extraction_prediction::ExtractionPrediction; +pub mod fetch_from_gx_stream_request; +pub use self::fetch_from_gx_stream_request::FetchFromGxStreamRequest; +pub mod fetch_from_gx_stream_response; +pub use self::fetch_from_gx_stream_response::FetchFromGxStreamResponse; +pub mod fetch_from_stream_request; +pub use self::fetch_from_stream_request::FetchFromStreamRequest; +pub mod fetch_from_stream_response; +pub use self::fetch_from_stream_response::FetchFromStreamResponse; +pub mod field_annotation_private; +pub use self::field_annotation_private::FieldAnnotationPrivate; +pub mod field_choice_api; +pub use self::field_choice_api::FieldChoiceApi; +pub mod field_choice_new_api; +pub use self::field_choice_new_api::FieldChoiceNewApi; +pub mod field_group_annotation_private; +pub use self::field_group_annotation_private::FieldGroupAnnotationPrivate; +pub mod field_group_prediction_private; +pub use self::field_group_prediction_private::FieldGroupPredictionPrivate; +pub mod field_group_snapshot; +pub use self::field_group_snapshot::FieldGroupSnapshot; +pub mod field_group_version_entry; +pub use self::field_group_version_entry::FieldGroupVersionEntry; +pub mod field_prediction_private; +pub use self::field_prediction_private::FieldPredictionPrivate; +pub mod field_snapshot; +pub use self::field_snapshot::FieldSnapshot; +pub mod field_type; +pub use self::field_type::FieldType; +pub mod field_uipath_context_model; +pub use self::field_uipath_context_model::FieldUipathContextModel; +pub mod field_value_private; +pub use self::field_value_private::FieldValuePrivate; +pub mod field_version_entry; +pub use self::field_version_entry::FieldVersionEntry; +pub mod filter; +pub use self::filter::Filter; +pub mod freshness; +pub use self::freshness::Freshness; +pub mod full_participant_filter; +pub use self::full_participant_filter::FullParticipantFilter; +pub mod gemini_table_only_config; +pub use self::gemini_table_only_config::GeminiTableOnlyConfig; +pub mod general_field_def; +pub use self::general_field_def::GeneralFieldDef; +pub mod general_field_def_new; +pub use self::general_field_def_new::GeneralFieldDefNew; +pub mod general_field_def_update; +pub use self::general_field_def_update::GeneralFieldDefUpdate; +pub mod general_field_definition; +pub use self::general_field_definition::GeneralFieldDefinition; +pub mod get_alert_response; +pub use self::get_alert_response::GetAlertResponse; +pub mod get_alert_subscriptions_response; +pub use self::get_alert_subscriptions_response::GetAlertSubscriptionsResponse; +pub mod get_all_alerts_response; +pub use self::get_all_alerts_response::GetAllAlertsResponse; +pub mod get_all_buckets_response; +pub use self::get_all_buckets_response::GetAllBucketsResponse; +pub mod get_all_dashboards_in_dataset_response; +pub use self::get_all_dashboards_in_dataset_response::GetAllDashboardsInDatasetResponse; +pub mod get_all_dashboards_in_project_response; +pub use self::get_all_dashboards_in_project_response::GetAllDashboardsInProjectResponse; +pub mod get_all_datasets_in_project_response; +pub use self::get_all_datasets_in_project_response::GetAllDatasetsInProjectResponse; +pub mod get_all_datasets_response; +pub use self::get_all_datasets_response::GetAllDatasetsResponse; +pub mod get_all_integrations_in_project_response; +pub use self::get_all_integrations_in_project_response::GetAllIntegrationsInProjectResponse; +pub mod get_all_integrations_response; +pub use self::get_all_integrations_response::GetAllIntegrationsResponse; +pub mod get_all_ixp_models_in_project_response; +pub use self::get_all_ixp_models_in_project_response::GetAllIxpModelsInProjectResponse; +pub mod get_all_ixp_projects_response; +pub use self::get_all_ixp_projects_response::GetAllIxpProjectsResponse; +pub mod get_all_label_groups_response; +pub use self::get_all_label_groups_response::GetAllLabelGroupsResponse; +pub mod get_all_models_in_dataset_request; +pub use self::get_all_models_in_dataset_request::GetAllModelsInDatasetRequest; +pub mod get_all_models_in_dataset_response; +pub use self::get_all_models_in_dataset_response::GetAllModelsInDatasetResponse; +pub mod get_all_projects_response; +pub use self::get_all_projects_response::GetAllProjectsResponse; +pub mod get_all_projects_v1_response; +pub use self::get_all_projects_v1_response::GetAllProjectsV1Response; +pub mod get_all_sources_in_project_response; +pub use self::get_all_sources_in_project_response::GetAllSourcesInProjectResponse; +pub mod get_all_sources_response; +pub use self::get_all_sources_response::GetAllSourcesResponse; +pub mod get_all_streams_response; +pub use self::get_all_streams_response::GetAllStreamsResponse; +pub mod get_all_triggers_in_dataset_response; +pub use self::get_all_triggers_in_dataset_response::GetAllTriggersInDatasetResponse; +pub mod get_bucket_by_id_response; +pub use self::get_bucket_by_id_response::GetBucketByIdResponse; +pub mod get_bucket_emails_request; +pub use self::get_bucket_emails_request::GetBucketEmailsRequest; +pub mod get_bucket_emails_response; +pub use self::get_bucket_emails_response::GetBucketEmailsResponse; +pub mod get_bucket_response; +pub use self::get_bucket_response::GetBucketResponse; +pub mod get_bucket_statistics_response; +pub use self::get_bucket_statistics_response::GetBucketStatisticsResponse; +pub mod get_bucket_sync_state_response; +pub use self::get_bucket_sync_state_response::GetBucketSyncStateResponse; +pub mod get_buckets_by_owner_response; +pub use self::get_buckets_by_owner_response::GetBucketsByOwnerResponse; +pub mod get_comment_predictions_request; +pub use self::get_comment_predictions_request::GetCommentPredictionsRequest; +pub mod get_comment_predictions_response; +pub use self::get_comment_predictions_response::GetCommentPredictionsResponse; +pub mod get_comment_response; +pub use self::get_comment_response::GetCommentResponse; +pub mod get_comparison_request; +pub use self::get_comparison_request::GetComparisonRequest; +pub mod get_comparison_response; +pub use self::get_comparison_response::GetComparisonResponse; +pub mod get_dashboard_response; +pub use self::get_dashboard_response::GetDashboardResponse; +pub mod get_dataset_response; +pub use self::get_dataset_response::GetDatasetResponse; +pub mod get_dataset_statistics_request; +pub use self::get_dataset_statistics_request::GetDatasetStatisticsRequest; +pub mod get_dataset_statistics_response; +pub use self::get_dataset_statistics_response::GetDatasetStatisticsResponse; +pub mod get_dataset_status_response; +pub use self::get_dataset_status_response::GetDatasetStatusResponse; +pub mod get_dataset_summary_request; +pub use self::get_dataset_summary_request::GetDatasetSummaryRequest; +pub mod get_dataset_summary_response; +pub use self::get_dataset_summary_response::GetDatasetSummaryResponse; +pub mod get_dataset_user_properties_summary_response; +pub use self::get_dataset_user_properties_summary_response::GetDatasetUserPropertiesSummaryResponse; +pub mod get_deprecated_user_models_response; +pub use self::get_deprecated_user_models_response::GetDeprecatedUserModelsResponse; +pub mod get_derived_permission_response; +pub use self::get_derived_permission_response::GetDerivedPermissionResponse; +pub mod get_derived_permissions_request; +pub use self::get_derived_permissions_request::GetDerivedPermissionsRequest; +pub mod get_document_metadata_response; +pub use self::get_document_metadata_response::GetDocumentMetadataResponse; +pub mod get_document_search_response; +pub use self::get_document_search_response::GetDocumentSearchResponse; +pub mod get_email_from_bucket_by_id_response; +pub use self::get_email_from_bucket_by_id_response::GetEmailFromBucketByIdResponse; +pub mod get_email_transform_tag_info_response; +pub use self::get_email_transform_tag_info_response::GetEmailTransformTagInfoResponse; +pub mod get_field_group_history_response; +pub use self::get_field_group_history_response::GetFieldGroupHistoryResponse; +pub mod get_field_history_response; +pub use self::get_field_history_response::GetFieldHistoryResponse; +pub mod get_integration_by_id_response; +pub use self::get_integration_by_id_response::GetIntegrationByIdResponse; +pub mod get_integration_errors_response; +pub use self::get_integration_errors_response::GetIntegrationErrorsResponse; +pub mod get_integration_response; +pub use self::get_integration_response::GetIntegrationResponse; +pub mod get_issue_response; +pub use self::get_issue_response::GetIssueResponse; +pub mod get_ixp_consumability_info_response; +pub use self::get_ixp_consumability_info_response::GetIxpConsumabilityInfoResponse; +pub mod get_ixp_project_response; +pub use self::get_ixp_project_response::GetIxpProjectResponse; +pub mod get_keyed_sync_state_response; +pub use self::get_keyed_sync_state_response::GetKeyedSyncStateResponse; +pub mod get_label_def_response; +pub use self::get_label_def_response::GetLabelDefResponse; +pub mod get_label_group_response; +pub use self::get_label_group_response::GetLabelGroupResponse; +pub mod get_label_validation_request; +pub use self::get_label_validation_request::GetLabelValidationRequest; +pub mod get_label_validation_response; +pub use self::get_label_validation_response::GetLabelValidationResponse; +pub mod get_labellings_response; +pub use self::get_labellings_response::GetLabellingsResponse; +pub mod get_model_tags_response; +pub use self::get_model_tags_response::GetModelTagsResponse; +pub mod get_page_selections_response; +pub use self::get_page_selections_response::GetPageSelectionsResponse; +pub mod get_pretrained_labels_response; +pub use self::get_pretrained_labels_response::GetPretrainedLabelsResponse; +pub mod get_project_resource_counts_response; +pub use self::get_project_resource_counts_response::GetProjectResourceCountsResponse; +pub mod get_project_response; +pub use self::get_project_response::GetProjectResponse; +pub mod get_qualified_login_url_request; +pub use self::get_qualified_login_url_request::GetQualifiedLoginUrlRequest; +pub mod get_qualified_login_url_response; +pub use self::get_qualified_login_url_response::GetQualifiedLoginUrlResponse; +pub mod get_quotas_for_tenant_response; +pub use self::get_quotas_for_tenant_response::GetQuotasForTenantResponse; +pub mod get_reduced_permissions_request; +pub use self::get_reduced_permissions_request::GetReducedPermissionsRequest; +pub mod get_reduced_permissions_response; +pub use self::get_reduced_permissions_response::GetReducedPermissionsResponse; +pub mod get_reduced_permissions_response_permissions_inner; +pub use self::get_reduced_permissions_response_permissions_inner::GetReducedPermissionsResponsePermissionsInner; +pub mod get_source_by_id_response; +pub use self::get_source_by_id_response::GetSourceByIdResponse; +pub mod get_source_comments_response; +pub use self::get_source_comments_response::GetSourceCommentsResponse; +pub mod get_source_comments_response_thread_properties_inner; +pub use self::get_source_comments_response_thread_properties_inner::GetSourceCommentsResponseThreadPropertiesInner; +pub mod get_source_response; +pub use self::get_source_response::GetSourceResponse; +pub mod get_source_statistics_request; +pub use self::get_source_statistics_request::GetSourceStatisticsRequest; +pub mod get_source_statistics_response; +pub use self::get_source_statistics_response::GetSourceStatisticsResponse; +pub mod get_stream_by_name_response; +pub use self::get_stream_by_name_response::GetStreamByNameResponse; +pub mod get_stream_results_response; +pub use self::get_stream_results_response::GetStreamResultsResponse; +pub mod get_subdomain_response; +pub use self::get_subdomain_response::GetSubdomainResponse; +pub mod get_tenant_client_subnets_response; +pub use self::get_tenant_client_subnets_response::GetTenantClientSubnetsResponse; +pub mod get_tenant_default_project_permissions_response; +pub use self::get_tenant_default_project_permissions_response::GetTenantDefaultProjectPermissionsResponse; +pub mod get_tenant_domains_response; +pub use self::get_tenant_domains_response::GetTenantDomainsResponse; +pub mod get_tenant_entity_def_ids_response; +pub use self::get_tenant_entity_def_ids_response::GetTenantEntityDefIdsResponse; +pub mod get_tenant_quota_response; +pub use self::get_tenant_quota_response::GetTenantQuotaResponse; +pub mod get_tenants_response; +pub use self::get_tenants_response::GetTenantsResponse; +pub mod get_themes_response; +pub use self::get_themes_response::GetThemesResponse; +pub mod get_thread_themes_request; +pub use self::get_thread_themes_request::GetThreadThemesRequest; +pub mod get_thread_themes_response; +pub use self::get_thread_themes_response::GetThreadThemesResponse; +pub mod get_threads_by_source_response; +pub use self::get_threads_by_source_response::GetThreadsBySourceResponse; +pub mod get_training_actions_comment_uids_response; +pub use self::get_training_actions_comment_uids_response::GetTrainingActionsCommentUidsResponse; +pub mod get_training_actions_labels_response; +pub use self::get_training_actions_labels_response::GetTrainingActionsLabelsResponse; +pub mod get_training_actions_labels_response_training_actions_labels_inner; +pub use self::get_training_actions_labels_response_training_actions_labels_inner::GetTrainingActionsLabelsResponseTrainingActionsLabelsInner; +pub mod get_trigger_response; +pub use self::get_trigger_response::GetTriggerResponse; +pub mod get_user_by_id_response; +pub use self::get_user_by_id_response::GetUserByIdResponse; +pub mod get_users_response; +pub use self::get_users_response::GetUsersResponse; +pub mod get_users_v1_response; +pub use self::get_users_v1_response::GetUsersV1Response; +pub mod get_validation_response; +pub use self::get_validation_response::GetValidationResponse; +pub mod get_validation_v1_response; +pub use self::get_validation_v1_response::GetValidationV1Response; +pub mod global_permission; +pub use self::global_permission::GlobalPermission; +pub mod gpt_ixp_flag; +pub use self::gpt_ixp_flag::GptIxpFlag; +pub mod gpt_ixp_model_config; +pub use self::gpt_ixp_model_config::GptIxpModelConfig; +pub mod gpt_model_version; +pub use self::gpt_model_version::GptModelVersion; +pub mod graph_api_model; +pub use self::graph_api_model::GraphApiModel; +pub mod graph_api_model_kind; +pub use self::graph_api_model_kind::GraphApiModelKind; +pub mod group_labellings_request; +pub use self::group_labellings_request::GroupLabellingsRequest; +pub mod group_predictions; +pub use self::group_predictions::GroupPredictions; +pub mod headers; +pub use self::headers::Headers; +pub mod highlight; +pub use self::highlight::Highlight; +pub mod histogram_bin; +pub use self::histogram_bin::HistogramBin; +pub mod image_input_config; +pub use self::image_input_config::ImageInputConfig; +pub mod import_taxonomy_request; +pub use self::import_taxonomy_request::ImportTaxonomyRequest; +pub mod import_taxonomy_response; +pub use self::import_taxonomy_response::ImportTaxonomyResponse; +pub mod inference_stats; +pub use self::inference_stats::InferenceStats; +pub mod inherits_from; +pub use self::inherits_from::InheritsFrom; +pub mod input_config; +pub use self::input_config::InputConfig; +pub mod integration; +pub use self::integration::Integration; +pub mod integration_disabled_reason; +pub use self::integration_disabled_reason::IntegrationDisabledReason; +pub mod integration_error; +pub use self::integration_error::IntegrationError; +pub mod integration_error_details; +pub use self::integration_error_details::IntegrationErrorDetails; +pub mod integration_new; +pub use self::integration_new::IntegrationNew; +pub mod integration_type; +pub use self::integration_type::IntegrationType; +pub mod integration_update; +pub use self::integration_update::IntegrationUpdate; +pub mod integrations_o_auth2_authenticate_response; +pub use self::integrations_o_auth2_authenticate_response::IntegrationsOAuth2AuthenticateResponse; +pub mod intent_threshold; +pub use self::intent_threshold::IntentThreshold; +pub mod intent_validation; +pub use self::intent_validation::IntentValidation; +pub mod intent_validation_summary; +pub use self::intent_validation_summary::IntentValidationSummary; +pub mod intents_value; +pub use self::intents_value::IntentsValue; +pub mod interpretation_span; +pub use self::interpretation_span::InterpretationSpan; +pub mod issue; +pub use self::issue::Issue; +pub mod issue_detail; +pub use self::issue_detail::IssueDetail; +pub mod issue_status; +pub use self::issue_status::IssueStatus; +pub mod iterative_config; +pub use self::iterative_config::IterativeConfig; +pub mod ixp_confidence; +pub use self::ixp_confidence::IxpConfidence; +pub mod ixp_dataset_new; +pub use self::ixp_dataset_new::IxpDatasetNew; +pub mod ixp_extraction_status; +pub use self::ixp_extraction_status::IxpExtractionStatus; +pub mod ixp_field; +pub use self::ixp_field::IxpField; +pub mod ixp_field_group; +pub use self::ixp_field_group::IxpFieldGroup; +pub mod ixp_field_type; +pub use self::ixp_field_type::IxpFieldType; +pub mod ixp_model_metadata; +pub use self::ixp_model_metadata::IxpModelMetadata; +pub mod ixp_predict_extractions_response; +pub use self::ixp_predict_extractions_response::IxpPredictExtractionsResponse; +pub mod ixp_project; +pub use self::ixp_project::IxpProject; +pub mod ixp_relative_urls; +pub use self::ixp_relative_urls::IxpRelativeUrls; +pub mod ixp_taxonomy; +pub use self::ixp_taxonomy::IxpTaxonomy; +pub mod ixp_taxonomy_extraction; +pub use self::ixp_taxonomy_extraction::IxpTaxonomyExtraction; +pub mod ixp_upload_document_response; +pub use self::ixp_upload_document_response::IxpUploadDocumentResponse; +pub mod ixp_uploaded_document; +pub use self::ixp_uploaded_document::IxpUploadedDocument; +pub mod keyed_folder_sync_state; +pub use self::keyed_folder_sync_state::KeyedFolderSyncState; +pub mod keyed_folder_sync_state_update; +pub use self::keyed_folder_sync_state_update::KeyedFolderSyncStateUpdate; +pub mod keyed_mailbox_sync_state; +pub use self::keyed_mailbox_sync_state::KeyedMailboxSyncState; +pub mod keyed_mailbox_sync_state_update; +pub use self::keyed_mailbox_sync_state_update::KeyedMailboxSyncStateUpdate; +pub mod keyed_sync_state; +pub use self::keyed_sync_state::KeyedSyncState; +pub mod keyed_sync_state_1; +pub use self::keyed_sync_state_1::KeyedSyncState1; +pub mod label; +pub use self::label::Label; +pub mod label_action; +pub use self::label_action::LabelAction; +pub mod label_collection; +pub use self::label_collection::LabelCollection; +pub mod label_comparison; +pub use self::label_comparison::LabelComparison; +pub mod label_counts; +pub use self::label_counts::LabelCounts; +pub mod label_def; +pub use self::label_def::LabelDef; +pub mod label_def_flag; +pub use self::label_def_flag::LabelDefFlag; +pub mod label_def_new; +pub use self::label_def_new::LabelDefNew; +pub mod label_def_property; +pub use self::label_def_property::LabelDefProperty; +pub mod label_def_update; +pub use self::label_def_update::LabelDefUpdate; +pub mod label_def_update_moon_form_inner; +pub use self::label_def_update_moon_form_inner::LabelDefUpdateMoonFormInner; +pub mod label_def_update_request; +pub use self::label_def_update_request::LabelDefUpdateRequest; +pub mod label_definition; +pub use self::label_definition::LabelDefinition; +pub mod label_group; +pub use self::label_group::LabelGroup; +pub mod label_group_new; +pub use self::label_group_new::LabelGroupNew; +pub mod label_health; +pub use self::label_health::LabelHealth; +pub mod label_health_action; +pub use self::label_health_action::LabelHealthAction; +pub mod label_health_smart; +pub use self::label_health_smart::LabelHealthSmart; +pub mod label_health_warning; +pub use self::label_health_warning::LabelHealthWarning; +pub mod label_metrics; +pub use self::label_metrics::LabelMetrics; +pub mod label_name_only_response; +pub use self::label_name_only_response::LabelNameOnlyResponse; +pub mod label_properties_digest; +pub use self::label_properties_digest::LabelPropertiesDigest; +pub mod label_property; +pub use self::label_property::LabelProperty; +pub mod label_property_digest; +pub use self::label_property_digest::LabelPropertyDigest; +pub mod label_property_id; +pub use self::label_property_id::LabelPropertyId; +pub mod label_property_name; +pub use self::label_property_name::LabelPropertyName; +pub mod label_property_summary; +pub use self::label_property_summary::LabelPropertySummary; +pub mod label_property_summary_label; +pub use self::label_property_summary_label::LabelPropertySummaryLabel; +pub mod label_property_time_series_row; +pub use self::label_property_time_series_row::LabelPropertyTimeSeriesRow; +pub mod label_sentiment; +pub use self::label_sentiment::LabelSentiment; +pub mod label_suggestion_reasoning; +pub use self::label_suggestion_reasoning::LabelSuggestionReasoning; +pub mod _label_summary_v1; +pub use self::_label_summary_v1::LabelSummaryV1; +pub mod label_timeseries_entry; +pub use self::label_timeseries_entry::LabelTimeseriesEntry; +pub mod label_training_action; +pub use self::label_training_action::LabelTrainingAction; +pub mod label_validation_summary; +pub use self::label_validation_summary::LabelValidationSummary; +pub mod labelling_group; +pub use self::labelling_group::LabellingGroup; +pub mod language; +pub use self::language::Language; +pub mod legacy_entity_pattern_api; +pub use self::legacy_entity_pattern_api::LegacyEntityPatternApi; +pub mod list_keyed_sync_states_response; +pub use self::list_keyed_sync_states_response::ListKeyedSyncStatesResponse; +pub mod list_keyed_sync_states_response_keyed_sync_states_inner; +pub use self::list_keyed_sync_states_response_keyed_sync_states_inner::ListKeyedSyncStatesResponseKeyedSyncStatesInner; +pub mod locales; +pub use self::locales::Locales; +pub mod locales_preferences; +pub use self::locales_preferences::LocalesPreferences; +pub mod _lower_bound_bucket_count; +pub use self::_lower_bound_bucket_count::LowerBoundBucketCount; +pub mod markup_break; +pub use self::markup_break::MarkupBreak; +pub mod markup_break_kind; +pub use self::markup_break_kind::MarkupBreakKind; +pub mod markup_image; +pub use self::markup_image::MarkupImage; +pub mod markup_link; +pub use self::markup_link::MarkupLink; +pub mod markup_list; +pub use self::markup_list::MarkupList; +pub mod markup_list_item; +pub use self::markup_list_item::MarkupListItem; +pub mod markup_list_kind; +pub use self::markup_list_kind::MarkupListKind; +pub mod markup_paragraph; +pub use self::markup_paragraph::MarkupParagraph; +pub mod markup_paragraph_kind; +pub use self::markup_paragraph_kind::MarkupParagraphKind; +pub mod markup_style; +pub use self::markup_style::MarkupStyle; +pub mod markup_style_kind; +pub use self::markup_style_kind::MarkupStyleKind; +pub mod markup_table; +pub use self::markup_table::MarkupTable; +pub mod markup_table_caption; +pub use self::markup_table_caption::MarkupTableCaption; +pub mod markup_table_cell; +pub use self::markup_table_cell::MarkupTableCell; +pub mod markup_table_cell_children_inner; +pub use self::markup_table_cell_children_inner::MarkupTableCellChildrenInner; +pub mod markup_table_cell_kind; +pub use self::markup_table_cell_kind::MarkupTableCellKind; +pub mod markup_table_row; +pub use self::markup_table_row::MarkupTableRow; +pub mod markup_table_section_kind; +pub use self::markup_table_section_kind::MarkupTableSectionKind; +pub mod markup_text; +pub use self::markup_text::MarkupText; +pub mod matched_field_group_extractions; +pub use self::matched_field_group_extractions::MatchedFieldGroupExtractions; +pub mod mean_pr_curve; +pub use self::mean_pr_curve::MeanPrCurve; +pub mod message; +pub use self::message::Message; +pub mod message_filter; +pub use self::message_filter::MessageFilter; +pub mod message_rich_text; +pub use self::message_rich_text::MessageRichText; +pub mod message_rich_text_text_markup_inner; +pub use self::message_rich_text_text_markup_inner::MessageRichTextTextMarkupInner; +pub mod message_span; +pub use self::message_span::MessageSpan; +pub mod message_text; +pub use self::message_text::MessageText; +pub mod metadata; +pub use self::metadata::Metadata; +pub mod microsoft_api; +pub use self::microsoft_api::MicrosoftApi; +pub mod model_config; +pub use self::model_config::ModelConfig; +pub mod model_definition; +pub use self::model_definition::ModelDefinition; +pub mod model_error; +pub use self::model_error::ModelError; +pub mod model_error_kind; +pub use self::model_error_kind::ModelErrorKind; +pub mod model_family; +pub use self::model_family::ModelFamily; +pub mod model_name; +pub use self::model_name::ModelName; +pub mod model_rating; +pub use self::model_rating::ModelRating; +pub mod model_rating_action; +pub use self::model_rating_action::ModelRatingAction; +pub mod model_rating_factor; +pub use self::model_rating_factor::ModelRatingFactor; +pub mod model_rating_factor_kind; +pub use self::model_rating_factor_kind::ModelRatingFactorKind; +pub mod model_taxonomy; +pub use self::model_taxonomy::ModelTaxonomy; +pub mod monetary_field_data_private; +pub use self::monetary_field_data_private::MonetaryFieldDataPrivate; +pub mod monetary_quantity_field_data_type; +pub use self::monetary_quantity_field_data_type::MonetaryQuantityFieldDataType; +pub mod moon_form_capture_fields_annotation; +pub use self::moon_form_capture_fields_annotation::MoonFormCaptureFieldsAnnotation; +pub mod moon_form_capture_fields_annotation_new; +pub use self::moon_form_capture_fields_annotation_new::MoonFormCaptureFieldsAnnotationNew; +pub mod moon_form_capture_fields_prediction; +pub use self::moon_form_capture_fields_prediction::MoonFormCaptureFieldsPrediction; +pub mod moon_form_dismissed_update; +pub use self::moon_form_dismissed_update::MoonFormDismissedUpdate; +pub mod moon_form_field_annotation; +pub use self::moon_form_field_annotation::MoonFormFieldAnnotation; +pub mod moon_form_field_annotation_new; +pub use self::moon_form_field_annotation_new::MoonFormFieldAnnotationNew; +pub mod moon_form_field_def; +pub use self::moon_form_field_def::MoonFormFieldDef; +pub mod moon_form_field_def_new; +pub use self::moon_form_field_def_new::MoonFormFieldDefNew; +pub mod moon_form_field_def_update; +pub use self::moon_form_field_def_update::MoonFormFieldDefUpdate; +pub mod moon_form_field_prediction; +pub use self::moon_form_field_prediction::MoonFormFieldPrediction; +pub mod moon_form_group; +pub use self::moon_form_group::MoonFormGroup; +pub mod moon_form_group_update; +pub use self::moon_form_group_update::MoonFormGroupUpdate; +pub mod moon_form_label_annotation; +pub use self::moon_form_label_annotation::MoonFormLabelAnnotation; +pub mod moon_form_label_annotation_update; +pub use self::moon_form_label_annotation_update::MoonFormLabelAnnotationUpdate; +pub mod moon_form_label_prediction; +pub use self::moon_form_label_prediction::MoonFormLabelPrediction; +pub mod moon_intent_fields_metrics; +pub use self::moon_intent_fields_metrics::MoonIntentFieldsMetrics; +pub mod moon_intent_validation_request; +pub use self::moon_intent_validation_request::MoonIntentValidationRequest; +pub mod moon_summary_metrics; +pub use self::moon_summary_metrics::MoonSummaryMetrics; +pub mod moon_validation; +pub use self::moon_validation::MoonValidation; +pub mod name; +pub use self::name::Name; +pub mod new_dashboard; +pub use self::new_dashboard::NewDashboard; +pub mod no_ui_metadata_reason; +pub use self::no_ui_metadata_reason::NoUiMetadataReason; +pub mod nps_summary; +pub use self::nps_summary::NpsSummary; +pub mod ntlm_application_model; +pub use self::ntlm_application_model::NtlmApplicationModel; +pub mod ntlm_application_model_kind; +pub use self::ntlm_application_model_kind::NtlmApplicationModelKind; +pub mod nullable_string_array_filter; +pub use self::nullable_string_array_filter::NullableStringArrayFilter; +pub mod number_field_data_type; +pub use self::number_field_data_type::NumberFieldDataType; +pub mod number_one_of_filter; +pub use self::number_one_of_filter::NumberOneOfFilter; +pub mod number_range_filter; +pub use self::number_range_filter::NumberRangeFilter; +pub mod number_range_filter_with_kind; +pub use self::number_range_filter_with_kind::NumberRangeFilterWithKind; +pub mod number_user_property_summary; +pub use self::number_user_property_summary::NumberUserPropertySummary; +pub mod o_auth2_salesforce_callback_request; +pub use self::o_auth2_salesforce_callback_request::OAuth2SalesforceCallbackRequest; +pub mod o_auth2_salesforce_callback_response; +pub use self::o_auth2_salesforce_callback_response::OAuth2SalesforceCallbackResponse; +pub mod optimal_threshold; +pub use self::optimal_threshold::OptimalThreshold; +pub mod order; +pub use self::order::Order; +pub mod page_dimensions; +pub use self::page_dimensions::PageDimensions; +pub mod page_metadata; +pub use self::page_metadata::PageMetadata; +pub mod page_polygon; +pub use self::page_polygon::PagePolygon; +pub mod page_selection; +pub use self::page_selection::PageSelection; +pub mod parse_email_new_comment; +pub use self::parse_email_new_comment::ParseEmailNewComment; +pub mod parsed_value; +pub use self::parsed_value::ParsedValue; +pub mod period; +pub use self::period::Period; +pub mod pin_model_response; +pub use self::pin_model_response::PinModelResponse; +pub mod poll_trigger_request; +pub use self::poll_trigger_request::PollTriggerRequest; +pub mod poll_trigger_response; +pub use self::poll_trigger_response::PollTriggerResponse; +pub mod pr_curve; +pub use self::pr_curve::PrCurve; +pub mod predict_document; +pub use self::predict_document::PredictDocument; +pub mod predict_extractions_request; +pub use self::predict_extractions_request::PredictExtractionsRequest; +pub mod predict_extractions_response; +pub use self::predict_extractions_response::PredictExtractionsResponse; +pub mod predict_latest_request; +pub use self::predict_latest_request::PredictLatestRequest; +pub mod predict_latest_response; +pub use self::predict_latest_response::PredictLatestResponse; +pub mod predict_raw_emails_request; +pub use self::predict_raw_emails_request::PredictRawEmailsRequest; +pub mod predict_raw_emails_response; +pub use self::predict_raw_emails_response::PredictRawEmailsResponse; +pub mod predict_request; +pub use self::predict_request::PredictRequest; +pub mod predict_response; +pub use self::predict_response::PredictResponse; +pub mod predicted_entity; +pub use self::predicted_entity::PredictedEntity; +pub mod predicted_label; +pub use self::predicted_label::PredictedLabel; +pub mod predicted_label_property; +pub use self::predicted_label_property::PredictedLabelProperty; +pub mod predictions_model; +pub use self::predictions_model::PredictionsModel; +pub mod preference; +pub use self::preference::Preference; +pub mod preferred_locale; +pub use self::preferred_locale::PreferredLocale; +pub mod preview_alert_request; +pub use self::preview_alert_request::PreviewAlertRequest; +pub mod preview_alert_response; +pub use self::preview_alert_response::PreviewAlertResponse; +pub mod private_key_application_model; +pub use self::private_key_application_model::PrivateKeyApplicationModel; +pub mod private_key_application_model_kind; +pub use self::private_key_application_model_kind::PrivateKeyApplicationModelKind; +pub mod process; +pub use self::process::Process; +pub mod project; +pub use self::project::Project; +pub mod project_new; +pub use self::project_new::ProjectNew; +pub mod project_permission; +pub use self::project_permission::ProjectPermission; +pub mod project_setup_existing_source; +pub use self::project_setup_existing_source::ProjectSetupExistingSource; +pub mod project_setup_new_dataset; +pub use self::project_setup_new_dataset::ProjectSetupNewDataset; +pub mod project_setup_new_project; +pub use self::project_setup_new_project::ProjectSetupNewProject; +pub mod project_setup_new_source; +pub use self::project_setup_new_source::ProjectSetupNewSource; +pub mod project_setup_new_stream; +pub use self::project_setup_new_stream::ProjectSetupNewStream; +pub mod project_setup_new_users; +pub use self::project_setup_new_users::ProjectSetupNewUsers; +pub mod project_v1; +pub use self::project_v1::ProjectV1; +pub mod put_comment_as_seen_request; +pub use self::put_comment_as_seen_request::PutCommentAsSeenRequest; +pub mod put_comment_as_seen_response; +pub use self::put_comment_as_seen_response::PutCommentAsSeenResponse; +pub mod query_audit_events_filter; +pub use self::query_audit_events_filter::QueryAuditEventsFilter; +pub mod query_audit_events_request; +pub use self::query_audit_events_request::QueryAuditEventsRequest; +pub mod query_audit_events_response; +pub use self::query_audit_events_response::QueryAuditEventsResponse; +pub mod _query_comments_order_any_label; +pub use self::_query_comments_order_any_label::QueryCommentsOrderAnyLabel; +pub mod _query_comments_order_attachment_text_search; +pub use self::_query_comments_order_attachment_text_search::QueryCommentsOrderAttachmentTextSearch; +pub mod _query_comments_order_by_label; +pub use self::_query_comments_order_by_label::QueryCommentsOrderByLabel; +pub mod _query_comments_order_check; +pub use self::_query_comments_order_check::QueryCommentsOrderCheck; +pub mod _query_comments_order_diagnostic; +pub use self::_query_comments_order_diagnostic::QueryCommentsOrderDiagnostic; +pub mod _query_comments_order_label_property; +pub use self::_query_comments_order_label_property::QueryCommentsOrderLabelProperty; +pub mod _query_comments_order_learning; +pub use self::_query_comments_order_learning::QueryCommentsOrderLearning; +pub mod _query_comments_order_missed; +pub use self::_query_comments_order_missed::QueryCommentsOrderMissed; +pub mod _query_comments_order_recent; +pub use self::_query_comments_order_recent::QueryCommentsOrderRecent; +pub mod _query_comments_order_sample; +pub use self::_query_comments_order_sample::QueryCommentsOrderSample; +pub mod _query_comments_order_text_search; +pub use self::_query_comments_order_text_search::QueryCommentsOrderTextSearch; +pub mod query_comments_request; +pub use self::query_comments_request::QueryCommentsRequest; +pub mod query_comments_response; +pub use self::query_comments_response::QueryCommentsResponse; +pub mod _query_dataset_user_property_values_filter; +pub use self::_query_dataset_user_property_values_filter::QueryDatasetUserPropertyValuesFilter; +pub mod query_dataset_user_property_values_request; +pub use self::query_dataset_user_property_values_request::QueryDatasetUserPropertyValuesRequest; +pub mod query_dataset_user_property_values_response; +pub use self::query_dataset_user_property_values_response::QueryDatasetUserPropertyValuesResponse; +pub mod query_issues_request; +pub use self::query_issues_request::QueryIssuesRequest; +pub mod query_issues_response; +pub use self::query_issues_response::QueryIssuesResponse; +pub mod query_keyed_sync_state_ids_request; +pub use self::query_keyed_sync_state_ids_request::QueryKeyedSyncStateIdsRequest; +pub mod query_keyed_sync_state_ids_response; +pub use self::query_keyed_sync_state_ids_response::QueryKeyedSyncStateIdsResponse; +pub mod query_result_counts; +pub use self::query_result_counts::QueryResultCounts; +pub mod quota; +pub use self::quota::Quota; +pub mod quota_kind; +pub use self::quota_kind::QuotaKind; +pub mod raw_email; +pub use self::raw_email::RawEmail; +pub mod _raw_email_body; +pub use self::_raw_email_body::RawEmailBody; +pub mod raw_email_document; +pub use self::raw_email_document::RawEmailDocument; +pub mod _raw_email_headers_parsed; +pub use self::_raw_email_headers_parsed::RawEmailHeadersParsed; +pub mod _raw_email_headers_raw; +pub use self::_raw_email_headers_raw::RawEmailHeadersRaw; +pub mod regex; +pub use self::regex::Regex; +pub mod remove_support_tenant_request; +pub use self::remove_support_tenant_request::RemoveSupportTenantRequest; +pub mod remove_support_tenant_response; +pub use self::remove_support_tenant_response::RemoveSupportTenantResponse; +pub mod reset_annotations_to_previous_pinned_model_request; +pub use self::reset_annotations_to_previous_pinned_model_request::ResetAnnotationsToPreviousPinnedModelRequest; +pub mod reset_annotations_to_previous_pinned_model_response; +pub use self::reset_annotations_to_previous_pinned_model_response::ResetAnnotationsToPreviousPinnedModelResponse; +pub mod reset_stream_request; +pub use self::reset_stream_request::ResetStreamRequest; +pub mod reset_stream_response; +pub use self::reset_stream_response::ResetStreamResponse; +pub mod reset_tenant_quota_response; +pub use self::reset_tenant_quota_response::ResetTenantQuotaResponse; +pub mod reset_trigger_request; +pub use self::reset_trigger_request::ResetTriggerRequest; +pub mod reset_trigger_response; +pub use self::reset_trigger_response::ResetTriggerResponse; +pub mod response_status_error; +pub use self::response_status_error::ResponseStatusError; +pub mod retrieval_method; +pub use self::retrieval_method::RetrievalMethod; +pub mod reviewable_block; +pub use self::reviewable_block::ReviewableBlock; +pub mod reviewable_block_group; +pub use self::reviewable_block_group::ReviewableBlockGroup; +pub mod reviewed; +pub use self::reviewed::Reviewed; +pub mod reviewed_filter_rule; +pub use self::reviewed_filter_rule::ReviewedFilterRule; +pub mod rich_diagnostic_kind; +pub use self::rich_diagnostic_kind::RichDiagnosticKind; +pub mod send_welcome_email_response; +pub use self::send_welcome_email_response::SendWelcomeEmailResponse; +pub mod sentiment; +pub use self::sentiment::Sentiment; +pub mod set_comment_audio_response; +pub use self::set_comment_audio_response::SetCommentAudioResponse; +pub mod set_quota_for_tenant_request; +pub use self::set_quota_for_tenant_request::SetQuotaForTenantRequest; +pub mod set_quota_for_tenant_response; +pub use self::set_quota_for_tenant_response::SetQuotaForTenantResponse; +pub mod set_tenant_quota_request; +pub use self::set_tenant_quota_request::SetTenantQuotaRequest; +pub mod set_tenant_quota_response; +pub use self::set_tenant_quota_response::SetTenantQuotaResponse; +pub mod set_tenant_state_request; +pub use self::set_tenant_state_request::SetTenantStateRequest; +pub mod set_tenant_state_response; +pub use self::set_tenant_state_response::SetTenantStateResponse; +pub mod significance; +pub use self::significance::Significance; +pub mod significance_value; +pub use self::significance_value::SignificanceValue; +pub mod single_label_summary; +pub use self::single_label_summary::SingleLabelSummary; +pub mod single_tenants_response; +pub use self::single_tenants_response::SingleTenantsResponse; +pub mod sniff_csv_response; +pub use self::sniff_csv_response::SniffCsvResponse; +pub mod source; +pub use self::source::Source; +pub mod source_1; +pub use self::source_1::Source1; +pub mod source_counts; +pub use self::source_counts::SourceCounts; +pub mod source_counts_settings; +pub use self::source_counts_settings::SourceCountsSettings; +pub mod source_kind; +pub use self::source_kind::SourceKind; +pub mod _source_statistics; +pub use self::_source_statistics::SourceStatistics; +pub mod source_update; +pub use self::source_update::SourceUpdate; +pub mod span; +pub use self::span::Span; +pub mod statistics; +pub use self::statistics::Statistics; +pub mod store_bucket_sync_state_request; +pub use self::store_bucket_sync_state_request::StoreBucketSyncStateRequest; +pub mod store_bucket_sync_state_response; +pub use self::store_bucket_sync_state_response::StoreBucketSyncStateResponse; +pub mod store_exception_request; +pub use self::store_exception_request::StoreExceptionRequest; +pub mod store_exception_response; +pub use self::store_exception_response::StoreExceptionResponse; +pub mod store_keyed_sync_state_request; +pub use self::store_keyed_sync_state_request::StoreKeyedSyncStateRequest; +pub mod store_keyed_sync_state_response; +pub use self::store_keyed_sync_state_response::StoreKeyedSyncStateResponse; +pub mod stream_comment_extractions_result; +pub use self::stream_comment_extractions_result::StreamCommentExtractionsResult; +pub mod stream_comment_prediction; +pub use self::stream_comment_prediction::StreamCommentPrediction; +pub mod stream_comment_result; +pub use self::stream_comment_result::StreamCommentResult; +pub mod stream_confidence; +pub use self::stream_confidence::StreamConfidence; +pub mod stream_extraction_field_prediction; +pub use self::stream_extraction_field_prediction::StreamExtractionFieldPrediction; +pub mod stream_field_value; +pub use self::stream_field_value::StreamFieldValue; +pub mod stream_general_field_prediction; +pub use self::stream_general_field_prediction::StreamGeneralFieldPrediction; +pub mod stream_label_prediction; +pub use self::stream_label_prediction::StreamLabelPrediction; +pub mod stream_result; +pub use self::stream_result::StreamResult; +pub mod stream_score_prediction; +pub use self::stream_score_prediction::StreamScorePrediction; +pub mod stream_taxonomy_prediction; +pub use self::stream_taxonomy_prediction::StreamTaxonomyPrediction; +pub mod stream_text_span; +pub use self::stream_text_span::StreamTextSpan; +pub mod string_any_of_filter; +pub use self::string_any_of_filter::StringAnyOfFilter; +pub mod string_array_filter; +pub use self::string_array_filter::StringArrayFilter; +pub mod string_none_of_filter; +pub use self::string_none_of_filter::StringNoneOfFilter; +pub mod string_one_of_filter; +pub use self::string_one_of_filter::StringOneOfFilter; +pub mod string_search_filter; +pub use self::string_search_filter::StringSearchFilter; +pub mod string_user_property_count; +pub use self::string_user_property_count::StringUserPropertyCount; +pub mod string_user_property_count_single; +pub use self::string_user_property_count_single::StringUserPropertyCountSingle; +pub mod string_user_property_counts_settings; +pub use self::string_user_property_counts_settings::StringUserPropertyCountsSettings; +pub mod string_user_property_summary; +pub use self::string_user_property_summary::StringUserPropertySummary; +pub mod suggest_taxonomy_request; +pub use self::suggest_taxonomy_request::SuggestTaxonomyRequest; +pub mod suggest_taxonomy_response; +pub use self::suggest_taxonomy_response::SuggestTaxonomyResponse; +pub mod suggested_label; +pub use self::suggested_label::SuggestedLabel; +pub mod suggested_taxonomy; +pub use self::suggested_taxonomy::SuggestedTaxonomy; +pub mod sync_annotations_request; +pub use self::sync_annotations_request::SyncAnnotationsRequest; +pub mod sync_annotations_response; +pub use self::sync_annotations_response::SyncAnnotationsResponse; +pub mod sync_comments_from_csv_response; +pub use self::sync_comments_from_csv_response::SyncCommentsFromCsvResponse; +pub mod sync_comments_request; +pub use self::sync_comments_request::SyncCommentsRequest; +pub mod sync_comments_response; +pub use self::sync_comments_response::SyncCommentsResponse; +pub mod sync_raw_emails_request; +pub use self::sync_raw_emails_request::SyncRawEmailsRequest; +pub mod sync_raw_emails_response; +pub use self::sync_raw_emails_response::SyncRawEmailsResponse; +pub mod sync_status; +pub use self::sync_status::SyncStatus; +pub mod tagged_ixp_model_version; +pub use self::tagged_ixp_model_version::TaggedIxpModelVersion; +pub mod tagged_user_model_version; +pub use self::tagged_user_model_version::TaggedUserModelVersion; +pub mod tagged_user_model_version_name; +pub use self::tagged_user_model_version_name::TaggedUserModelVersionName; +pub mod tagged_user_model_version_update; +pub use self::tagged_user_model_version_update::TaggedUserModelVersionUpdate; +pub mod taxonomy_extraction_private; +pub use self::taxonomy_extraction_private::TaxonomyExtractionPrivate; +pub mod tenant; +pub use self::tenant::Tenant; +pub mod tenant_new; +pub use self::tenant_new::TenantNew; +pub mod tenant_update; +pub use self::tenant_update::TenantUpdate; +pub mod text_config; +pub use self::text_config::TextConfig; +pub mod text_field_data_private; +pub use self::text_field_data_private::TextFieldDataPrivate; +pub mod text_field_data_type; +pub use self::text_field_data_type::TextFieldDataType; +pub mod text_field_flag; +pub use self::text_field_flag::TextFieldFlag; +pub mod text_format; +pub use self::text_format::TextFormat; +pub mod text_image_input_config; +pub use self::text_image_input_config::TextImageInputConfig; +pub mod text_span; +pub use self::text_span::TextSpan; +pub mod theme; +pub use self::theme::Theme; +pub mod theme_comment; +pub use self::theme_comment::ThemeComment; +pub mod theme_comment_interpretation; +pub use self::theme_comment_interpretation::ThemeCommentInterpretation; +pub mod theme_set; +pub use self::theme_set::ThemeSet; +pub mod thread_histogram_binning_custom; +pub use self::thread_histogram_binning_custom::ThreadHistogramBinningCustom; +pub mod _thread_histogram_binning_custom_container; +pub use self::_thread_histogram_binning_custom_container::ThreadHistogramBinningCustomContainer; +pub mod thread_histogram_binning_fixed; +pub use self::thread_histogram_binning_fixed::ThreadHistogramBinningFixed; +pub mod _thread_histogram_binning_fixed_container; +pub use self::_thread_histogram_binning_fixed_container::ThreadHistogramBinningFixedContainer; +pub mod thread_histogram_binning_variable; +pub use self::thread_histogram_binning_variable::ThreadHistogramBinningVariable; +pub mod _thread_histogram_binning_variable_container; +pub use self::_thread_histogram_binning_variable_container::ThreadHistogramBinningVariableContainer; +pub mod thread_histogram_counts; +pub use self::thread_histogram_counts::ThreadHistogramCounts; +pub mod thread_histogram_counts_by_property; +pub use self::thread_histogram_counts_by_property::ThreadHistogramCountsByProperty; +pub mod thread_histogram_settings; +pub use self::thread_histogram_settings::ThreadHistogramSettings; +pub mod thread_histogram_settings_by_property; +pub use self::thread_histogram_settings_by_property::ThreadHistogramSettingsByProperty; +pub mod thread_properties; +pub use self::thread_properties::ThreadProperties; +pub mod thread_property_filter; +pub use self::thread_property_filter::ThreadPropertyFilter; +pub mod thread_theme; +pub use self::thread_theme::ThreadTheme; +pub mod threshold; +pub use self::threshold::Threshold; +pub mod threshold_1; +pub use self::threshold_1::Threshold1; +pub mod threshold_enum; +pub use self::threshold_enum::ThresholdEnum; +pub mod time_period_comparison; +pub use self::time_period_comparison::TimePeriodComparison; +pub mod time_resolution; +pub use self::time_resolution::TimeResolution; +pub mod timestamp_range_filter; +pub use self::timestamp_range_filter::TimestampRangeFilter; +pub mod train_view; +pub use self::train_view::TrainView; +pub mod training_action; +pub use self::training_action::TrainingAction; +pub mod training_action_completeness; +pub use self::training_action_completeness::TrainingActionCompleteness; +pub mod translation; +pub use self::translation::Translation; +pub mod trigger; +pub use self::trigger::Trigger; +pub mod trigger_exception; +pub use self::trigger_exception::TriggerException; +pub mod trigger_exceptions_summary; +pub use self::trigger_exceptions_summary::TriggerExceptionsSummary; +pub mod trigger_label_threshold; +pub use self::trigger_label_threshold::TriggerLabelThreshold; +pub mod trigger_new; +pub use self::trigger_new::TriggerNew; +pub mod trigger_update; +pub use self::trigger_update::TriggerUpdate; +pub mod trigger_user_model; +pub use self::trigger_user_model::TriggerUserModel; +pub mod ui; +pub use self::ui::Ui; +pub mod ui_annotation_metadata; +pub use self::ui_annotation_metadata::UiAnnotationMetadata; +pub mod ui_path_cv_table_only_config; +pub use self::ui_path_cv_table_only_config::UiPathCvTableOnlyConfig; +pub mod ui_path_provision_create_properties; +pub use self::ui_path_provision_create_properties::UiPathProvisionCreateProperties; +pub mod ui_path_provision_create_request; +pub use self::ui_path_provision_create_request::UiPathProvisionCreateRequest; +pub mod ui_path_provision_create_response; +pub use self::ui_path_provision_create_response::UiPathProvisionCreateResponse; +pub mod ui_path_provision_delete_request; +pub use self::ui_path_provision_delete_request::UiPathProvisionDeleteRequest; +pub mod ui_path_provision_delete_response; +pub use self::ui_path_provision_delete_response::UiPathProvisionDeleteResponse; +pub mod ui_path_provision_restore_request; +pub use self::ui_path_provision_restore_request::UiPathProvisionRestoreRequest; +pub mod ui_path_provision_restore_response; +pub use self::ui_path_provision_restore_response::UiPathProvisionRestoreResponse; +pub mod ui_path_provision_update_properties; +pub use self::ui_path_provision_update_properties::UiPathProvisionUpdateProperties; +pub mod ui_path_provision_update_request; +pub use self::ui_path_provision_update_request::UiPathProvisionUpdateRequest; +pub mod ui_path_provision_update_response; +pub use self::ui_path_provision_update_response::UiPathProvisionUpdateResponse; +pub mod ui_path_tenant_service_status; +pub use self::ui_path_tenant_service_status::UiPathTenantServiceStatus; +pub mod unary_label_health_action; +pub use self::unary_label_health_action::UnaryLabelHealthAction; +pub mod unary_label_health_action_kind; +pub use self::unary_label_health_action_kind::UnaryLabelHealthActionKind; +pub mod unary_label_health_warning; +pub use self::unary_label_health_warning::UnaryLabelHealthWarning; +pub mod unary_label_health_warning_kind; +pub use self::unary_label_health_warning_kind::UnaryLabelHealthWarningKind; +pub mod uninformative_label; +pub use self::uninformative_label::UninformativeLabel; +pub mod uninformative_mode; +pub use self::uninformative_mode::UninformativeMode; +pub mod unpin_model_response; +pub use self::unpin_model_response::UnpinModelResponse; +pub mod update_alert_request; +pub use self::update_alert_request::UpdateAlertRequest; +pub mod update_alert_response; +pub use self::update_alert_response::UpdateAlertResponse; +pub mod update_appliance_config_response; +pub use self::update_appliance_config_response::UpdateApplianceConfigResponse; +pub mod update_bucket_request; +pub use self::update_bucket_request::UpdateBucketRequest; +pub mod update_bucket_response; +pub use self::update_bucket_response::UpdateBucketResponse; +pub mod update_comment_labelling_request; +pub use self::update_comment_labelling_request::UpdateCommentLabellingRequest; +pub mod update_comment_labelling_response; +pub use self::update_comment_labelling_response::UpdateCommentLabellingResponse; +pub mod update_dashboard_request; +pub use self::update_dashboard_request::UpdateDashboardRequest; +pub mod update_dashboard_response; +pub use self::update_dashboard_response::UpdateDashboardResponse; +pub mod update_dataset_request; +pub use self::update_dataset_request::UpdateDatasetRequest; +pub mod update_dataset_response; +pub use self::update_dataset_response::UpdateDatasetResponse; +pub mod update_integration_request; +pub use self::update_integration_request::UpdateIntegrationRequest; +pub mod update_integration_response; +pub use self::update_integration_response::UpdateIntegrationResponse; +pub mod update_issue_status_request; +pub use self::update_issue_status_request::UpdateIssueStatusRequest; +pub mod update_issue_status_response; +pub use self::update_issue_status_response::UpdateIssueStatusResponse; +pub mod update_label_def_response; +pub use self::update_label_def_response::UpdateLabelDefResponse; +pub mod update_model_request; +pub use self::update_model_request::UpdateModelRequest; +pub mod update_model_response; +pub use self::update_model_response::UpdateModelResponse; +pub mod update_model_tag_request; +pub use self::update_model_tag_request::UpdateModelTagRequest; +pub mod update_model_tag_response; +pub use self::update_model_tag_response::UpdateModelTagResponse; +pub mod update_project_request; +pub use self::update_project_request::UpdateProjectRequest; +pub mod update_project_response; +pub use self::update_project_response::UpdateProjectResponse; +pub mod update_source_request; +pub use self::update_source_request::UpdateSourceRequest; +pub mod update_source_response; +pub use self::update_source_response::UpdateSourceResponse; +pub mod update_tenant_client_subnets_request; +pub use self::update_tenant_client_subnets_request::UpdateTenantClientSubnetsRequest; +pub mod update_tenant_client_subnets_response; +pub use self::update_tenant_client_subnets_response::UpdateTenantClientSubnetsResponse; +pub mod update_tenant_default_project_permissions_request; +pub use self::update_tenant_default_project_permissions_request::UpdateTenantDefaultProjectPermissionsRequest; +pub mod update_tenant_default_project_permissions_response; +pub use self::update_tenant_default_project_permissions_response::UpdateTenantDefaultProjectPermissionsResponse; +pub mod update_tenant_domains_request; +pub use self::update_tenant_domains_request::UpdateTenantDomainsRequest; +pub mod update_tenant_domains_response; +pub use self::update_tenant_domains_response::UpdateTenantDomainsResponse; +pub mod update_tenant_entity_def_ids_request; +pub use self::update_tenant_entity_def_ids_request::UpdateTenantEntityDefIdsRequest; +pub mod update_tenant_entity_def_ids_response; +pub use self::update_tenant_entity_def_ids_response::UpdateTenantEntityDefIdsResponse; +pub mod update_tenant_request; +pub use self::update_tenant_request::UpdateTenantRequest; +pub mod update_tenant_response; +pub use self::update_tenant_response::UpdateTenantResponse; +pub mod update_trigger_request; +pub use self::update_trigger_request::UpdateTriggerRequest; +pub mod update_trigger_response; +pub use self::update_trigger_response::UpdateTriggerResponse; +pub mod update_user_request; +pub use self::update_user_request::UpdateUserRequest; +pub mod update_user_response; +pub use self::update_user_response::UpdateUserResponse; +pub mod upload_attachment_response; +pub use self::upload_attachment_response::UploadAttachmentResponse; +pub mod upload_document_response; +pub use self::upload_document_response::UploadDocumentResponse; +pub mod upload_files_response; +pub use self::upload_files_response::UploadFilesResponse; +pub mod user; +pub use self::user::User; +pub mod user_access_model; +pub use self::user_access_model::UserAccessModel; +pub mod user_access_model_kind; +pub use self::user_access_model_kind::UserAccessModelKind; +pub mod user_license; +pub use self::user_license::UserLicense; +pub mod user_license_check; +pub use self::user_license_check::UserLicenseCheck; +pub mod user_model; +pub use self::user_model::UserModel; +pub mod user_model_metadata; +pub use self::user_model_metadata::UserModelMetadata; +pub mod user_model_metadata_flag; +pub use self::user_model_metadata_flag::UserModelMetadataFlag; +pub mod user_model_metadata_settings; +pub use self::user_model_metadata_settings::UserModelMetadataSettings; +pub mod user_new; +pub use self::user_new::UserNew; +pub mod user_properties_summary; +pub use self::user_properties_summary::UserPropertiesSummary; +pub mod user_properties_value; +pub use self::user_properties_value::UserPropertiesValue; +pub mod user_update; +pub use self::user_update::UserUpdate; +pub mod user_v1; +pub use self::user_v1::UserV1; +pub mod user_with_license_check; +pub use self::user_with_license_check::UserWithLicenseCheck; +pub mod validate_exchange_credentials_request; +pub use self::validate_exchange_credentials_request::ValidateExchangeCredentialsRequest; +pub mod validate_exchange_credentials_response; +pub use self::validate_exchange_credentials_response::ValidateExchangeCredentialsResponse; +pub mod validation_summary; +pub use self::validation_summary::ValidationSummary; +pub mod validation_summary_v1; +pub use self::validation_summary_v1::ValidationSummaryV1; +pub mod variation_kind; +pub use self::variation_kind::VariationKind; +pub mod vertex; +pub use self::vertex::Vertex; diff --git a/api/src/models/model_config.rs b/api/src/models/model_config.rs new file mode 100644 index 00000000..de915f57 --- /dev/null +++ b/api/src/models/model_config.rs @@ -0,0 +1,16 @@ +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(tag = "kind", rename_all = "snake_case")] +pub enum ModelConfig { + Cm(models::CmModelConfig), + DocPathIxp(models::DocPathIxpModelConfig), + GptIxp(models::GptIxpModelConfig), +} + +impl Default for ModelConfig { + fn default() -> Self { + Self::Cm(models::CmModelConfig::default()) + } +} diff --git a/api/src/models/model_definition.rs b/api/src/models/model_definition.rs new file mode 100644 index 00000000..fc31f19d --- /dev/null +++ b/api/src/models/model_definition.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ModelDefinition { + #[serde(rename = "taxonomies")] + pub taxonomies: Vec, +} + +impl ModelDefinition { + pub fn new(taxonomies: Vec) -> ModelDefinition { + ModelDefinition { + taxonomies, + } + } +} + diff --git a/api/src/models/model_error.rs b/api/src/models/model_error.rs new file mode 100644 index 00000000..499f9a88 --- /dev/null +++ b/api/src/models/model_error.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ModelError { + #[serde(rename = "kind")] + pub kind: models::ModelErrorKind, + #[serde(rename = "message")] + pub message: String, +} + +impl ModelError { + pub fn new(kind: models::ModelErrorKind, message: String) -> ModelError { + ModelError { + kind, + message, + } + } +} + diff --git a/api/src/models/model_error_kind.rs b/api/src/models/model_error_kind.rs new file mode 100644 index 00000000..121666ae --- /dev/null +++ b/api/src/models/model_error_kind.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ModelErrorKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ModelErrorKind { + #[serde(rename = "UNKNOWN")] + Unknown, + #[serde(rename = "PROMPT_TOO_LONG")] + PromptTooLong, + #[serde(rename = "CONTENT_POLICY_VIOLATION")] + ContentPolicyViolation, + #[serde(rename = "FORBIDDEN_BY_GOVERNANCE_POLICY")] + ForbiddenByGovernancePolicy, + +} + +impl std::fmt::Display for ModelErrorKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Unknown => write!(f, "UNKNOWN"), + Self::PromptTooLong => write!(f, "PROMPT_TOO_LONG"), + Self::ContentPolicyViolation => write!(f, "CONTENT_POLICY_VIOLATION"), + Self::ForbiddenByGovernancePolicy => write!(f, "FORBIDDEN_BY_GOVERNANCE_POLICY"), + } + } +} + +impl Default for ModelErrorKind { + fn default() -> ModelErrorKind { + Self::Unknown + } +} + diff --git a/api/src/models/model_family.rs b/api/src/models/model_family.rs new file mode 100644 index 00000000..0ba748f1 --- /dev/null +++ b/api/src/models/model_family.rs @@ -0,0 +1,54 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ModelFamily : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ModelFamily { + #[serde(rename = "english")] + English, + #[serde(rename = "english-dev")] + EnglishDev, + #[serde(rename = "german")] + German, + #[serde(rename = "german-dev")] + GermanDev, + #[serde(rename = "random")] + Random, + #[serde(rename = "transformer-english")] + TransformerEnglish, + #[serde(rename = "transformer-xlm")] + TransformerXlm, + +} + +impl std::fmt::Display for ModelFamily { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::English => write!(f, "english"), + Self::EnglishDev => write!(f, "english-dev"), + Self::German => write!(f, "german"), + Self::GermanDev => write!(f, "german-dev"), + Self::Random => write!(f, "random"), + Self::TransformerEnglish => write!(f, "transformer-english"), + Self::TransformerXlm => write!(f, "transformer-xlm"), + } + } +} + +impl Default for ModelFamily { + fn default() -> ModelFamily { + Self::English + } +} + diff --git a/api/src/models/model_name.rs b/api/src/models/model_name.rs new file mode 100644 index 00000000..8519a69a --- /dev/null +++ b/api/src/models/model_name.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ModelName : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ModelName { + #[serde(rename = "cm")] + Cm, + #[serde(rename = "doc_path_ixp")] + DocPathIxp, + #[serde(rename = "gpt_ixp")] + GptIxp, + #[serde(rename = "gemini_ixp")] + GeminiIxp, + +} + +impl std::fmt::Display for ModelName { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Cm => write!(f, "cm"), + Self::DocPathIxp => write!(f, "doc_path_ixp"), + Self::GptIxp => write!(f, "gpt_ixp"), + Self::GeminiIxp => write!(f, "gemini_ixp"), + } + } +} + +impl Default for ModelName { + fn default() -> ModelName { + Self::Cm + } +} + diff --git a/api/src/models/model_rating.rs b/api/src/models/model_rating.rs new file mode 100644 index 00000000..b52e0ab3 --- /dev/null +++ b/api/src/models/model_rating.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ModelRating { + #[serde(rename = "score")] + pub score: f64, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "needs_refinement")] + pub needs_refinement: bool, + #[serde(rename = "factors")] + pub factors: Vec, + #[serde(rename = "bins")] + pub bins: Vec, +} + +impl ModelRating { + pub fn new(score: f64, quality: models::DatasetQuality, needs_refinement: bool, factors: Vec, bins: Vec) -> ModelRating { + ModelRating { + score, + quality, + needs_refinement, + factors, + bins, + } + } +} + diff --git a/api/src/models/model_rating_action.rs b/api/src/models/model_rating_action.rs new file mode 100644 index 00000000..eb64fd49 --- /dev/null +++ b/api/src/models/model_rating_action.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ModelRatingAction : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ModelRatingAction { + #[serde(rename = "discover")] + Discover, + #[serde(rename = "low_confidence")] + LowConfidence, + #[serde(rename = "bias")] + Bias, + #[serde(rename = "shuffle")] + Shuffle, + +} + +impl std::fmt::Display for ModelRatingAction { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Discover => write!(f, "discover"), + Self::LowConfidence => write!(f, "low_confidence"), + Self::Bias => write!(f, "bias"), + Self::Shuffle => write!(f, "shuffle"), + } + } +} + +impl Default for ModelRatingAction { + fn default() -> ModelRatingAction { + Self::Discover + } +} + diff --git a/api/src/models/model_rating_factor.rs b/api/src/models/model_rating_factor.rs new file mode 100644 index 00000000..8e63dd6a --- /dev/null +++ b/api/src/models/model_rating_factor.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ModelRatingFactor { + #[serde(rename = "kind")] + pub kind: models::ModelRatingFactorKind, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "score")] + pub score: f64, + #[serde(rename = "dataset_actions")] + pub dataset_actions: Vec, + #[serde(rename = "label_actions")] + pub label_actions: Vec, + #[serde(rename = "contributors")] + pub contributors: Vec, +} + +impl ModelRatingFactor { + pub fn new(kind: models::ModelRatingFactorKind, quality: models::DatasetQuality, score: f64, dataset_actions: Vec, label_actions: Vec, contributors: Vec) -> ModelRatingFactor { + ModelRatingFactor { + kind, + quality, + score, + dataset_actions, + label_actions, + contributors, + } + } +} + diff --git a/api/src/models/model_rating_factor_kind.rs b/api/src/models/model_rating_factor_kind.rs new file mode 100644 index 00000000..df6a46be --- /dev/null +++ b/api/src/models/model_rating_factor_kind.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ModelRatingFactorKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ModelRatingFactorKind { + #[serde(rename = "biased")] + Biased, + #[serde(rename = "coverage")] + Coverage, + #[serde(rename = "lowest_label_health")] + LowestLabelHealth, + #[serde(rename = "overall_label_health")] + OverallLabelHealth, + +} + +impl std::fmt::Display for ModelRatingFactorKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Biased => write!(f, "biased"), + Self::Coverage => write!(f, "coverage"), + Self::LowestLabelHealth => write!(f, "lowest_label_health"), + Self::OverallLabelHealth => write!(f, "overall_label_health"), + } + } +} + +impl Default for ModelRatingFactorKind { + fn default() -> ModelRatingFactorKind { + Self::Biased + } +} + diff --git a/api/src/models/model_taxonomy.rs b/api/src/models/model_taxonomy.rs new file mode 100644 index 00000000..14a6ec4b --- /dev/null +++ b/api/src/models/model_taxonomy.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ModelTaxonomy { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions")] + pub instructions: String, + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "general_fields")] + pub general_fields: Vec, + #[serde(rename = "field_types")] + pub field_types: Vec, +} + +impl ModelTaxonomy { + pub fn new(name: String, instructions: String, labels: Vec, general_fields: Vec, field_types: Vec) -> ModelTaxonomy { + ModelTaxonomy { + name, + instructions, + labels, + general_fields, + field_types, + } + } +} + diff --git a/api/src/models/monetary_field_data_private.rs b/api/src/models/monetary_field_data_private.rs new file mode 100644 index 00000000..bac8c6a2 --- /dev/null +++ b/api/src/models/monetary_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MonetaryFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl MonetaryFieldDataPrivate { + pub fn new(kind: Kind) -> MonetaryFieldDataPrivate { + MonetaryFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "monetary")] + Monetary, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Monetary + } +} + diff --git a/api/src/models/monetary_quantity_field_data_type.rs b/api/src/models/monetary_quantity_field_data_type.rs new file mode 100644 index 00000000..97cfd6cf --- /dev/null +++ b/api/src/models/monetary_quantity_field_data_type.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MonetaryQuantityFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl MonetaryQuantityFieldDataType { + pub fn new(kind: Kind) -> MonetaryQuantityFieldDataType { + MonetaryQuantityFieldDataType { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "monetary")] + Monetary, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Monetary + } +} + diff --git a/api/src/models/moon_form_capture_fields_annotation.rs b/api/src/models/moon_form_capture_fields_annotation.rs new file mode 100644 index 00000000..18ddd8f6 --- /dev/null +++ b/api/src/models/moon_form_capture_fields_annotation.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormCaptureFieldsAnnotation { + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl MoonFormCaptureFieldsAnnotation { + pub fn new(fields: Vec) -> MoonFormCaptureFieldsAnnotation { + MoonFormCaptureFieldsAnnotation { + fields, + } + } +} + diff --git a/api/src/models/moon_form_capture_fields_annotation_new.rs b/api/src/models/moon_form_capture_fields_annotation_new.rs new file mode 100644 index 00000000..e7837593 --- /dev/null +++ b/api/src/models/moon_form_capture_fields_annotation_new.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormCaptureFieldsAnnotationNew { + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl MoonFormCaptureFieldsAnnotationNew { + pub fn new(fields: Vec) -> MoonFormCaptureFieldsAnnotationNew { + MoonFormCaptureFieldsAnnotationNew { + fields, + } + } +} + diff --git a/api/src/models/moon_form_capture_fields_prediction.rs b/api/src/models/moon_form_capture_fields_prediction.rs new file mode 100644 index 00000000..2e5ab631 --- /dev/null +++ b/api/src/models/moon_form_capture_fields_prediction.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormCaptureFieldsPrediction { + #[serde(rename = "fields")] + pub fields: Vec, + #[serde(rename = "probability")] + pub probability: f64, +} + +impl MoonFormCaptureFieldsPrediction { + pub fn new(fields: Vec, probability: f64) -> MoonFormCaptureFieldsPrediction { + MoonFormCaptureFieldsPrediction { + fields, + probability, + } + } +} + diff --git a/api/src/models/moon_form_dismissed_update.rs b/api/src/models/moon_form_dismissed_update.rs new file mode 100644 index 00000000..eba7255a --- /dev/null +++ b/api/src/models/moon_form_dismissed_update.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormDismissedUpdate { + #[serde(rename = "captures", skip_serializing_if = "Option::is_none")] + pub captures: Option>, + #[serde(rename = "entities")] + pub entities: Vec, + #[serde(rename = "labels")] + pub labels: Vec, +} + +impl MoonFormDismissedUpdate { + pub fn new(entities: Vec, labels: Vec) -> MoonFormDismissedUpdate { + MoonFormDismissedUpdate { + captures: None, + entities, + labels, + } + } +} + diff --git a/api/src/models/moon_form_field_annotation.rs b/api/src/models/moon_form_field_annotation.rs new file mode 100644 index 00000000..7f9927e8 --- /dev/null +++ b/api/src/models/moon_form_field_annotation.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldAnnotation { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + /// Deprecated. Will be set to the first span, if there's exactly one span. + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + #[serde(rename = "spans")] + pub spans: Vec, + #[serde(rename = "kind")] + pub kind: String, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "field_id")] + pub field_id: String, + #[serde(rename = "document_spans")] + pub document_spans: Vec, + /// Whether the field is confirmed. + #[serde(rename = "confirmed", skip_serializing_if = "Option::is_none")] + pub confirmed: Option, +} + +impl MoonFormFieldAnnotation { + pub fn new(id: String, field_type_id: String, name: String, spans: Vec, kind: String, formatted_value: String, field_id: String, document_spans: Vec) -> MoonFormFieldAnnotation { + MoonFormFieldAnnotation { + id, + field_type_id, + name, + span: None, + spans, + kind, + formatted_value, + field_id, + document_spans, + confirmed: None, + } + } +} + diff --git a/api/src/models/moon_form_field_annotation_new.rs b/api/src/models/moon_form_field_annotation_new.rs new file mode 100644 index 00000000..d2175198 --- /dev/null +++ b/api/src/models/moon_form_field_annotation_new.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MoonFormFieldAnnotationNew : Entity annotation for a verbatim +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldAnnotationNew { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Deprecated. Use `spans` instead. + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + /// Spans of the entity in the comment. + #[serde(rename = "spans", skip_serializing_if = "Option::is_none")] + pub spans: Option>, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "field_id", skip_serializing_if = "Option::is_none")] + pub field_id: Option, + #[serde(rename = "document_spans", skip_serializing_if = "Option::is_none")] + pub document_spans: Option>, + /// Whether the field is confirmed. + #[serde(rename = "confirmed", skip_serializing_if = "Option::is_none")] + pub confirmed: Option, +} + +impl MoonFormFieldAnnotationNew { + /// Entity annotation for a verbatim + pub fn new(formatted_value: String) -> MoonFormFieldAnnotationNew { + MoonFormFieldAnnotationNew { + id: None, + name: None, + span: None, + spans: None, + formatted_value, + field_id: None, + document_spans: None, + confirmed: None, + } + } +} + diff --git a/api/src/models/moon_form_field_def.rs b/api/src/models/moon_form_field_def.rs new file mode 100644 index 00000000..3a8cbc86 --- /dev/null +++ b/api/src/models/moon_form_field_def.rs @@ -0,0 +1,49 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldDef { + /// Unique identifier for the moon field + #[serde(rename = "field_id")] + pub field_id: String, + /// Deprecated. Use field_type_id instead + #[serde(rename = "id")] + pub id: String, + /// The ID of the field type + #[serde(rename = "field_type_id")] + pub field_type_id: String, + /// The kind of moon form field + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "rule_set", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub rule_set: Option>>, +} + +impl MoonFormFieldDef { + pub fn new(field_id: String, id: String, field_type_id: String, name: String) -> MoonFormFieldDef { + MoonFormFieldDef { + field_id, + id, + field_type_id, + kind: None, + name, + instructions: None, + rule_set: None, + } + } +} + diff --git a/api/src/models/moon_form_field_def_new.rs b/api/src/models/moon_form_field_def_new.rs new file mode 100644 index 00000000..a875c26c --- /dev/null +++ b/api/src/models/moon_form_field_def_new.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldDefNew { + /// Deprecated. Use field_type_id instead + #[serde(rename = "id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub id: Option>, + /// ID of the field type. + #[serde(rename = "field_type_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub field_type_id: Option>, + /// The kind of moon form field + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "rule_set", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub rule_set: Option>>, +} + +impl MoonFormFieldDefNew { + pub fn new(name: String) -> MoonFormFieldDefNew { + MoonFormFieldDefNew { + id: None, + field_type_id: None, + kind: None, + name, + instructions: None, + rule_set: None, + } + } +} + diff --git a/api/src/models/moon_form_field_def_update.rs b/api/src/models/moon_form_field_def_update.rs new file mode 100644 index 00000000..89ae4fc6 --- /dev/null +++ b/api/src/models/moon_form_field_def_update.rs @@ -0,0 +1,37 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldDefUpdate { + /// Unique identifier for the moon field + #[serde(rename = "field_id")] + pub field_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "rule_set", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub rule_set: Option>>, +} + +impl MoonFormFieldDefUpdate { + pub fn new(field_id: String, name: String) -> MoonFormFieldDefUpdate { + MoonFormFieldDefUpdate { + field_id, + name, + instructions: None, + rule_set: None, + } + } +} + diff --git a/api/src/models/moon_form_field_prediction.rs b/api/src/models/moon_form_field_prediction.rs new file mode 100644 index 00000000..79a98811 --- /dev/null +++ b/api/src/models/moon_form_field_prediction.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormFieldPrediction { + #[serde(rename = "field_id")] + pub field_id: String, + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "field_type_id")] + pub field_type_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "kind")] + pub kind: String, + #[serde(rename = "span", skip_serializing_if = "Option::is_none")] + pub span: Option>, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "probability")] + pub probability: f64, + #[serde(rename = "document_spans")] + pub document_spans: Vec, +} + +impl MoonFormFieldPrediction { + pub fn new(field_id: String, id: String, field_type_id: String, name: String, kind: String, formatted_value: String, probability: f64, document_spans: Vec) -> MoonFormFieldPrediction { + MoonFormFieldPrediction { + field_id, + id, + field_type_id, + name, + kind, + span: None, + formatted_value, + probability, + document_spans, + } + } +} + diff --git a/api/src/models/moon_form_group.rs b/api/src/models/moon_form_group.rs new file mode 100644 index 00000000..41fbf637 --- /dev/null +++ b/api/src/models/moon_form_group.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormGroup { + #[serde(rename = "group")] + pub group: String, + #[serde(rename = "assigned")] + pub assigned: Vec, + #[serde(rename = "dismissed")] + pub dismissed: Vec, + #[serde(rename = "predicted", skip_serializing_if = "Option::is_none")] + pub predicted: Option>, + #[serde(rename = "drafted", skip_serializing_if = "Option::is_none")] + pub drafted: Option>, + #[serde(rename = "raw_generation", skip_serializing_if = "Option::is_none")] + pub raw_generation: Option, + #[serde(rename = "model_errors")] + pub model_errors: Vec, +} + +impl MoonFormGroup { + pub fn new(group: String, assigned: Vec, dismissed: Vec, model_errors: Vec) -> MoonFormGroup { + MoonFormGroup { + group, + assigned, + dismissed, + predicted: None, + drafted: None, + raw_generation: None, + model_errors, + } + } +} + diff --git a/api/src/models/moon_form_group_update.rs b/api/src/models/moon_form_group_update.rs new file mode 100644 index 00000000..1149d6fd --- /dev/null +++ b/api/src/models/moon_form_group_update.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// MoonFormGroupUpdate - Fixed version that properly handles empty dismissed arrays. +/// The generated version incorrectly expected dismissed to be a single object, +/// but the API returns it as an array (which can be empty). +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormGroupUpdate { + #[serde(rename = "group")] + pub group: Group, + #[serde(rename = "assigned")] + pub assigned: Vec, + #[serde(rename = "drafted", skip_serializing_if = "Option::is_none")] + pub drafted: Option>, + #[serde(rename = "dismissed", default)] + pub dismissed: Vec, +} + +impl MoonFormGroupUpdate { + pub fn new(group: Group, assigned: Vec) -> MoonFormGroupUpdate { + MoonFormGroupUpdate { + group, + assigned, + drafted: None, + dismissed: Vec::new(), + } + } +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Group { + #[serde(rename = "default")] + Default, +} + +impl Default for Group { + fn default() -> Group { + Self::Default + } +} diff --git a/api/src/models/moon_form_label_annotation.rs b/api/src/models/moon_form_label_annotation.rs new file mode 100644 index 00000000..3c2a894e --- /dev/null +++ b/api/src/models/moon_form_label_annotation.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormLabelAnnotation { + #[serde(rename = "label")] + pub label: Box, + #[serde(rename = "captures")] + pub captures: Vec, +} + +impl MoonFormLabelAnnotation { + pub fn new(label: models::Label, captures: Vec) -> MoonFormLabelAnnotation { + MoonFormLabelAnnotation { + label: Box::new(label), + captures, + } + } +} + diff --git a/api/src/models/moon_form_label_annotation_update.rs b/api/src/models/moon_form_label_annotation_update.rs new file mode 100644 index 00000000..eac61618 --- /dev/null +++ b/api/src/models/moon_form_label_annotation_update.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormLabelAnnotationUpdate { + #[serde(rename = "label")] + pub label: Box, + #[serde(rename = "captures")] + pub captures: Vec, +} + +impl MoonFormLabelAnnotationUpdate { + pub fn new(label: models::Label, captures: Vec) -> MoonFormLabelAnnotationUpdate { + MoonFormLabelAnnotationUpdate { + label: Box::new(label), + captures, + } + } +} + diff --git a/api/src/models/moon_form_label_prediction.rs b/api/src/models/moon_form_label_prediction.rs new file mode 100644 index 00000000..1a7edefc --- /dev/null +++ b/api/src/models/moon_form_label_prediction.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonFormLabelPrediction { + #[serde(rename = "label")] + pub label: Box, + #[serde(rename = "captures")] + pub captures: Vec, +} + +impl MoonFormLabelPrediction { + pub fn new(label: models::PredictedLabel, captures: Vec) -> MoonFormLabelPrediction { + MoonFormLabelPrediction { + label: Box::new(label), + captures, + } + } +} + diff --git a/api/src/models/moon_intent_fields_metrics.rs b/api/src/models/moon_intent_fields_metrics.rs new file mode 100644 index 00000000..a30f3ca1 --- /dev/null +++ b/api/src/models/moon_intent_fields_metrics.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonIntentFieldsMetrics { + #[serde(rename = "field_stats")] + pub field_stats: std::collections::HashMap, + #[serde(rename = "average_field_stats")] + pub average_field_stats: Box, + #[serde(rename = "capture_pr", deserialize_with = "Option::deserialize")] + pub capture_pr: Option>, + #[serde(rename = "optimal_thresholds", deserialize_with = "Option::deserialize")] + pub optimal_thresholds: Option>, +} + +impl MoonIntentFieldsMetrics { + pub fn new(field_stats: std::collections::HashMap, average_field_stats: models::EntityAverageStats, capture_pr: Option, optimal_thresholds: Option) -> MoonIntentFieldsMetrics { + MoonIntentFieldsMetrics { + field_stats, + average_field_stats: Box::new(average_field_stats), + capture_pr: capture_pr.map(Box::new), + optimal_thresholds: optimal_thresholds.map(Box::new), + } + } +} + diff --git a/api/src/models/moon_intent_validation_request.rs b/api/src/models/moon_intent_validation_request.rs new file mode 100644 index 00000000..cbf54850 --- /dev/null +++ b/api/src/models/moon_intent_validation_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonIntentValidationRequest { + #[serde(rename = "intent_threshold")] + pub intent_threshold: Box, + #[serde(rename = "capture_threshold")] + pub capture_threshold: Box, +} + +impl MoonIntentValidationRequest { + pub fn new(intent_threshold: models::IntentThreshold, capture_threshold: models::CaptureThreshold) -> MoonIntentValidationRequest { + MoonIntentValidationRequest { + intent_threshold: Box::new(intent_threshold), + capture_threshold: Box::new(capture_threshold), + } + } +} + diff --git a/api/src/models/moon_summary_metrics.rs b/api/src/models/moon_summary_metrics.rs new file mode 100644 index 00000000..3cbe05e5 --- /dev/null +++ b/api/src/models/moon_summary_metrics.rs @@ -0,0 +1,57 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonSummaryMetrics { + #[serde(rename = "num_train_captures")] + pub num_train_captures: i32, + #[serde(rename = "num_test_captures")] + pub num_test_captures: i32, + #[serde(rename = "num_reviewed_captures")] + pub num_reviewed_captures: i32, + #[serde(rename = "num_train_documents")] + pub num_train_documents: i32, + #[serde(rename = "num_test_documents")] + pub num_test_documents: i32, + #[serde(rename = "num_reviewed_documents")] + pub num_reviewed_documents: i32, + #[serde(rename = "intents")] + pub intents: std::collections::HashMap, + #[serde(rename = "recalls")] + pub recalls: Vec, + #[serde(rename = "mean_curve")] + pub mean_curve: Box, + #[serde(rename = "average_field_stats")] + pub average_field_stats: Box, + #[serde(rename = "mean_capture_curve")] + pub mean_capture_curve: Box, +} + +impl MoonSummaryMetrics { + pub fn new(num_train_captures: i32, num_test_captures: i32, num_reviewed_captures: i32, num_train_documents: i32, num_test_documents: i32, num_reviewed_documents: i32, intents: std::collections::HashMap, recalls: Vec, mean_curve: models::MeanPrCurve, average_field_stats: models::EntityAverageStats, mean_capture_curve: models::MeanPrCurve) -> MoonSummaryMetrics { + MoonSummaryMetrics { + num_train_captures, + num_test_captures, + num_reviewed_captures, + num_train_documents, + num_test_documents, + num_reviewed_documents, + intents, + recalls, + mean_curve: Box::new(mean_curve), + average_field_stats: Box::new(average_field_stats), + mean_capture_curve: Box::new(mean_capture_curve), + } + } +} + diff --git a/api/src/models/moon_validation.rs b/api/src/models/moon_validation.rs new file mode 100644 index 00000000..f7bb10ad --- /dev/null +++ b/api/src/models/moon_validation.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct MoonValidation { + #[serde(rename = "intent_validation")] + pub intent_validation: Box, + #[serde(rename = "field_validation")] + pub field_validation: Box, +} + +impl MoonValidation { + pub fn new(intent_validation: models::IntentValidation, field_validation: models::MoonIntentFieldsMetrics) -> MoonValidation { + MoonValidation { + intent_validation: Box::new(intent_validation), + field_validation: Box::new(field_validation), + } + } +} + diff --git a/api/src/models/name.rs b/api/src/models/name.rs new file mode 100644 index 00000000..54ac67f1 --- /dev/null +++ b/api/src/models/name.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Name - Fixed version that properly handles label names. +/// The generated version was empty, but label names should be strings or hierarchical paths. +/// This handles both simple string labels and hierarchical labels represented as arrays. +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(untagged)] +pub enum Name { + String(String), + Array(Vec), +} + +impl Default for Name { + fn default() -> Self { + Name::String(String::new()) + } +} + +impl Name { + pub fn new() -> Name { + Name::String(String::new()) + } + + pub fn from_string(s: String) -> Name { + Name::String(s) + } + + pub fn from_array(arr: Vec) -> Name { + Name::Array(arr) + } +} + +impl From for Name { + fn from(s: String) -> Self { + Name::String(s) + } +} + +impl From<&str> for Name { + fn from(s: &str) -> Self { + Name::String(s.to_string()) + } +} + +impl From> for Name { + fn from(arr: Vec) -> Self { + Name::Array(arr) + } +} diff --git a/api/src/models/new_dashboard.rs b/api/src/models/new_dashboard.rs new file mode 100644 index 00000000..7a1db99e --- /dev/null +++ b/api/src/models/new_dashboard.rs @@ -0,0 +1,37 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NewDashboard { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + /// JSON blob containing dashboard charts and their filters + #[serde(rename = "blob")] + pub blob: String, + #[serde(rename = "default_for_datasets", skip_serializing_if = "Option::is_none")] + pub default_for_datasets: Option>, + #[serde(rename = "dataset_ids")] + pub dataset_ids: Vec, +} + +impl NewDashboard { + pub fn new(blob: String, dataset_ids: Vec) -> NewDashboard { + NewDashboard { + title: None, + blob, + default_for_datasets: None, + dataset_ids, + } + } +} + diff --git a/api/src/models/no_ui_metadata_reason.rs b/api/src/models/no_ui_metadata_reason.rs new file mode 100644 index 00000000..52970738 --- /dev/null +++ b/api/src/models/no_ui_metadata_reason.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// NoUiMetadataReason : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum NoUiMetadataReason { + #[serde(rename = "invalid_state")] + InvalidState, + #[serde(rename = "not_set")] + NotSet, + +} + +impl std::fmt::Display for NoUiMetadataReason { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::InvalidState => write!(f, "invalid_state"), + Self::NotSet => write!(f, "not_set"), + } + } +} + +impl Default for NoUiMetadataReason { + fn default() -> NoUiMetadataReason { + Self::InvalidState + } +} + diff --git a/api/src/models/nps_summary.rs b/api/src/models/nps_summary.rs new file mode 100644 index 00000000..7385efc6 --- /dev/null +++ b/api/src/models/nps_summary.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NpsSummary { + #[serde(rename = "nps_property")] + pub nps_property: String, + #[serde(rename = "label_names")] + pub label_names: Vec, + #[serde(rename = "timeseries")] + pub timeseries: Vec>, + #[serde(rename = "histogram")] + pub histogram: Vec>, + #[serde(rename = "bubbles")] + pub bubbles: Vec>, +} + +impl NpsSummary { + pub fn new(nps_property: String, label_names: Vec, timeseries: Vec>, histogram: Vec>, bubbles: Vec>) -> NpsSummary { + NpsSummary { + nps_property, + label_names, + timeseries, + histogram, + bubbles, + } + } +} + diff --git a/api/src/models/ntlm_application_model.rs b/api/src/models/ntlm_application_model.rs new file mode 100644 index 00000000..4c096096 --- /dev/null +++ b/api/src/models/ntlm_application_model.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NtlmApplicationModel { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl NtlmApplicationModel { + pub fn new() -> NtlmApplicationModel { + NtlmApplicationModel { + kind: None, + } + } +} + diff --git a/api/src/models/ntlm_application_model_kind.rs b/api/src/models/ntlm_application_model_kind.rs new file mode 100644 index 00000000..6bb02ad8 --- /dev/null +++ b/api/src/models/ntlm_application_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// NtlmApplicationModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum NtlmApplicationModelKind { + #[serde(rename = "ntlm")] + Ntlm, + +} + +impl std::fmt::Display for NtlmApplicationModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Ntlm => write!(f, "ntlm"), + } + } +} + +impl Default for NtlmApplicationModelKind { + fn default() -> NtlmApplicationModelKind { + Self::Ntlm + } +} + diff --git a/api/src/models/nullable_string_array_filter.rs b/api/src/models/nullable_string_array_filter.rs new file mode 100644 index 00000000..0b224e57 --- /dev/null +++ b/api/src/models/nullable_string_array_filter.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NullableStringArrayFilter { + /// A list of string or null values for which the filter should apply + #[serde(rename = "one_of", skip_serializing_if = "Option::is_none")] + pub one_of: Option>, + /// A list of string or null values for which the filter should not apply + #[serde(rename = "not_one_of", skip_serializing_if = "Option::is_none")] + pub not_one_of: Option>, + /// Whether to include missing values in the filter + #[serde(rename = "include_missing", skip_serializing_if = "Option::is_none")] + pub include_missing: Option, +} + +impl NullableStringArrayFilter { + pub fn new() -> NullableStringArrayFilter { + NullableStringArrayFilter { + one_of: None, + not_one_of: None, + include_missing: None, + } + } +} + diff --git a/api/src/models/number_field_data_type.rs b/api/src/models/number_field_data_type.rs new file mode 100644 index 00000000..905aa8ad --- /dev/null +++ b/api/src/models/number_field_data_type.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NumberFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl NumberFieldDataType { + pub fn new(kind: Kind) -> NumberFieldDataType { + NumberFieldDataType { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "number")] + Number, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Number + } +} + diff --git a/api/src/models/number_one_of_filter.rs b/api/src/models/number_one_of_filter.rs new file mode 100644 index 00000000..239e8d26 --- /dev/null +++ b/api/src/models/number_one_of_filter.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NumberOneOfFilter { + /// A list of number values for which the filter should apply + #[serde(rename = "one_of", skip_serializing_if = "Option::is_none")] + pub one_of: Option>, + /// A list of number values for which the filter should not apply + #[serde(rename = "not_one_of", skip_serializing_if = "Option::is_none")] + pub not_one_of: Option>, + #[serde(rename = "include_missing", skip_serializing_if = "Option::is_none")] + pub include_missing: Option, +} + +impl NumberOneOfFilter { + pub fn new() -> NumberOneOfFilter { + NumberOneOfFilter { + one_of: None, + not_one_of: None, + include_missing: None, + } + } +} + diff --git a/api/src/models/number_range_filter.rs b/api/src/models/number_range_filter.rs new file mode 100644 index 00000000..da2a35fd --- /dev/null +++ b/api/src/models/number_range_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NumberRangeFilter { + #[serde(rename = "minimum", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub minimum: Option>, + #[serde(rename = "maximum", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub maximum: Option>, +} + +impl NumberRangeFilter { + pub fn new() -> NumberRangeFilter { + NumberRangeFilter { + minimum: None, + maximum: None, + } + } +} + diff --git a/api/src/models/number_range_filter_with_kind.rs b/api/src/models/number_range_filter_with_kind.rs new file mode 100644 index 00000000..f186e484 --- /dev/null +++ b/api/src/models/number_range_filter_with_kind.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NumberRangeFilterWithKind { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "minimum", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub minimum: Option>, + #[serde(rename = "maximum", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub maximum: Option>, +} + +impl NumberRangeFilterWithKind { + pub fn new(kind: Kind) -> NumberRangeFilterWithKind { + NumberRangeFilterWithKind { + kind, + minimum: None, + maximum: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "number_range")] + NumberRange, +} + +impl Default for Kind { + fn default() -> Kind { + Self::NumberRange + } +} + diff --git a/api/src/models/number_user_property_summary.rs b/api/src/models/number_user_property_summary.rs new file mode 100644 index 00000000..35e4784b --- /dev/null +++ b/api/src/models/number_user_property_summary.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct NumberUserPropertySummary { + #[serde(rename = "full_name")] + pub full_name: String, + #[serde(rename = "count")] + pub count: i32, +} + +impl NumberUserPropertySummary { + pub fn new(full_name: String, count: i32) -> NumberUserPropertySummary { + NumberUserPropertySummary { + full_name, + count, + } + } +} + diff --git a/api/src/models/o_auth2_salesforce_callback_request.rs b/api/src/models/o_auth2_salesforce_callback_request.rs new file mode 100644 index 00000000..a4adc4a0 --- /dev/null +++ b/api/src/models/o_auth2_salesforce_callback_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct OAuth2SalesforceCallbackRequest { + /// State + #[serde(rename = "state")] + pub state: String, + /// Code + #[serde(rename = "code")] + pub code: String, +} + +impl OAuth2SalesforceCallbackRequest { + pub fn new(state: String, code: String) -> OAuth2SalesforceCallbackRequest { + OAuth2SalesforceCallbackRequest { + state, + code, + } + } +} + diff --git a/api/src/models/o_auth2_salesforce_callback_response.rs b/api/src/models/o_auth2_salesforce_callback_response.rs new file mode 100644 index 00000000..0a9039bc --- /dev/null +++ b/api/src/models/o_auth2_salesforce_callback_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct OAuth2SalesforceCallbackResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl OAuth2SalesforceCallbackResponse { + pub fn new(status: Status) -> OAuth2SalesforceCallbackResponse { + OAuth2SalesforceCallbackResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/optimal_threshold.rs b/api/src/models/optimal_threshold.rs new file mode 100644 index 00000000..a4a65bc9 --- /dev/null +++ b/api/src/models/optimal_threshold.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct OptimalThreshold { + #[serde(rename = "high_precision")] + pub high_precision: f64, + #[serde(rename = "balanced")] + pub balanced: f64, + #[serde(rename = "high_recall")] + pub high_recall: f64, +} + +impl OptimalThreshold { + pub fn new(high_precision: f64, balanced: f64, high_recall: f64) -> OptimalThreshold { + OptimalThreshold { + high_precision, + balanced, + high_recall, + } + } +} + diff --git a/api/src/models/order.rs b/api/src/models/order.rs new file mode 100644 index 00000000..fd432443 --- /dev/null +++ b/api/src/models/order.rs @@ -0,0 +1,98 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(tag = "kind")] +pub enum Order { + #[serde(rename="recent")] + Recent(Box), + #[serde(rename="any_label_asc")] + AnyLabelAsc(Box), + #[serde(rename="sample")] + Sample(Box), + #[serde(rename="diagnostic")] + Diagnostic(Box), + #[serde(rename="learning")] + Learning(Box), + #[serde(rename="label_property")] + LabelProperty(Box), + #[serde(rename="by_label")] + ByLabel(Box), + #[serde(rename="text_search")] + TextSearch(Box), + #[serde(rename="attachment_text_search")] + AttachmentTextSearch(Box), + #[serde(rename="check")] + Check(Box), + #[serde(rename="missed")] + Missed(Box), +} + +impl Default for Order { + fn default() -> Self { + Self::Recent(Default::default()) + } +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum DiagnosticKind { + #[serde(rename = "bias")] + Bias, + #[serde(rename = "informative")] + Informative, + #[serde(rename = "label_only_neglect")] + LabelOnlyNeglect, + #[serde(rename = "neglect")] + Neglect, + #[serde(rename = "teach_entity")] + TeachEntity, + #[serde(rename = "missed_entity")] + MissedEntity, + #[serde(rename = "check_entity")] + CheckEntity, + #[serde(rename = "extraction_error_rate")] + ExtractionErrorRate, +} + +impl Default for DiagnosticKind { + fn default() -> DiagnosticKind { + Self::Bias + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Direction { + #[serde(rename = "ascending")] + Ascending, + #[serde(rename = "descending")] + Descending, +} + +impl Default for Direction { + fn default() -> Direction { + Self::Ascending + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Sentiment { + #[serde(rename = "positive")] + Positive, + #[serde(rename = "negative")] + Negative, +} + +impl Default for Sentiment { + fn default() -> Sentiment { + Self::Positive + } +} + diff --git a/api/src/models/page_dimensions.rs b/api/src/models/page_dimensions.rs new file mode 100644 index 00000000..e40a3201 --- /dev/null +++ b/api/src/models/page_dimensions.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PageDimensions { + #[serde(rename = "pixel_height")] + pub pixel_height: i32, + #[serde(rename = "pixel_width")] + pub pixel_width: i32, +} + +impl PageDimensions { + pub fn new(pixel_height: i32, pixel_width: i32) -> PageDimensions { + PageDimensions { + pixel_height, + pixel_width, + } + } +} + diff --git a/api/src/models/page_metadata.rs b/api/src/models/page_metadata.rs new file mode 100644 index 00000000..c98765cf --- /dev/null +++ b/api/src/models/page_metadata.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PageMetadata { + #[serde(rename = "thumbnail_size")] + pub thumbnail_size: Box, + #[serde(rename = "full_size")] + pub full_size: Box, +} + +impl PageMetadata { + pub fn new(thumbnail_size: models::PageDimensions, full_size: models::PageDimensions) -> PageMetadata { + PageMetadata { + thumbnail_size: Box::new(thumbnail_size), + full_size: Box::new(full_size), + } + } +} + diff --git a/api/src/models/page_polygon.rs b/api/src/models/page_polygon.rs new file mode 100644 index 00000000..e919a2f8 --- /dev/null +++ b/api/src/models/page_polygon.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PagePolygon { + /// vertices of bounding polygon + #[serde(rename = "vertices")] + pub vertices: Vec, +} + +impl PagePolygon { + pub fn new(vertices: Vec) -> PagePolygon { + PagePolygon { + vertices, + } + } +} + diff --git a/api/src/models/page_selection.rs b/api/src/models/page_selection.rs new file mode 100644 index 00000000..7fcc024e --- /dev/null +++ b/api/src/models/page_selection.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PageSelection { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "text")] + pub text: String, + #[serde(rename = "polygon")] + pub polygon: Box, + #[serde(rename = "parent", deserialize_with = "Option::deserialize")] + pub parent: Option, +} + +impl PageSelection { + pub fn new(kind: Kind, text: String, polygon: models::PagePolygon, parent: Option) -> PageSelection { + PageSelection { + kind, + text, + polygon: Box::new(polygon), + parent, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "word")] + Word, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Word + } +} + diff --git a/api/src/models/parse_email_new_comment.rs b/api/src/models/parse_email_new_comment.rs new file mode 100644 index 00000000..0e584e5e --- /dev/null +++ b/api/src/models/parse_email_new_comment.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ParseEmailNewComment { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "timestamp")] + pub timestamp: String, + #[serde(rename = "user_properties")] + pub user_properties: std::collections::HashMap, + #[serde(rename = "messages")] + pub messages: Vec, + #[serde(rename = "text_format")] + pub text_format: models::TextFormat, + #[serde(rename = "attachments")] + pub attachments: Vec, + #[serde(rename = "thread_id", deserialize_with = "Option::deserialize")] + pub thread_id: Option, +} + +impl ParseEmailNewComment { + pub fn new(id: String, timestamp: String, user_properties: std::collections::HashMap, messages: Vec, text_format: models::TextFormat, attachments: Vec, thread_id: Option) -> ParseEmailNewComment { + ParseEmailNewComment { + id, + timestamp, + user_properties, + messages, + text_format, + attachments, + thread_id, + } + } +} + diff --git a/api/src/models/parsed_value.rs b/api/src/models/parsed_value.rs new file mode 100644 index 00000000..a8430947 --- /dev/null +++ b/api/src/models/parsed_value.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ParsedValue { +} + +impl ParsedValue { + pub fn new() -> ParsedValue { + ParsedValue { + } + } +} + diff --git a/api/src/models/period.rs b/api/src/models/period.rs new file mode 100644 index 00000000..ba636c62 --- /dev/null +++ b/api/src/models/period.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Period { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "seconds")] + pub seconds: i32, +} + +impl Period { + pub fn new(kind: Kind, seconds: i32) -> Period { + Period { + kind, + seconds, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "sliding_window")] + SlidingWindow, +} + +impl Default for Kind { + fn default() -> Kind { + Self::SlidingWindow + } +} + diff --git a/api/src/models/pin_model_response.rs b/api/src/models/pin_model_response.rs new file mode 100644 index 00000000..50cebde1 --- /dev/null +++ b/api/src/models/pin_model_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PinModelResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl PinModelResponse { + pub fn new(status: Status) -> PinModelResponse { + PinModelResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/poll_trigger_request.rs b/api/src/models/poll_trigger_request.rs new file mode 100644 index 00000000..533b17b2 --- /dev/null +++ b/api/src/models/poll_trigger_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PollTriggerRequest { + /// The number of comments to fetch from this trigger + #[serde(rename = "size")] + pub size: i32, + /// How many comments to skip if if they don't match the trigger's comment filter + #[serde(rename = "max_filtered", skip_serializing_if = "Option::is_none")] + pub max_filtered: Option, +} + +impl PollTriggerRequest { + pub fn new(size: i32) -> PollTriggerRequest { + PollTriggerRequest { + size, + max_filtered: None, + } + } +} + diff --git a/api/src/models/poll_trigger_response.rs b/api/src/models/poll_trigger_response.rs new file mode 100644 index 00000000..ed2a2ebb --- /dev/null +++ b/api/src/models/poll_trigger_response.rs @@ -0,0 +1,52 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PollTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + /// How many comments were skipped + #[serde(rename = "filtered")] + pub filtered: i32, + /// Sequence ID used to advance the trigger once comments are processed + #[serde(rename = "sequence_id")] + pub sequence_id: String, + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "is_end_sequence")] + pub is_end_sequence: bool, +} + +impl PollTriggerResponse { + pub fn new(status: Status, filtered: i32, sequence_id: String, results: Vec, is_end_sequence: bool) -> PollTriggerResponse { + PollTriggerResponse { + status, + filtered, + sequence_id, + results, + is_end_sequence, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/pr_curve.rs b/api/src/models/pr_curve.rs new file mode 100644 index 00000000..5e0bf19b --- /dev/null +++ b/api/src/models/pr_curve.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PrCurve { + #[serde(rename = "precisions")] + pub precisions: Vec, + #[serde(rename = "recalls")] + pub recalls: Vec, + #[serde(rename = "thresholds")] + pub thresholds: Vec, + #[serde(rename = "average_precision", deserialize_with = "Option::deserialize")] + pub average_precision: Option, +} + +impl PrCurve { + pub fn new(precisions: Vec, recalls: Vec, thresholds: Vec, average_precision: Option) -> PrCurve { + PrCurve { + precisions, + recalls, + thresholds, + average_precision, + } + } +} + diff --git a/api/src/models/predict_document.rs b/api/src/models/predict_document.rs new file mode 100644 index 00000000..d6374c1b --- /dev/null +++ b/api/src/models/predict_document.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictDocument { + #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")] + pub timestamp: Option, + #[serde(rename = "user_properties", skip_serializing_if = "Option::is_none")] + pub user_properties: Option, + #[serde(rename = "messages")] + pub messages: Vec, + #[serde(rename = "text_format", skip_serializing_if = "Option::is_none")] + pub text_format: Option, +} + +impl PredictDocument { + pub fn new(messages: Vec) -> PredictDocument { + PredictDocument { + timestamp: None, + user_properties: None, + messages, + text_format: None, + } + } +} + diff --git a/api/src/models/predict_extractions_request.rs b/api/src/models/predict_extractions_request.rs new file mode 100644 index 00000000..9ef737c7 --- /dev/null +++ b/api/src/models/predict_extractions_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictExtractionsRequest { + #[serde(rename = "documents")] + pub documents: Vec, +} + +impl PredictExtractionsRequest { + pub fn new(documents: Vec) -> PredictExtractionsRequest { + PredictExtractionsRequest { + documents, + } + } +} + diff --git a/api/src/models/predict_extractions_response.rs b/api/src/models/predict_extractions_response.rs new file mode 100644 index 00000000..45ea94ef --- /dev/null +++ b/api/src/models/predict_extractions_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictExtractionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "predictions")] + pub predictions: Vec, +} + +impl PredictExtractionsResponse { + pub fn new(status: Status, predictions: Vec) -> PredictExtractionsResponse { + PredictExtractionsResponse { + status, + predictions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/predict_latest_request.rs b/api/src/models/predict_latest_request.rs new file mode 100644 index 00000000..42c6c0da --- /dev/null +++ b/api/src/models/predict_latest_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictLatestRequest { + #[serde(rename = "documents")] + pub documents: Vec, + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option>, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, + #[serde(rename = "_include_comments", skip_serializing_if = "Option::is_none")] + pub _include_comments: Option, +} + +impl PredictLatestRequest { + pub fn new(documents: Vec) -> PredictLatestRequest { + PredictLatestRequest { + documents, + threshold: None, + labels: None, + _include_comments: None, + } + } +} + diff --git a/api/src/models/predict_latest_response.rs b/api/src/models/predict_latest_response.rs new file mode 100644 index 00000000..b2451a1b --- /dev/null +++ b/api/src/models/predict_latest_response.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictLatestResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "predictions")] + pub predictions: Vec>, + #[serde(rename = "model", deserialize_with = "Option::deserialize")] + pub model: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>>, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>>, +} + +impl PredictLatestResponse { + pub fn new(status: Status, predictions: Vec>, model: Option) -> PredictLatestResponse { + PredictLatestResponse { + status, + predictions, + model: model.map(Box::new), + entities: None, + sentiment: None, + label_properties: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/predict_raw_emails_request.rs b/api/src/models/predict_raw_emails_request.rs new file mode 100644 index 00000000..24665e48 --- /dev/null +++ b/api/src/models/predict_raw_emails_request.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictRawEmailsRequest { + #[serde(rename = "documents")] + pub documents: Vec, + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option>, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, + #[serde(rename = "include_comments", skip_serializing_if = "Option::is_none")] + pub include_comments: Option, + /// A tag identifying the email integration sending the data. You should have received this tag during integration configuration setup. + #[serde(rename = "transform_tag", skip_serializing_if = "Option::is_none")] + pub transform_tag: Option, +} + +impl PredictRawEmailsRequest { + pub fn new(documents: Vec) -> PredictRawEmailsRequest { + PredictRawEmailsRequest { + documents, + threshold: None, + labels: None, + include_comments: None, + transform_tag: None, + } + } +} + diff --git a/api/src/models/predict_raw_emails_response.rs b/api/src/models/predict_raw_emails_response.rs new file mode 100644 index 00000000..b7e195b8 --- /dev/null +++ b/api/src/models/predict_raw_emails_response.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictRawEmailsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "predictions")] + pub predictions: Vec>, + #[serde(rename = "model", deserialize_with = "Option::deserialize")] + pub model: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>>, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, + #[serde(rename = "comments", skip_serializing_if = "Option::is_none")] + pub comments: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>>, +} + +impl PredictRawEmailsResponse { + pub fn new(status: Status, predictions: Vec>, model: Option) -> PredictRawEmailsResponse { + PredictRawEmailsResponse { + status, + predictions, + model: model.map(Box::new), + entities: None, + sentiment: None, + comments: None, + label_properties: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/predict_request.rs b/api/src/models/predict_request.rs new file mode 100644 index 00000000..64b79b85 --- /dev/null +++ b/api/src/models/predict_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictRequest { + #[serde(rename = "documents")] + pub documents: Vec, + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option>, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, + #[serde(rename = "_include_comments", skip_serializing_if = "Option::is_none")] + pub _include_comments: Option, +} + +impl PredictRequest { + pub fn new(documents: Vec) -> PredictRequest { + PredictRequest { + documents, + threshold: None, + labels: None, + _include_comments: None, + } + } +} + diff --git a/api/src/models/predict_response.rs b/api/src/models/predict_response.rs new file mode 100644 index 00000000..88803694 --- /dev/null +++ b/api/src/models/predict_response.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "predictions")] + pub predictions: Vec>, + #[serde(rename = "model", deserialize_with = "Option::deserialize")] + pub model: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>>, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option>, + #[serde(rename = "comments", skip_serializing_if = "Option::is_none")] + pub comments: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>>, +} + +impl PredictResponse { + pub fn new(status: Status, predictions: Vec>, model: Option) -> PredictResponse { + PredictResponse { + status, + predictions, + model: model.map(Box::new), + entities: None, + sentiment: None, + comments: None, + label_properties: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/predicted_entity.rs b/api/src/models/predicted_entity.rs new file mode 100644 index 00000000..b8cdcb42 --- /dev/null +++ b/api/src/models/predicted_entity.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictedEntity { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "kind")] + pub kind: String, + #[serde(rename = "span")] + pub span: Box, + #[serde(rename = "spans")] + pub spans: Vec, + #[serde(rename = "formatted_value")] + pub formatted_value: String, + #[serde(rename = "probability", deserialize_with = "Option::deserialize")] + pub probability: Option, + #[serde(rename = "capture_ids")] + pub capture_ids: Vec, +} + +impl PredictedEntity { + pub fn new(id: String, name: String, kind: String, span: models::TextSpan, spans: Vec, formatted_value: String, probability: Option, capture_ids: Vec) -> PredictedEntity { + PredictedEntity { + id, + name, + kind, + span: Box::new(span), + spans, + formatted_value, + probability, + capture_ids, + } + } +} + diff --git a/api/src/models/predicted_label.rs b/api/src/models/predicted_label.rs new file mode 100644 index 00000000..e713370f --- /dev/null +++ b/api/src/models/predicted_label.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictedLabel { + #[serde(rename = "name")] + pub name: Box, + #[serde(rename = "probability")] + pub probability: f64, + #[serde(rename = "sentiment", skip_serializing_if = "Option::is_none")] + pub sentiment: Option, +} + +impl PredictedLabel { + pub fn new(name: models::Name, probability: f64) -> PredictedLabel { + PredictedLabel { + name: Box::new(name), + probability, + sentiment: None, + } + } +} + diff --git a/api/src/models/predicted_label_property.rs b/api/src/models/predicted_label_property.rs new file mode 100644 index 00000000..bbd51166 --- /dev/null +++ b/api/src/models/predicted_label_property.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictedLabelProperty { + #[serde(rename = "property_id")] + pub property_id: String, + #[serde(rename = "property_name")] + pub property_name: String, + #[serde(rename = "value")] + pub value: f64, +} + +impl PredictedLabelProperty { + pub fn new(property_id: String, property_name: String, value: f64) -> PredictedLabelProperty { + PredictedLabelProperty { + property_id, + property_name, + value, + } + } +} + diff --git a/api/src/models/predictions_model.rs b/api/src/models/predictions_model.rs new file mode 100644 index 00000000..98173fa7 --- /dev/null +++ b/api/src/models/predictions_model.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PredictionsModel { + /// Model version + #[serde(rename = "version")] + pub version: i32, + /// Time + #[serde(rename = "time")] + pub time: String, +} + +impl PredictionsModel { + pub fn new(version: i32, time: String) -> PredictionsModel { + PredictionsModel { + version, + time, + } + } +} + diff --git a/api/src/models/preference.rs b/api/src/models/preference.rs new file mode 100644 index 00000000..a665bcb9 --- /dev/null +++ b/api/src/models/preference.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Preference { + /// The language of the locale + #[serde(rename = "language")] + pub language: String, + /// The locale + #[serde(rename = "locale")] + pub locale: String, +} + +impl Preference { + pub fn new(language: String, locale: String) -> Preference { + Preference { + language, + locale, + } + } +} + diff --git a/api/src/models/preferred_locale.rs b/api/src/models/preferred_locale.rs new file mode 100644 index 00000000..12317757 --- /dev/null +++ b/api/src/models/preferred_locale.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PreferredLocale { + /// The default locale for the user + #[serde(rename = "default")] + pub default: String, + /// The preferred locales for the user + #[serde(rename = "preferences")] + pub preferences: Vec, +} + +impl PreferredLocale { + pub fn new(default: String, preferences: Vec) -> PreferredLocale { + PreferredLocale { + default, + preferences, + } + } +} + diff --git a/api/src/models/preview_alert_request.rs b/api/src/models/preview_alert_request.rs new file mode 100644 index 00000000..f8e48807 --- /dev/null +++ b/api/src/models/preview_alert_request.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PreviewAlertRequest { + /// The alert to preview + #[serde(rename = "alert")] + pub alert: Box, +} + +impl PreviewAlertRequest { + pub fn new(alert: models::AlertNew) -> PreviewAlertRequest { + PreviewAlertRequest { + alert: Box::new(alert), + } + } +} + diff --git a/api/src/models/preview_alert_response.rs b/api/src/models/preview_alert_response.rs new file mode 100644 index 00000000..a56118bf --- /dev/null +++ b/api/src/models/preview_alert_response.rs @@ -0,0 +1,49 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PreviewAlertResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "issues")] + pub issues: Vec, + /// The start of the period over which the preview was ran + #[serde(rename = "timerange_start")] + pub timerange_start: String, + /// The end of the period over which the preview was ran + #[serde(rename = "timerange_end")] + pub timerange_end: String, +} + +impl PreviewAlertResponse { + pub fn new(status: Status, issues: Vec, timerange_start: String, timerange_end: String) -> PreviewAlertResponse { + PreviewAlertResponse { + status, + issues, + timerange_start, + timerange_end, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/private_key_application_model.rs b/api/src/models/private_key_application_model.rs new file mode 100644 index 00000000..b8c0d854 --- /dev/null +++ b/api/src/models/private_key_application_model.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PrivateKeyApplicationModel { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "client_id")] + pub client_id: String, + #[serde(rename = "thumbprint")] + pub thumbprint: String, + #[serde(rename = "private_key", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub private_key: Option>, +} + +impl PrivateKeyApplicationModel { + pub fn new(tenant_id: String, client_id: String, thumbprint: String) -> PrivateKeyApplicationModel { + PrivateKeyApplicationModel { + kind: None, + tenant_id, + client_id, + thumbprint, + private_key: None, + } + } +} + diff --git a/api/src/models/private_key_application_model_kind.rs b/api/src/models/private_key_application_model_kind.rs new file mode 100644 index 00000000..45641b9b --- /dev/null +++ b/api/src/models/private_key_application_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// PrivateKeyApplicationModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum PrivateKeyApplicationModelKind { + #[serde(rename = "private_key")] + PrivateKey, + +} + +impl std::fmt::Display for PrivateKeyApplicationModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::PrivateKey => write!(f, "private_key"), + } + } +} + +impl Default for PrivateKeyApplicationModelKind { + fn default() -> PrivateKeyApplicationModelKind { + Self::PrivateKey + } +} + diff --git a/api/src/models/process.rs b/api/src/models/process.rs new file mode 100644 index 00000000..20c90d4c --- /dev/null +++ b/api/src/models/process.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Process { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "value")] + pub value: f64, + #[serde(rename = "direction")] + pub direction: models::Direction, + #[serde(rename = "variation_kind")] + pub variation_kind: models::VariationKind, + #[serde(rename = "compared_to")] + pub compared_to: models::TimePeriodComparison, +} + +impl Process { + pub fn new(kind: Kind, value: f64, direction: models::Direction, variation_kind: models::VariationKind, compared_to: models::TimePeriodComparison) -> Process { + Process { + kind, + value, + direction, + variation_kind, + compared_to, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "variation")] + Variation, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Variation + } +} + diff --git a/api/src/models/project.rs b/api/src/models/project.rs new file mode 100644 index 00000000..53008972 --- /dev/null +++ b/api/src/models/project.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Project { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "description")] + pub description: String, + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "updated_at")] + pub updated_at: String, + #[serde(rename = "user_auto_join")] + pub user_auto_join: bool, +} + +impl Project { + pub fn new(id: String, name: String, title: String, description: String, created_at: String, updated_at: String, user_auto_join: bool) -> Project { + Project { + id, + name, + title, + description, + created_at, + updated_at, + user_auto_join, + } + } +} + diff --git a/api/src/models/project_new.rs b/api/src/models/project_new.rs new file mode 100644 index 00000000..2261b4eb --- /dev/null +++ b/api/src/models/project_new.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectNew { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(rename = "user_auto_join", skip_serializing_if = "Option::is_none")] + pub user_auto_join: Option, +} + +impl ProjectNew { + pub fn new() -> ProjectNew { + ProjectNew { + title: None, + description: None, + user_auto_join: None, + } + } +} + diff --git a/api/src/models/project_permission.rs b/api/src/models/project_permission.rs new file mode 100644 index 00000000..72428d96 --- /dev/null +++ b/api/src/models/project_permission.rs @@ -0,0 +1,135 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ProjectPermission : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ProjectPermission { + #[serde(rename = "sources-add-comments")] + SourcesAddComments, + #[serde(rename = "datasets-admin")] + DatasetsAdmin, + #[serde(rename = "voc")] + Voc, + #[serde(rename = "datasets-review")] + DatasetsReview, + #[serde(rename = "voc-readonly")] + VocReadonly, + #[serde(rename = "datasets-model-admin")] + DatasetsModelAdmin, + #[serde(rename = "datasets-export")] + DatasetsExport, + #[serde(rename = "dashboards-write")] + DashboardsWrite, + #[serde(rename = "sources-admin")] + SourcesAdmin, + #[serde(rename = "sources-translate")] + SourcesTranslate, + #[serde(rename = "sources-read")] + SourcesRead, + #[serde(rename = "sources-read-sensitive")] + SourcesReadSensitive, + #[serde(rename = "triggers-admin")] + TriggersAdmin, + #[serde(rename = "triggers-consume")] + TriggersConsume, + #[serde(rename = "triggers-read")] + TriggersRead, + #[serde(rename = "triggers-write")] + TriggersWrite, + #[serde(rename = "users-read")] + UsersRead, + #[serde(rename = "users-write")] + UsersWrite, + #[serde(rename = "buckets-read")] + BucketsRead, + #[serde(rename = "buckets-write")] + BucketsWrite, + #[serde(rename = "buckets-items-read")] + BucketsItemsRead, + #[serde(rename = "buckets-append")] + BucketsAppend, + #[serde(rename = "files-write")] + FilesWrite, + #[serde(rename = "appliance-config-write")] + ApplianceConfigWrite, + #[serde(rename = "appliance-config-read")] + ApplianceConfigRead, + #[serde(rename = "integrations-write")] + IntegrationsWrite, + #[serde(rename = "integrations-read")] + IntegrationsRead, + #[serde(rename = "alerts-read")] + AlertsRead, + #[serde(rename = "alerts-write")] + AlertsWrite, + #[serde(rename = "role-cm-project-admin")] + RoleCmProjectAdmin, + #[serde(rename = "role-cm-model-trainer")] + RoleCmModelTrainer, + #[serde(rename = "role-cm-developer")] + RoleCmDeveloper, + #[serde(rename = "role-cm-viewer")] + RoleCmViewer, + #[serde(rename = "role-cm-analyst")] + RoleCmAnalyst, + +} + +impl std::fmt::Display for ProjectPermission { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::SourcesAddComments => write!(f, "sources-add-comments"), + Self::DatasetsAdmin => write!(f, "datasets-admin"), + Self::Voc => write!(f, "voc"), + Self::DatasetsReview => write!(f, "datasets-review"), + Self::VocReadonly => write!(f, "voc-readonly"), + Self::DatasetsModelAdmin => write!(f, "datasets-model-admin"), + Self::DatasetsExport => write!(f, "datasets-export"), + Self::DashboardsWrite => write!(f, "dashboards-write"), + Self::SourcesAdmin => write!(f, "sources-admin"), + Self::SourcesTranslate => write!(f, "sources-translate"), + Self::SourcesRead => write!(f, "sources-read"), + Self::SourcesReadSensitive => write!(f, "sources-read-sensitive"), + Self::TriggersAdmin => write!(f, "triggers-admin"), + Self::TriggersConsume => write!(f, "triggers-consume"), + Self::TriggersRead => write!(f, "triggers-read"), + Self::TriggersWrite => write!(f, "triggers-write"), + Self::UsersRead => write!(f, "users-read"), + Self::UsersWrite => write!(f, "users-write"), + Self::BucketsRead => write!(f, "buckets-read"), + Self::BucketsWrite => write!(f, "buckets-write"), + Self::BucketsItemsRead => write!(f, "buckets-items-read"), + Self::BucketsAppend => write!(f, "buckets-append"), + Self::FilesWrite => write!(f, "files-write"), + Self::ApplianceConfigWrite => write!(f, "appliance-config-write"), + Self::ApplianceConfigRead => write!(f, "appliance-config-read"), + Self::IntegrationsWrite => write!(f, "integrations-write"), + Self::IntegrationsRead => write!(f, "integrations-read"), + Self::AlertsRead => write!(f, "alerts-read"), + Self::AlertsWrite => write!(f, "alerts-write"), + Self::RoleCmProjectAdmin => write!(f, "role-cm-project-admin"), + Self::RoleCmModelTrainer => write!(f, "role-cm-model-trainer"), + Self::RoleCmDeveloper => write!(f, "role-cm-developer"), + Self::RoleCmViewer => write!(f, "role-cm-viewer"), + Self::RoleCmAnalyst => write!(f, "role-cm-analyst"), + } + } +} + +impl Default for ProjectPermission { + fn default() -> ProjectPermission { + Self::SourcesAddComments + } +} + diff --git a/api/src/models/project_setup_existing_source.rs b/api/src/models/project_setup_existing_source.rs new file mode 100644 index 00000000..572616dd --- /dev/null +++ b/api/src/models/project_setup_existing_source.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupExistingSource { + /// Unique ID of the source + #[serde(rename = "id")] + pub id: String, +} + +impl ProjectSetupExistingSource { + pub fn new(id: String) -> ProjectSetupExistingSource { + ProjectSetupExistingSource { + id, + } + } +} + diff --git a/api/src/models/project_setup_new_dataset.rs b/api/src/models/project_setup_new_dataset.rs new file mode 100644 index 00000000..67946afe --- /dev/null +++ b/api/src/models/project_setup_new_dataset.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupNewDataset { + /// The API name of the dataset which appears in URLs + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "_dataset_flags", skip_serializing_if = "Option::is_none")] + pub _dataset_flags: Option>, + #[serde(rename = "label_groups", skip_serializing_if = "Option::is_none")] + pub label_groups: Option>, +} + +impl ProjectSetupNewDataset { + pub fn new(name: String) -> ProjectSetupNewDataset { + ProjectSetupNewDataset { + name, + _dataset_flags: None, + label_groups: None, + } + } +} + diff --git a/api/src/models/project_setup_new_project.rs b/api/src/models/project_setup_new_project.rs new file mode 100644 index 00000000..b7703936 --- /dev/null +++ b/api/src/models/project_setup_new_project.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupNewProject { + /// The API name of the project + #[serde(rename = "name")] + pub name: String, +} + +impl ProjectSetupNewProject { + pub fn new(name: String) -> ProjectSetupNewProject { + ProjectSetupNewProject { + name, + } + } +} + diff --git a/api/src/models/project_setup_new_source.rs b/api/src/models/project_setup_new_source.rs new file mode 100644 index 00000000..ebc8b38b --- /dev/null +++ b/api/src/models/project_setup_new_source.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupNewSource { + /// The API name of the source + #[serde(rename = "name")] + pub name: String, + /// The language of the messages in the source + #[serde(rename = "language")] + pub language: models::Language, + #[serde(rename = "bucket_id", skip_serializing_if = "Option::is_none")] + pub bucket_id: Option, +} + +impl ProjectSetupNewSource { + pub fn new(name: String, language: models::Language) -> ProjectSetupNewSource { + ProjectSetupNewSource { + name, + language, + bucket_id: None, + } + } +} + diff --git a/api/src/models/project_setup_new_stream.rs b/api/src/models/project_setup_new_stream.rs new file mode 100644 index 00000000..0646a58d --- /dev/null +++ b/api/src/models/project_setup_new_stream.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupNewStream { + #[serde(rename = "name")] + pub name: String, +} + +impl ProjectSetupNewStream { + pub fn new(name: String) -> ProjectSetupNewStream { + ProjectSetupNewStream { + name, + } + } +} + diff --git a/api/src/models/project_setup_new_users.rs b/api/src/models/project_setup_new_users.rs new file mode 100644 index 00000000..7fe2e104 --- /dev/null +++ b/api/src/models/project_setup_new_users.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectSetupNewUsers { + #[serde(rename = "emails")] + pub emails: Vec, +} + +impl ProjectSetupNewUsers { + pub fn new(emails: Vec) -> ProjectSetupNewUsers { + ProjectSetupNewUsers { + emails, + } + } +} + diff --git a/api/src/models/project_v1.rs b/api/src/models/project_v1.rs new file mode 100644 index 00000000..3746c02b --- /dev/null +++ b/api/src/models/project_v1.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ProjectV1 { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "description")] + pub description: String, +} + +impl ProjectV1 { + pub fn new(name: String, title: String, description: String) -> ProjectV1 { + ProjectV1 { + name, + title, + description, + } + } +} + diff --git a/api/src/models/put_comment_as_seen_request.rs b/api/src/models/put_comment_as_seen_request.rs new file mode 100644 index 00000000..2f23be64 --- /dev/null +++ b/api/src/models/put_comment_as_seen_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PutCommentAsSeenRequest { + #[serde(rename = "is_with_annotation")] + pub is_with_annotation: bool, +} + +impl PutCommentAsSeenRequest { + pub fn new(is_with_annotation: bool) -> PutCommentAsSeenRequest { + PutCommentAsSeenRequest { + is_with_annotation, + } + } +} + diff --git a/api/src/models/put_comment_as_seen_response.rs b/api/src/models/put_comment_as_seen_response.rs new file mode 100644 index 00000000..c49515b0 --- /dev/null +++ b/api/src/models/put_comment_as_seen_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct PutCommentAsSeenResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "training_action_completeness")] + pub training_action_completeness: models::TrainingActionCompleteness, +} + +impl PutCommentAsSeenResponse { + pub fn new(status: Status, training_action_completeness: models::TrainingActionCompleteness) -> PutCommentAsSeenResponse { + PutCommentAsSeenResponse { + status, + training_action_completeness, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_audit_events_filter.rs b/api/src/models/query_audit_events_filter.rs new file mode 100644 index 00000000..1a75f143 --- /dev/null +++ b/api/src/models/query_audit_events_filter.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryAuditEventsFilter { + #[serde(rename = "timestamp", skip_serializing_if = "Option::is_none")] + pub timestamp: Option>, +} + +impl QueryAuditEventsFilter { + pub fn new() -> QueryAuditEventsFilter { + QueryAuditEventsFilter { + timestamp: None, + } + } +} + diff --git a/api/src/models/query_audit_events_request.rs b/api/src/models/query_audit_events_request.rs new file mode 100644 index 00000000..5b5c4a09 --- /dev/null +++ b/api/src/models/query_audit_events_request.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryAuditEventsRequest { + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, + #[serde(rename = "filter", skip_serializing_if = "Option::is_none")] + pub filter: Option>, +} + +impl QueryAuditEventsRequest { + pub fn new() -> QueryAuditEventsRequest { + QueryAuditEventsRequest { + limit: None, + continuation: None, + filter: None, + } + } +} + diff --git a/api/src/models/query_audit_events_response.rs b/api/src/models/query_audit_events_response.rs new file mode 100644 index 00000000..9dce3f37 --- /dev/null +++ b/api/src/models/query_audit_events_response.rs @@ -0,0 +1,62 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryAuditEventsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "audit_events")] + pub audit_events: Vec, + #[serde(rename = "tenants")] + pub tenants: Vec, + #[serde(rename = "users", skip_serializing_if = "Option::is_none")] + pub users: Option>, + #[serde(rename = "sources", skip_serializing_if = "Option::is_none")] + pub sources: Option>, + #[serde(rename = "datasets", skip_serializing_if = "Option::is_none")] + pub datasets: Option>, + #[serde(rename = "triggers", skip_serializing_if = "Option::is_none")] + pub triggers: Option>, + #[serde(rename = "projects", skip_serializing_if = "Option::is_none")] + pub projects: Option>, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl QueryAuditEventsResponse { + pub fn new(status: Status, audit_events: Vec, tenants: Vec) -> QueryAuditEventsResponse { + QueryAuditEventsResponse { + status, + audit_events, + tenants, + users: None, + sources: None, + datasets: None, + triggers: None, + projects: None, + continuation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_comments_request.rs b/api/src/models/query_comments_request.rs new file mode 100644 index 00000000..3b7f6385 --- /dev/null +++ b/api/src/models/query_comments_request.rs @@ -0,0 +1,55 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsRequest { + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "attribute_filters", skip_serializing_if = "Option::is_none")] + pub attribute_filters: Option>, + #[serde(rename = "collapse_mode", skip_serializing_if = "Option::is_none")] + pub collapse_mode: Option, + #[serde(rename = "filter", skip_serializing_if = "Option::is_none")] + pub filter: Option, + #[serde(rename = "order")] + pub order: Box, +} + +impl QueryCommentsRequest { + pub fn new(order: models::Order) -> QueryCommentsRequest { + QueryCommentsRequest { + continuation: None, + limit: None, + attribute_filters: None, + collapse_mode: None, + filter: None, + order: Box::new(order), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum CollapseMode { + #[serde(rename = "thread_id")] + ThreadId, + #[serde(rename = "none")] + None, +} + +impl Default for CollapseMode { + fn default() -> CollapseMode { + Self::ThreadId + } +} + diff --git a/api/src/models/query_comments_response.rs b/api/src/models/query_comments_response.rs new file mode 100644 index 00000000..2f9fa051 --- /dev/null +++ b/api/src/models/query_comments_response.rs @@ -0,0 +1,59 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryCommentsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "entity_defs")] + pub entity_defs: Vec, + #[serde(rename = "triggers", skip_serializing_if = "Option::is_none")] + pub triggers: Option>, + #[serde(rename = "results")] + pub results: Vec, + #[serde(rename = "num_results", skip_serializing_if = "Option::is_none")] + pub num_results: Option>, + #[serde(rename = "seed", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub seed: Option>, + #[serde(rename = "query", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub query: Option>, + #[serde(rename = "continuation", skip_serializing_if = "Option::is_none")] + pub continuation: Option, +} + +impl QueryCommentsResponse { + pub fn new(status: Status, entity_defs: Vec, results: Vec) -> QueryCommentsResponse { + QueryCommentsResponse { + status, + entity_defs, + triggers: None, + results, + num_results: None, + seed: None, + query: None, + continuation: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_dataset_user_property_values_request.rs b/api/src/models/query_dataset_user_property_values_request.rs new file mode 100644 index 00000000..a0902106 --- /dev/null +++ b/api/src/models/query_dataset_user_property_values_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryDatasetUserPropertyValuesRequest { + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "filter", skip_serializing_if = "Option::is_none")] + pub filter: Option>, +} + +impl QueryDatasetUserPropertyValuesRequest { + pub fn new() -> QueryDatasetUserPropertyValuesRequest { + QueryDatasetUserPropertyValuesRequest { + limit: None, + filter: None, + } + } +} + diff --git a/api/src/models/query_dataset_user_property_values_response.rs b/api/src/models/query_dataset_user_property_values_response.rs new file mode 100644 index 00000000..22d9dae7 --- /dev/null +++ b/api/src/models/query_dataset_user_property_values_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryDatasetUserPropertyValuesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "user_property")] + pub user_property: Box, +} + +impl QueryDatasetUserPropertyValuesResponse { + pub fn new(status: Status, user_property: models::StringUserPropertySummary) -> QueryDatasetUserPropertyValuesResponse { + QueryDatasetUserPropertyValuesResponse { + status, + user_property: Box::new(user_property), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_issues_request.rs b/api/src/models/query_issues_request.rs new file mode 100644 index 00000000..62179d37 --- /dev/null +++ b/api/src/models/query_issues_request.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryIssuesRequest { + /// An optional list of status' to filter by. + #[serde(rename = "status", skip_serializing_if = "Option::is_none")] + pub status: Option>, +} + +impl QueryIssuesRequest { + pub fn new() -> QueryIssuesRequest { + QueryIssuesRequest { + status: None, + } + } +} + diff --git a/api/src/models/query_issues_response.rs b/api/src/models/query_issues_response.rs new file mode 100644 index 00000000..84997c22 --- /dev/null +++ b/api/src/models/query_issues_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryIssuesResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "issues")] + pub issues: Vec, + #[serde(rename = "alerts")] + pub alerts: Vec, +} + +impl QueryIssuesResponse { + pub fn new(status: Status, issues: Vec, alerts: Vec) -> QueryIssuesResponse { + QueryIssuesResponse { + status, + issues, + alerts, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_keyed_sync_state_ids_request.rs b/api/src/models/query_keyed_sync_state_ids_request.rs new file mode 100644 index 00000000..0baa35f0 --- /dev/null +++ b/api/src/models/query_keyed_sync_state_ids_request.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryKeyedSyncStateIdsRequest { + /// The name of the mailbox to filter by. + #[serde(rename = "mailbox_name")] + pub mailbox_name: String, +} + +impl QueryKeyedSyncStateIdsRequest { + pub fn new(mailbox_name: String) -> QueryKeyedSyncStateIdsRequest { + QueryKeyedSyncStateIdsRequest { + mailbox_name, + } + } +} + diff --git a/api/src/models/query_keyed_sync_state_ids_response.rs b/api/src/models/query_keyed_sync_state_ids_response.rs new file mode 100644 index 00000000..3b56d2d9 --- /dev/null +++ b/api/src/models/query_keyed_sync_state_ids_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryKeyedSyncStateIdsResponse { + #[serde(rename = "status")] + pub status: Status, + /// hex encoded ids of the keyed sync states + #[serde(rename = "keyed_sync_state_ids")] + pub keyed_sync_state_ids: Vec, +} + +impl QueryKeyedSyncStateIdsResponse { + pub fn new(status: Status, keyed_sync_state_ids: Vec) -> QueryKeyedSyncStateIdsResponse { + QueryKeyedSyncStateIdsResponse { + status, + keyed_sync_state_ids, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/query_result_counts.rs b/api/src/models/query_result_counts.rs new file mode 100644 index 00000000..6b742f24 --- /dev/null +++ b/api/src/models/query_result_counts.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct QueryResultCounts { + #[serde(rename = "filtered")] + pub filtered: i32, + #[serde(rename = "expected")] + pub expected: i32, +} + +impl QueryResultCounts { + pub fn new(filtered: i32, expected: i32) -> QueryResultCounts { + QueryResultCounts { + filtered, + expected, + } + } +} + diff --git a/api/src/models/quota.rs b/api/src/models/quota.rs new file mode 100644 index 00000000..326d1606 --- /dev/null +++ b/api/src/models/quota.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Quota { + /// Quota kind + #[serde(rename = "quota_kind")] + pub quota_kind: models::QuotaKind, + /// The value to set for the corresponding quota + #[serde(rename = "hard_limit")] + pub hard_limit: i32, + /// The current max usage for the corresponding quota + #[serde(rename = "current_max_usage")] + pub current_max_usage: i32, + /// The maximum a user can automatically increase the quota value up to + #[serde(rename = "auto_increase_up_to", skip_serializing_if = "Option::is_none")] + pub auto_increase_up_to: Option, +} + +impl Quota { + pub fn new(quota_kind: models::QuotaKind, hard_limit: i32, current_max_usage: i32) -> Quota { + Quota { + quota_kind, + hard_limit, + current_max_usage, + auto_increase_up_to: None, + } + } +} + diff --git a/api/src/models/quota_kind.rs b/api/src/models/quota_kind.rs new file mode 100644 index 00000000..c7493e0a --- /dev/null +++ b/api/src/models/quota_kind.rs @@ -0,0 +1,96 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// QuotaKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum QuotaKind { + #[serde(rename = "alerts")] + Alerts, + #[serde(rename = "buckets")] + Buckets, + #[serde(rename = "comments")] + Comments, + #[serde(rename = "comments_per_source")] + CommentsPerSource, + #[serde(rename = "comments_in_ixp_runtime")] + CommentsInIxpRuntime, + #[serde(rename = "comments_in_ixp_designtime")] + CommentsInIxpDesigntime, + #[serde(rename = "datasets")] + Datasets, + #[serde(rename = "datasets_per_source")] + DatasetsPerSource, + #[serde(rename = "entities_per_dataset")] + EntitiesPerDataset, + #[serde(rename = "integrations")] + Integrations, + #[serde(rename = "labels_per_dataset")] + LabelsPerDataset, + #[serde(rename = "mailboxes_per_integration")] + MailboxesPerIntegration, + #[serde(rename = "pinned_models")] + PinnedModels, + #[serde(rename = "projects")] + Projects, + #[serde(rename = "reviewed_comments_per_dataset")] + ReviewedCommentsPerDataset, + #[serde(rename = "sources")] + Sources, + #[serde(rename = "sources_per_dataset")] + SourcesPerDataset, + #[serde(rename = "triggers")] + Triggers, + #[serde(rename = "triggers_per_dataset")] + TriggersPerDataset, + #[serde(rename = "users")] + Users, + #[serde(rename = "extraction_predictions")] + ExtractionPredictions, + +} + +impl std::fmt::Display for QuotaKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Alerts => write!(f, "alerts"), + Self::Buckets => write!(f, "buckets"), + Self::Comments => write!(f, "comments"), + Self::CommentsPerSource => write!(f, "comments_per_source"), + Self::CommentsInIxpRuntime => write!(f, "comments_in_ixp_runtime"), + Self::CommentsInIxpDesigntime => write!(f, "comments_in_ixp_designtime"), + Self::Datasets => write!(f, "datasets"), + Self::DatasetsPerSource => write!(f, "datasets_per_source"), + Self::EntitiesPerDataset => write!(f, "entities_per_dataset"), + Self::Integrations => write!(f, "integrations"), + Self::LabelsPerDataset => write!(f, "labels_per_dataset"), + Self::MailboxesPerIntegration => write!(f, "mailboxes_per_integration"), + Self::PinnedModels => write!(f, "pinned_models"), + Self::Projects => write!(f, "projects"), + Self::ReviewedCommentsPerDataset => write!(f, "reviewed_comments_per_dataset"), + Self::Sources => write!(f, "sources"), + Self::SourcesPerDataset => write!(f, "sources_per_dataset"), + Self::Triggers => write!(f, "triggers"), + Self::TriggersPerDataset => write!(f, "triggers_per_dataset"), + Self::Users => write!(f, "users"), + Self::ExtractionPredictions => write!(f, "extraction_predictions"), + } + } +} + +impl Default for QuotaKind { + fn default() -> QuotaKind { + Self::Alerts + } +} + diff --git a/api/src/models/raw_email.rs b/api/src/models/raw_email.rs new file mode 100644 index 00000000..d0ec204c --- /dev/null +++ b/api/src/models/raw_email.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RawEmail { + #[serde(rename = "headers")] + pub headers: Box, + /// An object containing the main body of the email + #[serde(rename = "body")] + pub body: Box, + #[serde(rename = "attachments", skip_serializing_if = "Option::is_none")] + pub attachments: Option>, +} + +impl RawEmail { + pub fn new(headers: models::Headers, body: models::RawEmailBody) -> RawEmail { + RawEmail { + headers: Box::new(headers), + body: Box::new(body), + attachments: None, + } + } +} + diff --git a/api/src/models/raw_email_document.rs b/api/src/models/raw_email_document.rs new file mode 100644 index 00000000..eefea548 --- /dev/null +++ b/api/src/models/raw_email_document.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RawEmailDocument { + /// An object containing the main body of the email + #[serde(rename = "raw_email")] + pub raw_email: Box, + /// Identifies a comment uniquely. If no comment ID is provided, Re:infer will generate the comment ID from the email's message ID. The format is described in the Comment Reference. + #[serde(rename = "comment_id", skip_serializing_if = "Option::is_none")] + pub comment_id: Option, + #[serde(rename = "user_properties", skip_serializing_if = "Option::is_none")] + pub user_properties: Option>, +} + +impl RawEmailDocument { + pub fn new(raw_email: models::RawEmail) -> RawEmailDocument { + RawEmailDocument { + raw_email: Box::new(raw_email), + comment_id: None, + user_properties: None, + } + } +} + diff --git a/api/src/models/regex.rs b/api/src/models/regex.rs new file mode 100644 index 00000000..52230954 --- /dev/null +++ b/api/src/models/regex.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Regex { + #[serde(rename = "pattern")] + pub pattern: String, + #[serde(rename = "templates")] + pub templates: Vec, +} + +impl Regex { + pub fn new(pattern: String, templates: Vec) -> Regex { + Regex { + pattern, + templates, + } + } +} + diff --git a/api/src/models/remove_support_tenant_request.rs b/api/src/models/remove_support_tenant_request.rs new file mode 100644 index 00000000..551c7c6b --- /dev/null +++ b/api/src/models/remove_support_tenant_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RemoveSupportTenantRequest { + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "user_tenant")] + pub user_tenant: String, +} + +impl RemoveSupportTenantRequest { + pub fn new(email: String, user_tenant: String) -> RemoveSupportTenantRequest { + RemoveSupportTenantRequest { + email, + user_tenant, + } + } +} + diff --git a/api/src/models/remove_support_tenant_response.rs b/api/src/models/remove_support_tenant_response.rs new file mode 100644 index 00000000..f245c2d4 --- /dev/null +++ b/api/src/models/remove_support_tenant_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RemoveSupportTenantResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl RemoveSupportTenantResponse { + pub fn new(status: Status) -> RemoveSupportTenantResponse { + RemoveSupportTenantResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/reset_annotations_to_previous_pinned_model_request.rs b/api/src/models/reset_annotations_to_previous_pinned_model_request.rs new file mode 100644 index 00000000..f0991211 --- /dev/null +++ b/api/src/models/reset_annotations_to_previous_pinned_model_request.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetAnnotationsToPreviousPinnedModelRequest { + /// Model version to reset to + #[serde(rename = "model_version")] + pub model_version: i32, +} + +impl ResetAnnotationsToPreviousPinnedModelRequest { + pub fn new(model_version: i32) -> ResetAnnotationsToPreviousPinnedModelRequest { + ResetAnnotationsToPreviousPinnedModelRequest { + model_version, + } + } +} + diff --git a/api/src/models/reset_annotations_to_previous_pinned_model_response.rs b/api/src/models/reset_annotations_to_previous_pinned_model_response.rs new file mode 100644 index 00000000..00920318 --- /dev/null +++ b/api/src/models/reset_annotations_to_previous_pinned_model_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetAnnotationsToPreviousPinnedModelResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl ResetAnnotationsToPreviousPinnedModelResponse { + pub fn new(status: Status) -> ResetAnnotationsToPreviousPinnedModelResponse { + ResetAnnotationsToPreviousPinnedModelResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/reset_stream_request.rs b/api/src/models/reset_stream_request.rs new file mode 100644 index 00000000..14f4e807 --- /dev/null +++ b/api/src/models/reset_stream_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetStreamRequest { + #[serde(rename = "to_comment_created_at")] + pub to_comment_created_at: String, +} + +impl ResetStreamRequest { + pub fn new(to_comment_created_at: String) -> ResetStreamRequest { + ResetStreamRequest { + to_comment_created_at, + } + } +} + diff --git a/api/src/models/reset_stream_response.rs b/api/src/models/reset_stream_response.rs new file mode 100644 index 00000000..38465c0f --- /dev/null +++ b/api/src/models/reset_stream_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetStreamResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sequence_id")] + pub sequence_id: String, + #[serde(rename = "stream")] + pub stream: Box, +} + +impl ResetStreamResponse { + pub fn new(status: Status, sequence_id: String, stream: models::Trigger) -> ResetStreamResponse { + ResetStreamResponse { + status, + sequence_id, + stream: Box::new(stream), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/reset_tenant_quota_response.rs b/api/src/models/reset_tenant_quota_response.rs new file mode 100644 index 00000000..4812b16b --- /dev/null +++ b/api/src/models/reset_tenant_quota_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetTenantQuotaResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl ResetTenantQuotaResponse { + pub fn new(status: Status) -> ResetTenantQuotaResponse { + ResetTenantQuotaResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/reset_trigger_request.rs b/api/src/models/reset_trigger_request.rs new file mode 100644 index 00000000..96ecebea --- /dev/null +++ b/api/src/models/reset_trigger_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetTriggerRequest { + #[serde(rename = "to_comment_created_at")] + pub to_comment_created_at: String, +} + +impl ResetTriggerRequest { + pub fn new(to_comment_created_at: String) -> ResetTriggerRequest { + ResetTriggerRequest { + to_comment_created_at, + } + } +} + diff --git a/api/src/models/reset_trigger_response.rs b/api/src/models/reset_trigger_response.rs new file mode 100644 index 00000000..9aab2f9c --- /dev/null +++ b/api/src/models/reset_trigger_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ResetTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "sequence_id")] + pub sequence_id: String, + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl ResetTriggerResponse { + pub fn new(status: Status, sequence_id: String, trigger: models::Trigger) -> ResetTriggerResponse { + ResetTriggerResponse { + status, + sequence_id, + trigger: Box::new(trigger), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/response_status_error.rs b/api/src/models/response_status_error.rs new file mode 100644 index 00000000..56354845 --- /dev/null +++ b/api/src/models/response_status_error.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ResponseStatusError : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ResponseStatusError { + #[serde(rename = "error")] + Error, + +} + +impl std::fmt::Display for ResponseStatusError { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Error => write!(f, "error"), + } + } +} + +impl Default for ResponseStatusError { + fn default() -> ResponseStatusError { + Self::Error + } +} + diff --git a/api/src/models/retrieval_method.rs b/api/src/models/retrieval_method.rs new file mode 100644 index 00000000..c64186f5 --- /dev/null +++ b/api/src/models/retrieval_method.rs @@ -0,0 +1,84 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// RetrievalMethod : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum RetrievalMethod { + #[serde(rename = "recent")] + Recent, + #[serde(rename = "shuffle")] + Shuffle, + #[serde(rename = "teach_label")] + TeachLabel, + #[serde(rename = "teach")] + Teach, + #[serde(rename = "text_search")] + TextSearch, + #[serde(rename = "attachment_text_search")] + AttachmentTextSearch, + #[serde(rename = "by_label_self")] + ByLabelSelf, + #[serde(rename = "by_label_other")] + ByLabelOther, + #[serde(rename = "by_sentiment")] + BySentiment, + #[serde(rename = "clusters")] + Clusters, + #[serde(rename = "uid")] + Uid, + #[serde(rename = "low_confidence")] + LowConfidence, + #[serde(rename = "rebalance")] + Rebalance, + #[serde(rename = "label_property")] + LabelProperty, + #[serde(rename = "teach_entity")] + TeachEntity, + #[serde(rename = "check_entity")] + CheckEntity, + #[serde(rename = "missed_entity")] + MissedEntity, + +} + +impl std::fmt::Display for RetrievalMethod { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Recent => write!(f, "recent"), + Self::Shuffle => write!(f, "shuffle"), + Self::TeachLabel => write!(f, "teach_label"), + Self::Teach => write!(f, "teach"), + Self::TextSearch => write!(f, "text_search"), + Self::AttachmentTextSearch => write!(f, "attachment_text_search"), + Self::ByLabelSelf => write!(f, "by_label_self"), + Self::ByLabelOther => write!(f, "by_label_other"), + Self::BySentiment => write!(f, "by_sentiment"), + Self::Clusters => write!(f, "clusters"), + Self::Uid => write!(f, "uid"), + Self::LowConfidence => write!(f, "low_confidence"), + Self::Rebalance => write!(f, "rebalance"), + Self::LabelProperty => write!(f, "label_property"), + Self::TeachEntity => write!(f, "teach_entity"), + Self::CheckEntity => write!(f, "check_entity"), + Self::MissedEntity => write!(f, "missed_entity"), + } + } +} + +impl Default for RetrievalMethod { + fn default() -> RetrievalMethod { + Self::Recent + } +} + diff --git a/api/src/models/reviewable_block.rs b/api/src/models/reviewable_block.rs new file mode 100644 index 00000000..8fd6a78b --- /dev/null +++ b/api/src/models/reviewable_block.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ReviewableBlock { + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, +} + +impl ReviewableBlock { + pub fn new(utf16_byte_start: i32, utf16_byte_end: i32) -> ReviewableBlock { + ReviewableBlock { + utf16_byte_start, + utf16_byte_end, + } + } +} + diff --git a/api/src/models/reviewable_block_group.rs b/api/src/models/reviewable_block_group.rs new file mode 100644 index 00000000..58c69872 --- /dev/null +++ b/api/src/models/reviewable_block_group.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ReviewableBlockGroup { + #[serde(rename = "body_blocks")] + pub body_blocks: Vec, +} + +impl ReviewableBlockGroup { + pub fn new(body_blocks: Vec) -> ReviewableBlockGroup { + ReviewableBlockGroup { + body_blocks, + } + } +} + diff --git a/api/src/models/reviewed.rs b/api/src/models/reviewed.rs new file mode 100644 index 00000000..8e232ad6 --- /dev/null +++ b/api/src/models/reviewed.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// Reviewed : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Reviewed { + #[serde(rename = "only_reviewed")] + Reviewed, + #[serde(rename = "only_unreviewed")] + Unreviewed, + +} + +impl std::fmt::Display for Reviewed { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Reviewed => write!(f, "only_reviewed"), + Self::Unreviewed => write!(f, "only_unreviewed"), + } + } +} + +impl Default for Reviewed { + fn default() -> Reviewed { + Self::Reviewed + } +} + diff --git a/api/src/models/reviewed_filter_rule.rs b/api/src/models/reviewed_filter_rule.rs new file mode 100644 index 00000000..5314b53c --- /dev/null +++ b/api/src/models/reviewed_filter_rule.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ReviewedFilterRule : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ReviewedFilterRule { + #[serde(rename = "only_reviewed")] + Reviewed, + #[serde(rename = "only_unreviewed")] + Unreviewed, + +} + +impl std::fmt::Display for ReviewedFilterRule { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Reviewed => write!(f, "only_reviewed"), + Self::Unreviewed => write!(f, "only_unreviewed"), + } + } +} + +impl Default for ReviewedFilterRule { + fn default() -> ReviewedFilterRule { + Self::Reviewed + } +} + diff --git a/api/src/models/rich_diagnostic_kind.rs b/api/src/models/rich_diagnostic_kind.rs new file mode 100644 index 00000000..4ae2ceb5 --- /dev/null +++ b/api/src/models/rich_diagnostic_kind.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct RichDiagnosticKind { + #[serde(rename = "diagnostic_kind")] + pub diagnostic_kind: models::DiagnosticKind, + #[serde(rename = "related_to", deserialize_with = "Option::deserialize")] + pub related_to: Option, +} + +impl RichDiagnosticKind { + pub fn new(diagnostic_kind: models::DiagnosticKind, related_to: Option) -> RichDiagnosticKind { + RichDiagnosticKind { + diagnostic_kind, + related_to, + } + } +} + diff --git a/api/src/models/send_welcome_email_response.rs b/api/src/models/send_welcome_email_response.rs new file mode 100644 index 00000000..ab024184 --- /dev/null +++ b/api/src/models/send_welcome_email_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SendWelcomeEmailResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl SendWelcomeEmailResponse { + pub fn new(status: Status) -> SendWelcomeEmailResponse { + SendWelcomeEmailResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sentiment.rs b/api/src/models/sentiment.rs new file mode 100644 index 00000000..e96fcedf --- /dev/null +++ b/api/src/models/sentiment.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Sentiment { + #[serde(rename = "positive")] + pub positive: f64, + #[serde(rename = "negative")] + pub negative: f64, +} + +impl Sentiment { + pub fn new(positive: f64, negative: f64) -> Sentiment { + Sentiment { + positive, + negative, + } + } +} + diff --git a/api/src/models/set_comment_audio_response.rs b/api/src/models/set_comment_audio_response.rs new file mode 100644 index 00000000..7783ab56 --- /dev/null +++ b/api/src/models/set_comment_audio_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetCommentAudioResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl SetCommentAudioResponse { + pub fn new(status: Status) -> SetCommentAudioResponse { + SetCommentAudioResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/set_quota_for_tenant_request.rs b/api/src/models/set_quota_for_tenant_request.rs new file mode 100644 index 00000000..d0fdbdaf --- /dev/null +++ b/api/src/models/set_quota_for_tenant_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetQuotaForTenantRequest { + /// Limit to which to set the quota. Requests to create a new resource will fail if that quota is exceeded. + #[serde(rename = "hard_limit")] + pub hard_limit: i32, + /// Limit to which a user is able to automatically increase the quota. Specify None for the default limit. + #[serde(rename = "auto_increase_up_to", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub auto_increase_up_to: Option>, +} + +impl SetQuotaForTenantRequest { + pub fn new(hard_limit: i32) -> SetQuotaForTenantRequest { + SetQuotaForTenantRequest { + hard_limit, + auto_increase_up_to: None, + } + } +} + diff --git a/api/src/models/set_quota_for_tenant_response.rs b/api/src/models/set_quota_for_tenant_response.rs new file mode 100644 index 00000000..f85bcd27 --- /dev/null +++ b/api/src/models/set_quota_for_tenant_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetQuotaForTenantResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl SetQuotaForTenantResponse { + pub fn new(status: Status) -> SetQuotaForTenantResponse { + SetQuotaForTenantResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/set_tenant_quota_request.rs b/api/src/models/set_tenant_quota_request.rs new file mode 100644 index 00000000..57321206 --- /dev/null +++ b/api/src/models/set_tenant_quota_request.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetTenantQuotaRequest { + /// New limit to try and increase the quota to. If this falls beyond the value a user can automatically increase a quota to, the quota will be set to the highest accepted value and fail. + #[serde(rename = "requested_limit")] + pub requested_limit: i32, +} + +impl SetTenantQuotaRequest { + pub fn new(requested_limit: i32) -> SetTenantQuotaRequest { + SetTenantQuotaRequest { + requested_limit, + } + } +} + diff --git a/api/src/models/set_tenant_quota_response.rs b/api/src/models/set_tenant_quota_response.rs new file mode 100644 index 00000000..e0aa8bba --- /dev/null +++ b/api/src/models/set_tenant_quota_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetTenantQuotaResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "hard_limit")] + pub hard_limit: i32, + #[serde(rename = "requested_limit")] + pub requested_limit: i32, +} + +impl SetTenantQuotaResponse { + pub fn new(status: Status, hard_limit: i32, requested_limit: i32) -> SetTenantQuotaResponse { + SetTenantQuotaResponse { + status, + hard_limit, + requested_limit, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/set_tenant_state_request.rs b/api/src/models/set_tenant_state_request.rs new file mode 100644 index 00000000..cc1e4ffa --- /dev/null +++ b/api/src/models/set_tenant_state_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetTenantStateRequest { + #[serde(rename = "enabled")] + pub enabled: bool, +} + +impl SetTenantStateRequest { + pub fn new(enabled: bool) -> SetTenantStateRequest { + SetTenantStateRequest { + enabled, + } + } +} + diff --git a/api/src/models/set_tenant_state_response.rs b/api/src/models/set_tenant_state_response.rs new file mode 100644 index 00000000..c2e6bad6 --- /dev/null +++ b/api/src/models/set_tenant_state_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SetTenantStateResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl SetTenantStateResponse { + pub fn new(status: Status) -> SetTenantStateResponse { + SetTenantStateResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/significance.rs b/api/src/models/significance.rs new file mode 100644 index 00000000..63a45175 --- /dev/null +++ b/api/src/models/significance.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Significance { + #[serde(rename = "proportion")] + pub proportion: Box, + #[serde(rename = "positivity")] + pub positivity: Box, +} + +impl Significance { + pub fn new(proportion: models::SignificanceValue, positivity: models::SignificanceValue) -> Significance { + Significance { + proportion: Box::new(proportion), + positivity: Box::new(positivity), + } + } +} + diff --git a/api/src/models/significance_value.rs b/api/src/models/significance_value.rs new file mode 100644 index 00000000..c6de7305 --- /dev/null +++ b/api/src/models/significance_value.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SignificanceValue { + #[serde(rename = "log_odds_ratio")] + pub log_odds_ratio: f64, + #[serde(rename = "is_significant")] + pub is_significant: bool, +} + +impl SignificanceValue { + pub fn new(log_odds_ratio: f64, is_significant: bool) -> SignificanceValue { + SignificanceValue { + log_odds_ratio, + is_significant, + } + } +} + diff --git a/api/src/models/single_label_summary.rs b/api/src/models/single_label_summary.rs new file mode 100644 index 00000000..d5a4ae51 --- /dev/null +++ b/api/src/models/single_label_summary.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SingleLabelSummary { + /// Name of the label + #[serde(rename = "name")] + pub name: String, + /// Unfiltered assigned sentiment + #[serde(rename = "unfiltered_assigned")] + pub unfiltered_assigned: Box, + /// Filtered sentiment + #[serde(rename = "filtered", skip_serializing_if = "Option::is_none")] + pub filtered: Option>, + /// Threshold for the label + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option, + /// Title of the label + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Health of the label + #[serde(rename = "health", skip_serializing_if = "Option::is_none")] + pub health: Option>, +} + +impl SingleLabelSummary { + pub fn new(name: String, unfiltered_assigned: models::LabelCounts) -> SingleLabelSummary { + SingleLabelSummary { + name, + unfiltered_assigned: Box::new(unfiltered_assigned), + filtered: None, + threshold: None, + title: None, + health: None, + } + } +} + diff --git a/api/src/models/single_tenants_response.rs b/api/src/models/single_tenants_response.rs new file mode 100644 index 00000000..cf6070dc --- /dev/null +++ b/api/src/models/single_tenants_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SingleTenantsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "tenant")] + pub tenant: Box, +} + +impl SingleTenantsResponse { + pub fn new(status: Status, tenant: models::Tenant) -> SingleTenantsResponse { + SingleTenantsResponse { + status, + tenant: Box::new(tenant), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sniff_csv_response.rs b/api/src/models/sniff_csv_response.rs new file mode 100644 index 00000000..bf84b869 --- /dev/null +++ b/api/src/models/sniff_csv_response.rs @@ -0,0 +1,47 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SniffCsvResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "columns")] + pub columns: Vec, + #[serde(rename = "encoding")] + pub encoding: String, + #[serde(rename = "delimiter")] + pub delimiter: String, +} + +impl SniffCsvResponse { + pub fn new(status: Status, columns: Vec, encoding: String, delimiter: String) -> SniffCsvResponse { + SniffCsvResponse { + status, + columns, + encoding, + delimiter, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/source.rs b/api/src/models/source.rs new file mode 100644 index 00000000..bffeade6 --- /dev/null +++ b/api/src/models/source.rs @@ -0,0 +1,82 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Source { + /// Unique ID of the source + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "_kind")] + pub _kind: models::SourceKind, + /// The project which owns the source + #[serde(rename = "owner")] + pub owner: String, + /// The API name of the source + #[serde(rename = "name")] + pub name: String, + /// The language of the messages in the source + #[serde(rename = "language")] + pub language: String, + /// A short description of the source + #[serde(rename = "title")] + pub title: String, + /// A longer description of the source + #[serde(rename = "description")] + pub description: String, + /// Whether messages in this source will be automatically translated + #[serde(rename = "should_translate")] + pub should_translate: bool, + /// User properties that require additional permissions to view + #[serde(rename = "sensitive_properties")] + pub sensitive_properties: Vec, + /// Timestamp when the source was created + #[serde(rename = "created_at")] + pub created_at: String, + /// Timestamp when the source was last updated + #[serde(rename = "updated_at")] + pub updated_at: String, + /// Timestamp when the source was last modified + #[serde(rename = "last_modified")] + pub last_modified: String, + #[serde(rename = "bucket_id", skip_serializing_if = "Option::is_none")] + pub bucket_id: Option, + /// A tag for email parsing logic + #[serde(rename = "email_transform_tag", skip_serializing_if = "Option::is_none")] + pub email_transform_tag: Option, + /// A version for parsing of this source with corresponding tag + #[serde(rename = "email_transform_version", skip_serializing_if = "Option::is_none")] + pub email_transform_version: Option, +} + +impl Source { + pub fn new(id: String, _kind: models::SourceKind, owner: String, name: String, language: String, title: String, description: String, should_translate: bool, sensitive_properties: Vec, created_at: String, updated_at: String, last_modified: String) -> Source { + Source { + id, + _kind, + owner, + name, + language, + title, + description, + should_translate, + sensitive_properties, + created_at, + updated_at, + last_modified, + bucket_id: None, + email_transform_tag: None, + email_transform_version: None, + } + } +} + diff --git a/api/src/models/source_1.rs b/api/src/models/source_1.rs new file mode 100644 index 00000000..5bc95b0d --- /dev/null +++ b/api/src/models/source_1.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Source1 { + /// The API name of the source + #[serde(rename = "name")] + pub name: String, + /// The language of the messages in the source + #[serde(rename = "language")] + pub language: models::Language, + #[serde(rename = "bucket_id", skip_serializing_if = "Option::is_none")] + pub bucket_id: Option, + /// Unique ID of the source + #[serde(rename = "id")] + pub id: String, +} + +impl Source1 { + pub fn new(name: String, language: models::Language, id: String) -> Source1 { + Source1 { + name, + language, + bucket_id: None, + id, + } + } +} + diff --git a/api/src/models/source_counts.rs b/api/src/models/source_counts.rs new file mode 100644 index 00000000..fbc8087a --- /dev/null +++ b/api/src/models/source_counts.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SourceCounts { + #[serde(rename = "values")] + pub values: Vec, + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "num_comments")] + pub num_comments: Vec, + #[serde(rename = "num_labels")] + pub num_labels: Vec>, + #[serde(rename = "settings")] + pub settings: Box, + #[serde(rename = "label_property_digest", skip_serializing_if = "Option::is_none")] + pub label_property_digest: Option>, +} + +impl SourceCounts { + pub fn new(values: Vec, labels: Vec, num_comments: Vec, num_labels: Vec>, settings: models::SourceCountsSettings) -> SourceCounts { + SourceCounts { + values, + labels, + num_comments, + num_labels, + settings: Box::new(settings), + label_property_digest: None, + } + } +} + diff --git a/api/src/models/source_counts_settings.rs b/api/src/models/source_counts_settings.rs new file mode 100644 index 00000000..b4c2f999 --- /dev/null +++ b/api/src/models/source_counts_settings.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SourceCountsSettings { + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "values", skip_serializing_if = "Option::is_none")] + pub values: Option>, +} + +impl SourceCountsSettings { + pub fn new() -> SourceCountsSettings { + SourceCountsSettings { + limit: None, + values: None, + } + } +} + diff --git a/api/src/models/source_kind.rs b/api/src/models/source_kind.rs new file mode 100644 index 00000000..ea93fffd --- /dev/null +++ b/api/src/models/source_kind.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// SourceKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum SourceKind { + #[serde(rename = "call")] + Call, + #[serde(rename = "chat")] + Chat, + #[serde(rename = "unknown")] + Unknown, + #[serde(rename = "ixp_design")] + IxpDesign, + #[serde(rename = "ixp_runtime")] + IxpRuntime, + +} + +impl std::fmt::Display for SourceKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Call => write!(f, "call"), + Self::Chat => write!(f, "chat"), + Self::Unknown => write!(f, "unknown"), + Self::IxpDesign => write!(f, "ixp_design"), + Self::IxpRuntime => write!(f, "ixp_runtime"), + } + } +} + +impl Default for SourceKind { + fn default() -> SourceKind { + Self::Call + } +} + diff --git a/api/src/models/source_update.rs b/api/src/models/source_update.rs new file mode 100644 index 00000000..3777d649 --- /dev/null +++ b/api/src/models/source_update.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SourceUpdate { + #[serde(rename = "_kind", skip_serializing_if = "Option::is_none")] + pub _kind: Option, + #[serde(rename = "language", skip_serializing_if = "Option::is_none")] + pub language: Option, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(rename = "should_translate", skip_serializing_if = "Option::is_none")] + pub should_translate: Option, + #[serde(rename = "sensitive_properties", skip_serializing_if = "Option::is_none")] + pub sensitive_properties: Option>, + #[serde(rename = "bucket_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub bucket_id: Option>, + /// A tag for email parsing logic. Changing this will cause a source to re-parse with other logic. + #[serde(rename = "email_transform_tag", skip_serializing_if = "Option::is_none")] + pub email_transform_tag: Option, + /// A version for parsing of this source with corresponding tag. Incrementing this will cause the source to re-parse. + #[serde(rename = "email_transform_version", skip_serializing_if = "Option::is_none")] + pub email_transform_version: Option, +} + +impl SourceUpdate { + pub fn new() -> SourceUpdate { + SourceUpdate { + _kind: None, + language: None, + title: None, + description: None, + should_translate: None, + sensitive_properties: None, + bucket_id: None, + email_transform_tag: None, + email_transform_version: None, + } + } +} + diff --git a/api/src/models/span.rs b/api/src/models/span.rs new file mode 100644 index 00000000..5f8f81cd --- /dev/null +++ b/api/src/models/span.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Span { + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, + #[serde(rename = "char_start")] + pub char_start: i32, + #[serde(rename = "char_end")] + pub char_end: i32, +} + +impl Span { + pub fn new(content_part: models::ContentPart, message_index: i32, utf16_byte_start: i32, utf16_byte_end: i32, char_start: i32, char_end: i32) -> Span { + Span { + content_part, + message_index, + utf16_byte_start, + utf16_byte_end, + char_start, + char_end, + } + } +} + diff --git a/api/src/models/statistics.rs b/api/src/models/statistics.rs new file mode 100644 index 00000000..a906d22d --- /dev/null +++ b/api/src/models/statistics.rs @@ -0,0 +1,69 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Statistics { + #[serde(rename = "thread_mode")] + pub thread_mode: bool, + #[serde(rename = "by_labels")] + pub by_labels: Vec, + #[serde(rename = "by_label_properties")] + pub by_label_properties: Vec, + #[serde(rename = "num_comments")] + pub num_comments: f64, + #[serde(rename = "min_timestamp", deserialize_with = "Option::deserialize")] + pub min_timestamp: Option, + #[serde(rename = "max_timestamp", deserialize_with = "Option::deserialize")] + pub max_timestamp: Option, + #[serde(rename = "label_counts")] + pub label_counts: std::collections::HashMap, + #[serde(rename = "string_user_property_counts")] + pub string_user_property_counts: Vec, + #[serde(rename = "email_property_counts")] + pub email_property_counts: Box, + #[serde(rename = "thread_histogram_counts")] + pub thread_histogram_counts: Box, + #[serde(rename = "source_counts", skip_serializing_if = "Option::is_none")] + pub source_counts: Option>, + #[serde(rename = "label_timeseries", skip_serializing_if = "Option::is_none")] + pub label_timeseries: Option>, + #[serde(rename = "nps_summary", skip_serializing_if = "Option::is_none")] + pub nps_summary: Option>, + #[serde(rename = "label_property_summary", skip_serializing_if = "Option::is_none")] + pub label_property_summary: Option>, + #[serde(rename = "timezone")] + pub timezone: String, +} + +impl Statistics { + pub fn new(thread_mode: bool, by_labels: Vec, by_label_properties: Vec, num_comments: f64, min_timestamp: Option, max_timestamp: Option, label_counts: std::collections::HashMap, string_user_property_counts: Vec, email_property_counts: models::EmailPropertyCountsByProperty, thread_histogram_counts: models::ThreadHistogramCountsByProperty, timezone: String) -> Statistics { + Statistics { + thread_mode, + by_labels, + by_label_properties, + num_comments, + min_timestamp, + max_timestamp, + label_counts, + string_user_property_counts, + email_property_counts: Box::new(email_property_counts), + thread_histogram_counts: Box::new(thread_histogram_counts), + source_counts: None, + label_timeseries: None, + nps_summary: None, + label_property_summary: None, + timezone, + } + } +} + diff --git a/api/src/models/store_bucket_sync_state_request.rs b/api/src/models/store_bucket_sync_state_request.rs new file mode 100644 index 00000000..1620e716 --- /dev/null +++ b/api/src/models/store_bucket_sync_state_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreBucketSyncStateRequest { + #[serde(rename = "bucket_sync_state")] + pub bucket_sync_state: Box, +} + +impl StoreBucketSyncStateRequest { + pub fn new(bucket_sync_state: models::BucketSyncState) -> StoreBucketSyncStateRequest { + StoreBucketSyncStateRequest { + bucket_sync_state: Box::new(bucket_sync_state), + } + } +} + diff --git a/api/src/models/store_bucket_sync_state_response.rs b/api/src/models/store_bucket_sync_state_response.rs new file mode 100644 index 00000000..8e444608 --- /dev/null +++ b/api/src/models/store_bucket_sync_state_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreBucketSyncStateResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl StoreBucketSyncStateResponse { + pub fn new(status: Status) -> StoreBucketSyncStateResponse { + StoreBucketSyncStateResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/store_exception_request.rs b/api/src/models/store_exception_request.rs new file mode 100644 index 00000000..325c94a2 --- /dev/null +++ b/api/src/models/store_exception_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreExceptionRequest { + #[serde(rename = "exceptions")] + pub exceptions: Vec, +} + +impl StoreExceptionRequest { + pub fn new(exceptions: Vec) -> StoreExceptionRequest { + StoreExceptionRequest { + exceptions, + } + } +} + diff --git a/api/src/models/store_exception_response.rs b/api/src/models/store_exception_response.rs new file mode 100644 index 00000000..02ce82a2 --- /dev/null +++ b/api/src/models/store_exception_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreExceptionResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl StoreExceptionResponse { + pub fn new(status: Status) -> StoreExceptionResponse { + StoreExceptionResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/store_keyed_sync_state_request.rs b/api/src/models/store_keyed_sync_state_request.rs new file mode 100644 index 00000000..9244f820 --- /dev/null +++ b/api/src/models/store_keyed_sync_state_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreKeyedSyncStateRequest { + #[serde(rename = "keyed_sync_state")] + pub keyed_sync_state: Box, +} + +impl StoreKeyedSyncStateRequest { + pub fn new(keyed_sync_state: models::KeyedSyncState1) -> StoreKeyedSyncStateRequest { + StoreKeyedSyncStateRequest { + keyed_sync_state: Box::new(keyed_sync_state), + } + } +} + diff --git a/api/src/models/store_keyed_sync_state_response.rs b/api/src/models/store_keyed_sync_state_response.rs new file mode 100644 index 00000000..1505d3c4 --- /dev/null +++ b/api/src/models/store_keyed_sync_state_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StoreKeyedSyncStateResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl StoreKeyedSyncStateResponse { + pub fn new(status: Status) -> StoreKeyedSyncStateResponse { + StoreKeyedSyncStateResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/stream_comment_extractions_result.rs b/api/src/models/stream_comment_extractions_result.rs new file mode 100644 index 00000000..5410a03b --- /dev/null +++ b/api/src/models/stream_comment_extractions_result.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamCommentExtractionsResult { + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "predictions")] + pub predictions: Vec, + #[serde(rename = "sequence_id")] + pub sequence_id: String, +} + +impl StreamCommentExtractionsResult { + pub fn new(comment: models::Comment, predictions: Vec, sequence_id: String) -> StreamCommentExtractionsResult { + StreamCommentExtractionsResult { + comment: Box::new(comment), + predictions, + sequence_id, + } + } +} + diff --git a/api/src/models/stream_comment_prediction.rs b/api/src/models/stream_comment_prediction.rs new file mode 100644 index 00000000..859eb7b1 --- /dev/null +++ b/api/src/models/stream_comment_prediction.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamCommentPrediction { + /// Currently only one taxonomy can be defined per dataset, but for future compatibility search for the taxonomy named `default`. + #[serde(rename = "taxonomies")] + pub taxonomies: Vec, + /// The score predictions for the comment, such as Quality of Service or Tone, when these scores are enabled on the dataset. Scores with a value of 0.0 are omitted. + #[serde(rename = "scores")] + pub scores: Vec, +} + +impl StreamCommentPrediction { + pub fn new(taxonomies: Vec, scores: Vec) -> StreamCommentPrediction { + StreamCommentPrediction { + taxonomies, + scores, + } + } +} + diff --git a/api/src/models/stream_comment_result.rs b/api/src/models/stream_comment_result.rs new file mode 100644 index 00000000..f3f22fa6 --- /dev/null +++ b/api/src/models/stream_comment_result.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamCommentResult { + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "sequence_id")] + pub sequence_id: String, + #[serde(rename = "labels", skip_serializing_if = "Option::is_none")] + pub labels: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>, +} + +impl StreamCommentResult { + pub fn new(comment: models::Comment, sequence_id: String) -> StreamCommentResult { + StreamCommentResult { + comment: Box::new(comment), + sequence_id, + labels: None, + entities: None, + label_properties: None, + } + } +} + diff --git a/api/src/models/stream_confidence.rs b/api/src/models/stream_confidence.rs new file mode 100644 index 00000000..674eeb38 --- /dev/null +++ b/api/src/models/stream_confidence.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamConfidence { + /// A confidence value between 0 and 1. + #[serde(rename = "value")] + pub value: f64, + /// A list of thresholds that have been cleared by this confidence value. There are builtin thresholds (`high_recall`, `high_precision`, `balanced`) as well as user-defined thresholds. Currently, if a threshold is set on a stream, it shows up as threshold `stream` called stream on the `occurence_confidence` of the corresponding label. + #[serde(rename = "thresholds")] + pub thresholds: Vec, +} + +impl StreamConfidence { + pub fn new(value: f64, thresholds: Vec) -> StreamConfidence { + StreamConfidence { + value, + thresholds, + } + } +} + diff --git a/api/src/models/stream_extraction_field_prediction.rs b/api/src/models/stream_extraction_field_prediction.rs new file mode 100644 index 00000000..1a4085dc --- /dev/null +++ b/api/src/models/stream_extraction_field_prediction.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamExtractionFieldPrediction { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "value", deserialize_with = "Option::deserialize")] + pub value: Option>, + /// The text spans in the comment that correspond to this field. + #[serde(rename = "text_spans")] + pub text_spans: Vec, +} + +impl StreamExtractionFieldPrediction { + pub fn new(name: String, value: Option, text_spans: Vec) -> StreamExtractionFieldPrediction { + StreamExtractionFieldPrediction { + name, + value: value.map(Box::new), + text_spans, + } + } +} + diff --git a/api/src/models/stream_field_value.rs b/api/src/models/stream_field_value.rs new file mode 100644 index 00000000..99230b3f --- /dev/null +++ b/api/src/models/stream_field_value.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamFieldValue { + #[serde(rename = "formatted")] + pub formatted: String, +} + +impl StreamFieldValue { + pub fn new(formatted: String) -> StreamFieldValue { + StreamFieldValue { + formatted, + } + } +} + diff --git a/api/src/models/stream_general_field_prediction.rs b/api/src/models/stream_general_field_prediction.rs new file mode 100644 index 00000000..94666202 --- /dev/null +++ b/api/src/models/stream_general_field_prediction.rs @@ -0,0 +1,37 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamGeneralFieldPrediction { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "value", deserialize_with = "Option::deserialize")] + pub value: Option>, + #[serde(rename = "confidence", deserialize_with = "Option::deserialize")] + pub confidence: Option, + /// The text spans in the comment that correspond to this field. + #[serde(rename = "text_spans")] + pub text_spans: Vec, +} + +impl StreamGeneralFieldPrediction { + pub fn new(name: String, value: Option, confidence: Option, text_spans: Vec) -> StreamGeneralFieldPrediction { + StreamGeneralFieldPrediction { + name, + value: value.map(Box::new), + confidence, + text_spans, + } + } +} + diff --git a/api/src/models/stream_label_prediction.rs b/api/src/models/stream_label_prediction.rs new file mode 100644 index 00000000..f3f02c57 --- /dev/null +++ b/api/src/models/stream_label_prediction.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamLabelPrediction { + #[serde(rename = "name")] + pub name: String, + /// The confidence in this label occurrence, independent of the particular predicted field values. + #[serde(rename = "occurrence_confidence")] + pub occurrence_confidence: Box, + /// The confidence that this label occurs with the specific field values in `fields`. Always less than or equal to `occurence_confidence`. + #[serde(rename = "extraction_confidence")] + pub extraction_confidence: Box, + /// The field predictions for this label. All defined label fields will appear in this list---if they're missing in this occurrence, they'll have a null value. + #[serde(rename = "fields")] + pub fields: Vec, +} + +impl StreamLabelPrediction { + pub fn new(name: String, occurrence_confidence: models::StreamConfidence, extraction_confidence: models::StreamConfidence, fields: Vec) -> StreamLabelPrediction { + StreamLabelPrediction { + name, + occurrence_confidence: Box::new(occurrence_confidence), + extraction_confidence: Box::new(extraction_confidence), + fields, + } + } +} + diff --git a/api/src/models/stream_result.rs b/api/src/models/stream_result.rs new file mode 100644 index 00000000..36bf263c --- /dev/null +++ b/api/src/models/stream_result.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamResult { + /// The comment itself---the data WILL reflect changes that have occurred since the data was first uploaded and the time this call was made. + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "prediction", deserialize_with = "Option::deserialize")] + pub prediction: Option>, + /// An opaque token that can be used to advance the trigger past this result. If used, the next results to be returned will exclude all results that precede this one in this list. + #[serde(rename = "continuation")] + pub continuation: String, +} + +impl StreamResult { + pub fn new(comment: models::Comment, prediction: Option, continuation: String) -> StreamResult { + StreamResult { + comment: Box::new(comment), + prediction: prediction.map(Box::new), + continuation, + } + } +} + diff --git a/api/src/models/stream_score_prediction.rs b/api/src/models/stream_score_prediction.rs new file mode 100644 index 00000000..9a0fdab3 --- /dev/null +++ b/api/src/models/stream_score_prediction.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamScorePrediction { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "value")] + pub value: f64, +} + +impl StreamScorePrediction { + pub fn new(name: String, value: f64) -> StreamScorePrediction { + StreamScorePrediction { + name, + value, + } + } +} + diff --git a/api/src/models/stream_taxonomy_prediction.rs b/api/src/models/stream_taxonomy_prediction.rs new file mode 100644 index 00000000..40bdca42 --- /dev/null +++ b/api/src/models/stream_taxonomy_prediction.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamTaxonomyPrediction { + /// For future compatibility only pick the taxonomy named `default`. + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "general_fields")] + pub general_fields: Vec, +} + +impl StreamTaxonomyPrediction { + pub fn new(name: String, labels: Vec, general_fields: Vec) -> StreamTaxonomyPrediction { + StreamTaxonomyPrediction { + name, + labels, + general_fields, + } + } +} + diff --git a/api/src/models/stream_text_span.rs b/api/src/models/stream_text_span.rs new file mode 100644 index 00000000..9b8f1618 --- /dev/null +++ b/api/src/models/stream_text_span.rs @@ -0,0 +1,40 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StreamTextSpan { + /// The part of the comment that contains this span. + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + /// The index of the message in the comment that contains this span. + #[serde(rename = "message_index")] + pub message_index: i32, + /// The start byte index of the span in UTF-16 encoding. + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + /// The end byte index of the span in UTF-16 encoding. + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, +} + +impl StreamTextSpan { + pub fn new(content_part: models::ContentPart, message_index: i32, utf16_byte_start: i32, utf16_byte_end: i32) -> StreamTextSpan { + StreamTextSpan { + content_part, + message_index, + utf16_byte_start, + utf16_byte_end, + } + } +} + diff --git a/api/src/models/string_any_of_filter.rs b/api/src/models/string_any_of_filter.rs new file mode 100644 index 00000000..4fb213f9 --- /dev/null +++ b/api/src/models/string_any_of_filter.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringAnyOfFilter { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "any_of")] + pub any_of: Vec, +} + +impl StringAnyOfFilter { + pub fn new(kind: Kind, any_of: Vec) -> StringAnyOfFilter { + StringAnyOfFilter { + kind, + any_of, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "string_any_of")] + StringAnyOf, +} + +impl Default for Kind { + fn default() -> Kind { + Self::StringAnyOf + } +} + diff --git a/api/src/models/string_array_filter.rs b/api/src/models/string_array_filter.rs new file mode 100644 index 00000000..a15e4671 --- /dev/null +++ b/api/src/models/string_array_filter.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringArrayFilter { + /// A list of string values for which the filter should apply + #[serde(rename = "one_of", skip_serializing_if = "Option::is_none")] + pub one_of: Option>, + /// A list of string values for which the filter should not apply + #[serde(rename = "not_one_of", skip_serializing_if = "Option::is_none")] + pub not_one_of: Option>, + #[serde(rename = "include_missing", skip_serializing_if = "Option::is_none")] + pub include_missing: Option, +} + +impl StringArrayFilter { + pub fn new() -> StringArrayFilter { + StringArrayFilter { + one_of: None, + not_one_of: None, + include_missing: None, + } + } +} + diff --git a/api/src/models/string_none_of_filter.rs b/api/src/models/string_none_of_filter.rs new file mode 100644 index 00000000..0a7849c8 --- /dev/null +++ b/api/src/models/string_none_of_filter.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringNoneOfFilter { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "none_of")] + pub none_of: Vec, +} + +impl StringNoneOfFilter { + pub fn new(kind: Kind, none_of: Vec) -> StringNoneOfFilter { + StringNoneOfFilter { + kind, + none_of, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "string_none_of")] + StringNoneOf, +} + +impl Default for Kind { + fn default() -> Kind { + Self::StringNoneOf + } +} + diff --git a/api/src/models/string_one_of_filter.rs b/api/src/models/string_one_of_filter.rs new file mode 100644 index 00000000..33f2fb72 --- /dev/null +++ b/api/src/models/string_one_of_filter.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringOneOfFilter { + /// A list of string values for which the filter should apply + #[serde(rename = "one_of", skip_serializing_if = "Option::is_none")] + pub one_of: Option>, + /// A list of string values for which the filter should not apply + #[serde(rename = "not_one_of", skip_serializing_if = "Option::is_none")] + pub not_one_of: Option>, + #[serde(rename = "include_missing", skip_serializing_if = "Option::is_none")] + pub include_missing: Option, +} + +impl StringOneOfFilter { + pub fn new() -> StringOneOfFilter { + StringOneOfFilter { + one_of: None, + not_one_of: None, + include_missing: None, + } + } +} + diff --git a/api/src/models/string_search_filter.rs b/api/src/models/string_search_filter.rs new file mode 100644 index 00000000..7d10e519 --- /dev/null +++ b/api/src/models/string_search_filter.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringSearchFilter { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "query")] + pub query: String, +} + +impl StringSearchFilter { + pub fn new(kind: Kind, query: String) -> StringSearchFilter { + StringSearchFilter { + kind, + query, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "string_search")] + StringSearch, +} + +impl Default for Kind { + fn default() -> Kind { + Self::StringSearch + } +} + diff --git a/api/src/models/string_user_property_count.rs b/api/src/models/string_user_property_count.rs new file mode 100644 index 00000000..444bbf4f --- /dev/null +++ b/api/src/models/string_user_property_count.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringUserPropertyCount { + #[serde(rename = "settings")] + pub settings: Box, + #[serde(rename = "values")] + pub values: Vec, + #[serde(rename = "labels")] + pub labels: Vec, + #[serde(rename = "num_comments")] + pub num_comments: Vec, + #[serde(rename = "num_labels")] + pub num_labels: Vec>, +} + +impl StringUserPropertyCount { + pub fn new(settings: models::StringUserPropertyCountsSettings, values: Vec, labels: Vec, num_comments: Vec, num_labels: Vec>) -> StringUserPropertyCount { + StringUserPropertyCount { + settings: Box::new(settings), + values, + labels, + num_comments, + num_labels, + } + } +} + diff --git a/api/src/models/string_user_property_count_single.rs b/api/src/models/string_user_property_count_single.rs new file mode 100644 index 00000000..014bfca0 --- /dev/null +++ b/api/src/models/string_user_property_count_single.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringUserPropertyCountSingle { + #[serde(rename = "value")] + pub value: String, + #[serde(rename = "count")] + pub count: i32, +} + +impl StringUserPropertyCountSingle { + pub fn new(value: String, count: i32) -> StringUserPropertyCountSingle { + StringUserPropertyCountSingle { + value, + count, + } + } +} + diff --git a/api/src/models/string_user_property_counts_settings.rs b/api/src/models/string_user_property_counts_settings.rs new file mode 100644 index 00000000..16625529 --- /dev/null +++ b/api/src/models/string_user_property_counts_settings.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringUserPropertyCountsSettings { + #[serde(rename = "group_by")] + pub group_by: String, + #[serde(rename = "limit", skip_serializing_if = "Option::is_none")] + pub limit: Option, + #[serde(rename = "values", skip_serializing_if = "Option::is_none")] + pub values: Option>, +} + +impl StringUserPropertyCountsSettings { + pub fn new(group_by: String) -> StringUserPropertyCountsSettings { + StringUserPropertyCountsSettings { + group_by, + limit: None, + values: None, + } + } +} + diff --git a/api/src/models/string_user_property_summary.rs b/api/src/models/string_user_property_summary.rs new file mode 100644 index 00000000..f4333134 --- /dev/null +++ b/api/src/models/string_user_property_summary.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct StringUserPropertySummary { + #[serde(rename = "full_name")] + pub full_name: String, + #[serde(rename = "count")] + pub count: i32, + #[serde(rename = "cardinality")] + pub cardinality: i32, + #[serde(rename = "values")] + pub values: Vec, +} + +impl StringUserPropertySummary { + pub fn new(full_name: String, count: i32, cardinality: i32, values: Vec) -> StringUserPropertySummary { + StringUserPropertySummary { + full_name, + count, + cardinality, + values, + } + } +} + diff --git a/api/src/models/suggest_taxonomy_request.rs b/api/src/models/suggest_taxonomy_request.rs new file mode 100644 index 00000000..a7bff588 --- /dev/null +++ b/api/src/models/suggest_taxonomy_request.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SuggestTaxonomyRequest { + /// Description of what the user wants to extract. + #[serde(rename = "description")] + pub description: String, + /// Attachment references for example uploaded documents. + #[serde(rename = "documents")] + pub documents: Vec, +} + +impl SuggestTaxonomyRequest { + pub fn new(description: String, documents: Vec) -> SuggestTaxonomyRequest { + SuggestTaxonomyRequest { + description, + documents, + } + } +} + diff --git a/api/src/models/suggest_taxonomy_response.rs b/api/src/models/suggest_taxonomy_response.rs new file mode 100644 index 00000000..4d32c773 --- /dev/null +++ b/api/src/models/suggest_taxonomy_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SuggestTaxonomyResponse { + #[serde(rename = "status")] + pub status: Status, + /// Taxonomy suggested for the example documents. + #[serde(rename = "taxonomy")] + pub taxonomy: Box, +} + +impl SuggestTaxonomyResponse { + pub fn new(status: Status, taxonomy: models::SuggestedTaxonomy) -> SuggestTaxonomyResponse { + SuggestTaxonomyResponse { + status, + taxonomy: Box::new(taxonomy), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/suggested_label.rs b/api/src/models/suggested_label.rs new file mode 100644 index 00000000..60d4adc4 --- /dev/null +++ b/api/src/models/suggested_label.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SuggestedLabel { + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "sentiment")] + pub sentiment: models::LabelSentiment, + /// The instructions of the suggested label, if available. + #[serde(rename = "instructions", skip_serializing_if = "Option::is_none")] + pub instructions: Option, +} + +impl SuggestedLabel { + pub fn new(name: String, sentiment: models::LabelSentiment) -> SuggestedLabel { + SuggestedLabel { + name, + sentiment, + instructions: None, + } + } +} + diff --git a/api/src/models/suggested_taxonomy.rs b/api/src/models/suggested_taxonomy.rs new file mode 100644 index 00000000..2c73f5a7 --- /dev/null +++ b/api/src/models/suggested_taxonomy.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SuggestedTaxonomy { + /// Taxonomy Field Types. + #[serde(rename = "field_types")] + pub field_types: Vec, + /// Label group containing Field Groups and Fields. + #[serde(rename = "label_group")] + pub label_group: Box, +} + +impl SuggestedTaxonomy { + pub fn new(field_types: Vec, label_group: models::LabelGroup) -> SuggestedTaxonomy { + SuggestedTaxonomy { + field_types, + label_group: Box::new(label_group), + } + } +} + diff --git a/api/src/models/sync_annotations_request.rs b/api/src/models/sync_annotations_request.rs new file mode 100644 index 00000000..f5b24f76 --- /dev/null +++ b/api/src/models/sync_annotations_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncAnnotationsRequest { + #[serde(rename = "annotations")] + pub annotations: Vec, +} + +impl SyncAnnotationsRequest { + pub fn new(annotations: Vec) -> SyncAnnotationsRequest { + SyncAnnotationsRequest { + annotations, + } + } +} + diff --git a/api/src/models/sync_annotations_response.rs b/api/src/models/sync_annotations_response.rs new file mode 100644 index 00000000..b1617fa6 --- /dev/null +++ b/api/src/models/sync_annotations_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncAnnotationsResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl SyncAnnotationsResponse { + pub fn new(status: Status) -> SyncAnnotationsResponse { + SyncAnnotationsResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sync_comments_from_csv_response.rs b/api/src/models/sync_comments_from_csv_response.rs new file mode 100644 index 00000000..62d62943 --- /dev/null +++ b/api/src/models/sync_comments_from_csv_response.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncCommentsFromCsvResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "updated")] + pub updated: i32, + #[serde(rename = "updated_properties_only")] + pub updated_properties_only: i32, + #[serde(rename = "updated_text_changed")] + pub updated_text_changed: i32, + #[serde(rename = "unchanged")] + pub unchanged: i32, + #[serde(rename = "new")] + pub new: i32, +} + +impl SyncCommentsFromCsvResponse { + pub fn new(status: Status, updated: i32, updated_properties_only: i32, updated_text_changed: i32, unchanged: i32, new: i32) -> SyncCommentsFromCsvResponse { + SyncCommentsFromCsvResponse { + status, + updated, + updated_properties_only, + updated_text_changed, + unchanged, + new, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sync_comments_request.rs b/api/src/models/sync_comments_request.rs new file mode 100644 index 00000000..ad25caca --- /dev/null +++ b/api/src/models/sync_comments_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncCommentsRequest { + #[serde(rename = "comments")] + pub comments: Vec, +} + +impl SyncCommentsRequest { + pub fn new(comments: Vec) -> SyncCommentsRequest { + SyncCommentsRequest { + comments, + } + } +} + diff --git a/api/src/models/sync_comments_response.rs b/api/src/models/sync_comments_response.rs new file mode 100644 index 00000000..63bc6dd1 --- /dev/null +++ b/api/src/models/sync_comments_response.rs @@ -0,0 +1,53 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncCommentsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "updated")] + pub updated: i32, + #[serde(rename = "updated_properties_only")] + pub updated_properties_only: i32, + #[serde(rename = "updated_text_changed")] + pub updated_text_changed: i32, + #[serde(rename = "unchanged")] + pub unchanged: i32, + #[serde(rename = "new")] + pub new: i32, +} + +impl SyncCommentsResponse { + pub fn new(status: Status, updated: i32, updated_properties_only: i32, updated_text_changed: i32, unchanged: i32, new: i32) -> SyncCommentsResponse { + SyncCommentsResponse { + status, + updated, + updated_properties_only, + updated_text_changed, + unchanged, + new, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sync_raw_emails_request.rs b/api/src/models/sync_raw_emails_request.rs new file mode 100644 index 00000000..f2d4ae95 --- /dev/null +++ b/api/src/models/sync_raw_emails_request.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncRawEmailsRequest { + /// A batch of at most 4096 raw emails + #[serde(rename = "documents")] + pub documents: Vec, + /// If set to true, the comments parsed from the emailswill be returned in the response body + #[serde(rename = "include_comments", skip_serializing_if = "Option::is_none")] + pub include_comments: Option, + /// A tag identifying the email integration sending the data. You should have received this tag during integration configuration setup. + #[serde(rename = "transform_tag", skip_serializing_if = "Option::is_none")] + pub transform_tag: Option, + #[serde(rename = "override_user_properties", skip_serializing_if = "Option::is_none")] + pub override_user_properties: Option>, +} + +impl SyncRawEmailsRequest { + pub fn new(documents: Vec) -> SyncRawEmailsRequest { + SyncRawEmailsRequest { + documents, + include_comments: None, + transform_tag: None, + override_user_properties: None, + } + } +} + diff --git a/api/src/models/sync_raw_emails_response.rs b/api/src/models/sync_raw_emails_response.rs new file mode 100644 index 00000000..5f7befe0 --- /dev/null +++ b/api/src/models/sync_raw_emails_response.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct SyncRawEmailsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "updated")] + pub updated: i32, + #[serde(rename = "updated_properties_only")] + pub updated_properties_only: i32, + #[serde(rename = "updated_text_changed")] + pub updated_text_changed: i32, + #[serde(rename = "unchanged")] + pub unchanged: i32, + #[serde(rename = "new")] + pub new: i32, + #[serde(rename = "comments", skip_serializing_if = "Option::is_none")] + pub comments: Option>, +} + +impl SyncRawEmailsResponse { + pub fn new(status: Status, updated: i32, updated_properties_only: i32, updated_text_changed: i32, unchanged: i32, new: i32) -> SyncRawEmailsResponse { + SyncRawEmailsResponse { + status, + updated, + updated_properties_only, + updated_text_changed, + unchanged, + new, + comments: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/sync_status.rs b/api/src/models/sync_status.rs new file mode 100644 index 00000000..ccb8f9c9 --- /dev/null +++ b/api/src/models/sync_status.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// SyncStatus : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum SyncStatus { + #[serde(rename = "IN_PROGRESS")] + InProgress, + #[serde(rename = "UP_TO_DATE")] + UpToDate, + +} + +impl std::fmt::Display for SyncStatus { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::InProgress => write!(f, "IN_PROGRESS"), + Self::UpToDate => write!(f, "UP_TO_DATE"), + } + } +} + +impl Default for SyncStatus { + fn default() -> SyncStatus { + Self::InProgress + } +} + diff --git a/api/src/models/tagged_ixp_model_version.rs b/api/src/models/tagged_ixp_model_version.rs new file mode 100644 index 00000000..92fb4a15 --- /dev/null +++ b/api/src/models/tagged_ixp_model_version.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TaggedIxpModelVersion { + #[serde(rename = "tag_name")] + pub tag_name: String, + #[serde(rename = "version")] + pub version: i32, + #[serde(rename = "updated_at", deserialize_with = "Option::deserialize")] + pub updated_at: Option, +} + +impl TaggedIxpModelVersion { + pub fn new(tag_name: String, version: i32, updated_at: Option) -> TaggedIxpModelVersion { + TaggedIxpModelVersion { + tag_name, + version, + updated_at, + } + } +} + diff --git a/api/src/models/tagged_user_model_version.rs b/api/src/models/tagged_user_model_version.rs new file mode 100644 index 00000000..70f14eed --- /dev/null +++ b/api/src/models/tagged_user_model_version.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TaggedUserModelVersion { + #[serde(rename = "name")] + pub name: models::TaggedUserModelVersionName, + #[serde(rename = "version")] + pub version: i32, + #[serde(rename = "updated_at")] + pub updated_at: String, +} + +impl TaggedUserModelVersion { + pub fn new(name: models::TaggedUserModelVersionName, version: i32, updated_at: String) -> TaggedUserModelVersion { + TaggedUserModelVersion { + name, + version, + updated_at, + } + } +} + diff --git a/api/src/models/tagged_user_model_version_name.rs b/api/src/models/tagged_user_model_version_name.rs new file mode 100644 index 00000000..93a02952 --- /dev/null +++ b/api/src/models/tagged_user_model_version_name.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TaggedUserModelVersionName : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TaggedUserModelVersionName { + #[serde(rename = "staging")] + Staging, + #[serde(rename = "live")] + Live, + +} + +impl std::fmt::Display for TaggedUserModelVersionName { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Staging => write!(f, "staging"), + Self::Live => write!(f, "live"), + } + } +} + +impl Default for TaggedUserModelVersionName { + fn default() -> TaggedUserModelVersionName { + Self::Staging + } +} + diff --git a/api/src/models/tagged_user_model_version_update.rs b/api/src/models/tagged_user_model_version_update.rs new file mode 100644 index 00000000..a32bd89a --- /dev/null +++ b/api/src/models/tagged_user_model_version_update.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TaggedUserModelVersionUpdate { + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "version")] + pub version: i32, + #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")] + pub updated_at: Option, +} + +impl TaggedUserModelVersionUpdate { + pub fn new(version: i32) -> TaggedUserModelVersionUpdate { + TaggedUserModelVersionUpdate { + name: None, + version, + updated_at: None, + } + } +} + diff --git a/api/src/models/taxonomy_extraction_private.rs b/api/src/models/taxonomy_extraction_private.rs new file mode 100644 index 00000000..29af06ef --- /dev/null +++ b/api/src/models/taxonomy_extraction_private.rs @@ -0,0 +1,50 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TaxonomyExtractionPrivate { + #[serde(rename = "name")] + pub name: Name, + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option, + #[serde(rename = "field_groups")] + pub field_groups: Vec, + #[serde(rename = "draft_field_groups", skip_serializing_if = "Option::is_none")] + pub draft_field_groups: Option>, + #[serde(rename = "model_errors")] + pub model_errors: Vec, +} + +impl TaxonomyExtractionPrivate { + pub fn new(name: Name, field_groups: Vec, model_errors: Vec) -> TaxonomyExtractionPrivate { + TaxonomyExtractionPrivate { + name, + id: None, + field_groups, + draft_field_groups: None, + model_errors, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Name { + #[serde(rename = "default")] + Default, +} + +impl Default for Name { + fn default() -> Name { + Self::Default + } +} + diff --git a/api/src/models/tenant.rs b/api/src/models/tenant.rs new file mode 100644 index 00000000..d8e74d10 --- /dev/null +++ b/api/src/models/tenant.rs @@ -0,0 +1,52 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Tenant { + #[serde(rename = "tenant_id")] + pub tenant_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "description")] + pub description: String, + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "updated_at")] + pub updated_at: String, + #[serde(rename = "flags")] + pub flags: Vec, + #[serde(rename = "uipath_context", deserialize_with = "Option::deserialize")] + pub uipath_context: Option>, + /// Support ID/Licence Code that links user with UiPath support + #[serde(rename = "uipath_support_id", deserialize_with = "Option::deserialize")] + pub uipath_support_id: Option, +} + +impl Tenant { + pub fn new(tenant_id: String, name: String, title: String, description: String, created_at: String, updated_at: String, flags: Vec, uipath_context: Option, uipath_support_id: Option) -> Tenant { + Tenant { + tenant_id, + name, + title, + description, + created_at, + updated_at, + flags, + uipath_context: uipath_context.map(Box::new), + uipath_support_id, + } + } +} + diff --git a/api/src/models/tenant_new.rs b/api/src/models/tenant_new.rs new file mode 100644 index 00000000..f4a2fc18 --- /dev/null +++ b/api/src/models/tenant_new.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TenantNew { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Associate this tenant with a UiPath tenant. + #[serde(rename = "uipath_context", skip_serializing_if = "Option::is_none")] + pub uipath_context: Option>, + /// Support ID/Licence Code that links user with UiPath support + #[serde(rename = "uipath_support_id", skip_serializing_if = "Option::is_none")] + pub uipath_support_id: Option, +} + +impl TenantNew { + pub fn new() -> TenantNew { + TenantNew { + title: None, + description: None, + uipath_context: None, + uipath_support_id: None, + } + } +} + diff --git a/api/src/models/tenant_update.rs b/api/src/models/tenant_update.rs new file mode 100644 index 00000000..729fcd06 --- /dev/null +++ b/api/src/models/tenant_update.rs @@ -0,0 +1,34 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TenantUpdate { + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + /// Support ID/Licence Code that links user with UiPath support + #[serde(rename = "uipath_support_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub uipath_support_id: Option>, +} + +impl TenantUpdate { + pub fn new() -> TenantUpdate { + TenantUpdate { + title: None, + description: None, + uipath_support_id: None, + } + } +} + diff --git a/api/src/models/text_config.rs b/api/src/models/text_config.rs new file mode 100644 index 00000000..67d3b76b --- /dev/null +++ b/api/src/models/text_config.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TextConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl TextConfig { + pub fn new() -> TextConfig { + TextConfig { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "uipath_cv_table_only")] + UipathCvTableOnly, +} + +impl Default for Kind { + fn default() -> Kind { + Self::UipathCvTableOnly + } +} + diff --git a/api/src/models/text_field_data_private.rs b/api/src/models/text_field_data_private.rs new file mode 100644 index 00000000..b69ef8e9 --- /dev/null +++ b/api/src/models/text_field_data_private.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TextFieldDataPrivate { + #[serde(rename = "kind")] + pub kind: Kind, +} + +impl TextFieldDataPrivate { + pub fn new(kind: Kind) -> TextFieldDataPrivate { + TextFieldDataPrivate { + kind, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "text")] + Text, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Text + } +} + diff --git a/api/src/models/text_field_data_type.rs b/api/src/models/text_field_data_type.rs new file mode 100644 index 00000000..dcb73934 --- /dev/null +++ b/api/src/models/text_field_data_type.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TextFieldDataType { + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "flags")] + pub flags: Vec, +} + +impl TextFieldDataType { + pub fn new(kind: Kind, flags: Vec) -> TextFieldDataType { + TextFieldDataType { + kind, + flags, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "text")] + Text, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Text + } +} + diff --git a/api/src/models/text_field_flag.rs b/api/src/models/text_field_flag.rs new file mode 100644 index 00000000..60b6f06c --- /dev/null +++ b/api/src/models/text_field_flag.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TextFieldFlag : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TextFieldFlag { + #[serde(rename = "appears_verbatim")] + AppearsVerbatim, + +} + +impl std::fmt::Display for TextFieldFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::AppearsVerbatim => write!(f, "appears_verbatim"), + } + } +} + +impl Default for TextFieldFlag { + fn default() -> TextFieldFlag { + Self::AppearsVerbatim + } +} + diff --git a/api/src/models/text_format.rs b/api/src/models/text_format.rs new file mode 100644 index 00000000..c0ef6716 --- /dev/null +++ b/api/src/models/text_format.rs @@ -0,0 +1,28 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Make Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use serde::{Deserialize, Serialize}; + +/// TextFormat - Fixed version that correctly defines TextFormat as an enum. +/// The generated version incorrectly created an empty struct, +/// but the OpenAPI spec defines it as an enum with "markdown" and "plain" values. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TextFormat { + #[serde(rename = "markdown")] + Markdown, + #[serde(rename = "plain")] + Plain, +} + +impl Default for TextFormat { + fn default() -> TextFormat { + Self::Plain + } +} diff --git a/api/src/models/text_image_input_config.rs b/api/src/models/text_image_input_config.rs new file mode 100644 index 00000000..16c27975 --- /dev/null +++ b/api/src/models/text_image_input_config.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TextImageInputConfig { + #[serde(rename = "mode", skip_serializing_if = "Option::is_none")] + pub mode: Option, + #[serde(rename = "text_config")] + pub text_config: Box, +} + +impl TextImageInputConfig { + pub fn new(text_config: models::TextConfig) -> TextImageInputConfig { + TextImageInputConfig { + mode: None, + text_config: Box::new(text_config), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Mode { + #[serde(rename = "text_plus_image")] + TextPlusImage, +} + +impl Default for Mode { + fn default() -> Mode { + Self::TextPlusImage + } +} + diff --git a/api/src/models/text_span.rs b/api/src/models/text_span.rs new file mode 100644 index 00000000..c1d1f8bc --- /dev/null +++ b/api/src/models/text_span.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TextSpan : Definition of a text span that is returned +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TextSpan { + #[serde(rename = "content_part")] + pub content_part: models::ContentPart, + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "utf16_byte_start")] + pub utf16_byte_start: i32, + #[serde(rename = "utf16_byte_end")] + pub utf16_byte_end: i32, + #[serde(rename = "char_start")] + pub char_start: i32, + #[serde(rename = "char_end")] + pub char_end: i32, +} + +impl TextSpan { + /// Definition of a text span that is returned + pub fn new(content_part: models::ContentPart, message_index: i32, utf16_byte_start: i32, utf16_byte_end: i32, char_start: i32, char_end: i32) -> TextSpan { + TextSpan { + content_part, + message_index, + utf16_byte_start, + utf16_byte_end, + char_start, + char_end, + } + } +} + diff --git a/api/src/models/theme.rs b/api/src/models/theme.rs new file mode 100644 index 00000000..ccc1916f --- /dev/null +++ b/api/src/models/theme.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Theme { + #[serde(rename = "theme_comments")] + pub theme_comments: Vec, + /// Populated if LLM features are enabled. These label names suggested by the LLM for the theme. + #[serde(rename = "suggested_labels")] + pub suggested_labels: Vec, + /// Populated if LLM features are enabled. The reasoning behind the suggested labels. + #[serde(rename = "suggested_labels_reasoning", skip_serializing_if = "Option::is_none")] + pub suggested_labels_reasoning: Option>, +} + +impl Theme { + pub fn new(theme_comments: Vec, suggested_labels: Vec) -> Theme { + Theme { + theme_comments, + suggested_labels, + suggested_labels_reasoning: None, + } + } +} + diff --git a/api/src/models/theme_comment.rs b/api/src/models/theme_comment.rs new file mode 100644 index 00000000..54dd7bc9 --- /dev/null +++ b/api/src/models/theme_comment.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThemeComment { + /// The Communications Mining identifier for a comment (opposed the an external ID for a verbatim in the client system) + #[serde(rename = "comment_uid")] + pub comment_uid: String, + /// Text spans for importance to the cluster and where in the verbatim these spans are located. N.B. Asthere is only one interpretation per verbatim there cannot be importance spans on both subject & body. + #[serde(rename = "interpretation", skip_serializing_if = "Option::is_none")] + pub interpretation: Option>, +} + +impl ThemeComment { + pub fn new(comment_uid: String) -> ThemeComment { + ThemeComment { + comment_uid, + interpretation: None, + } + } +} + diff --git a/api/src/models/theme_comment_interpretation.rs b/api/src/models/theme_comment_interpretation.rs new file mode 100644 index 00000000..316a47d8 --- /dev/null +++ b/api/src/models/theme_comment_interpretation.rs @@ -0,0 +1,49 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThemeCommentInterpretation { + #[serde(rename = "content_part")] + pub content_part: ContentPart, + /// A legacy field, which dictates message in a multiple message verbatim the spans are upon + #[serde(rename = "message_index")] + pub message_index: i32, + #[serde(rename = "spans")] + pub spans: Vec, +} + +impl ThemeCommentInterpretation { + pub fn new(content_part: ContentPart, message_index: i32, spans: Vec) -> ThemeCommentInterpretation { + ThemeCommentInterpretation { + content_part, + message_index, + spans, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ContentPart { + #[serde(rename = "subject")] + Subject, + #[serde(rename = "body")] + Body, + #[serde(rename = "signature")] + Signature, +} + +impl Default for ContentPart { + fn default() -> ContentPart { + Self::Subject + } +} + diff --git a/api/src/models/theme_set.rs b/api/src/models/theme_set.rs new file mode 100644 index 00000000..cdb3f9cb --- /dev/null +++ b/api/src/models/theme_set.rs @@ -0,0 +1,31 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThemeSet { + #[serde(rename = "trained_time")] + pub trained_time: String, + /// Groups/clusters of comment ids which share a common meaning/theme + #[serde(rename = "themes", skip_serializing_if = "Option::is_none")] + pub themes: Option>, +} + +impl ThemeSet { + pub fn new(trained_time: String) -> ThemeSet { + ThemeSet { + trained_time, + themes: None, + } + } +} + diff --git a/api/src/models/thread_histogram_binning_custom.rs b/api/src/models/thread_histogram_binning_custom.rs new file mode 100644 index 00000000..41f7a96b --- /dev/null +++ b/api/src/models/thread_histogram_binning_custom.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningCustom { + #[serde(rename = "points")] + pub points: Vec, + #[serde(rename = "negative_infinity")] + pub negative_infinity: bool, + #[serde(rename = "positive_infinity")] + pub positive_infinity: bool, +} + +impl ThreadHistogramBinningCustom { + pub fn new(points: Vec, negative_infinity: bool, positive_infinity: bool) -> ThreadHistogramBinningCustom { + ThreadHistogramBinningCustom { + points, + negative_infinity, + positive_infinity, + } + } +} + diff --git a/api/src/models/thread_histogram_binning_fixed.rs b/api/src/models/thread_histogram_binning_fixed.rs new file mode 100644 index 00000000..a61a60ea --- /dev/null +++ b/api/src/models/thread_histogram_binning_fixed.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningFixed { + #[serde(rename = "interval")] + pub interval: i32, + #[serde(rename = "offset")] + pub offset: i32, +} + +impl ThreadHistogramBinningFixed { + pub fn new(interval: i32, offset: i32) -> ThreadHistogramBinningFixed { + ThreadHistogramBinningFixed { + interval, + offset, + } + } +} + diff --git a/api/src/models/thread_histogram_binning_variable.rs b/api/src/models/thread_histogram_binning_variable.rs new file mode 100644 index 00000000..e0f7e56a --- /dev/null +++ b/api/src/models/thread_histogram_binning_variable.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramBinningVariable { + #[serde(rename = "max_bins")] + pub max_bins: i32, +} + +impl ThreadHistogramBinningVariable { + pub fn new(max_bins: i32) -> ThreadHistogramBinningVariable { + ThreadHistogramBinningVariable { + max_bins, + } + } +} + diff --git a/api/src/models/thread_histogram_counts.rs b/api/src/models/thread_histogram_counts.rs new file mode 100644 index 00000000..8ab3a6d1 --- /dev/null +++ b/api/src/models/thread_histogram_counts.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramCounts { + #[serde(rename = "bins")] + pub bins: Vec, + #[serde(rename = "labels")] + pub labels: Vec, +} + +impl ThreadHistogramCounts { + pub fn new(bins: Vec, labels: Vec) -> ThreadHistogramCounts { + ThreadHistogramCounts { + bins, + labels, + } + } +} + diff --git a/api/src/models/thread_histogram_counts_by_property.rs b/api/src/models/thread_histogram_counts_by_property.rs new file mode 100644 index 00000000..07992f75 --- /dev/null +++ b/api/src/models/thread_histogram_counts_by_property.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramCountsByProperty { + #[serde(rename = "duration", skip_serializing_if = "Option::is_none")] + pub duration: Option>, + #[serde(rename = "num_messages", skip_serializing_if = "Option::is_none")] + pub num_messages: Option>, + #[serde(rename = "num_participants", skip_serializing_if = "Option::is_none")] + pub num_participants: Option>, + #[serde(rename = "response_time", skip_serializing_if = "Option::is_none")] + pub response_time: Option>, +} + +impl ThreadHistogramCountsByProperty { + pub fn new() -> ThreadHistogramCountsByProperty { + ThreadHistogramCountsByProperty { + duration: None, + num_messages: None, + num_participants: None, + response_time: None, + } + } +} + diff --git a/api/src/models/thread_histogram_settings.rs b/api/src/models/thread_histogram_settings.rs new file mode 100644 index 00000000..87c4787c --- /dev/null +++ b/api/src/models/thread_histogram_settings.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramSettings { + #[serde(rename = "binning")] + pub binning: Box, +} + +impl ThreadHistogramSettings { + pub fn new(binning: models::Binning) -> ThreadHistogramSettings { + ThreadHistogramSettings { + binning: Box::new(binning), + } + } +} + diff --git a/api/src/models/thread_histogram_settings_by_property.rs b/api/src/models/thread_histogram_settings_by_property.rs new file mode 100644 index 00000000..baa2de9a --- /dev/null +++ b/api/src/models/thread_histogram_settings_by_property.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadHistogramSettingsByProperty { + #[serde(rename = "duration", skip_serializing_if = "Option::is_none")] + pub duration: Option>, + #[serde(rename = "num_messages", skip_serializing_if = "Option::is_none")] + pub num_messages: Option>, + #[serde(rename = "num_participants", skip_serializing_if = "Option::is_none")] + pub num_participants: Option>, + #[serde(rename = "response_time", skip_serializing_if = "Option::is_none")] + pub response_time: Option>, +} + +impl ThreadHistogramSettingsByProperty { + pub fn new() -> ThreadHistogramSettingsByProperty { + ThreadHistogramSettingsByProperty { + duration: None, + num_messages: None, + num_participants: None, + response_time: None, + } + } +} + diff --git a/api/src/models/thread_properties.rs b/api/src/models/thread_properties.rs new file mode 100644 index 00000000..1411262a --- /dev/null +++ b/api/src/models/thread_properties.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadProperties { + #[serde(rename = "duration", deserialize_with = "Option::deserialize")] + pub duration: Option, + #[serde(rename = "response_time", deserialize_with = "Option::deserialize")] + pub response_time: Option, + #[serde(rename = "num_messages")] + pub num_messages: i32, + #[serde(rename = "num_participants")] + pub num_participants: i32, + #[serde(rename = "first_sender", deserialize_with = "Option::deserialize")] + pub first_sender: Option, + #[serde(rename = "thread_position", skip_serializing_if = "Option::is_none")] + pub thread_position: Option, +} + +impl ThreadProperties { + pub fn new(duration: Option, response_time: Option, num_messages: i32, num_participants: i32, first_sender: Option) -> ThreadProperties { + ThreadProperties { + duration, + response_time, + num_messages, + num_participants, + first_sender, + thread_position: None, + } + } +} + diff --git a/api/src/models/thread_property_filter.rs b/api/src/models/thread_property_filter.rs new file mode 100644 index 00000000..b5306b04 --- /dev/null +++ b/api/src/models/thread_property_filter.rs @@ -0,0 +1,54 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadPropertyFilter { + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub id: Option>, + #[serde(rename = "thread_position", skip_serializing_if = "Option::is_none")] + pub thread_position: Option>, + #[serde(rename = "num_messages", skip_serializing_if = "Option::is_none")] + pub num_messages: Option>, + #[serde(rename = "num_participants", skip_serializing_if = "Option::is_none")] + pub num_participants: Option>, + #[serde(rename = "duration", skip_serializing_if = "Option::is_none")] + pub duration: Option>, + #[serde(rename = "response_time", skip_serializing_if = "Option::is_none")] + pub response_time: Option>, + #[serde(rename = "all_senders", skip_serializing_if = "Option::is_none")] + pub all_senders: Option>, + #[serde(rename = "all_recipients", skip_serializing_if = "Option::is_none")] + pub all_recipients: Option>, + #[serde(rename = "first_sender", skip_serializing_if = "Option::is_none")] + pub first_sender: Option>, + #[serde(rename = "first_recipients", skip_serializing_if = "Option::is_none")] + pub first_recipients: Option>, +} + +impl ThreadPropertyFilter { + pub fn new() -> ThreadPropertyFilter { + ThreadPropertyFilter { + id: None, + thread_position: None, + num_messages: None, + num_participants: None, + duration: None, + response_time: None, + all_senders: None, + all_recipients: None, + first_sender: None, + first_recipients: None, + } + } +} + diff --git a/api/src/models/thread_theme.rs b/api/src/models/thread_theme.rs new file mode 100644 index 00000000..dc9935a2 --- /dev/null +++ b/api/src/models/thread_theme.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ThreadTheme { + #[serde(rename = "description")] + pub description: String, + #[serde(rename = "comment_indices")] + pub comment_indices: Vec, +} + +impl ThreadTheme { + pub fn new(description: String, comment_indices: Vec) -> ThreadTheme { + ThreadTheme { + description, + comment_indices, + } + } +} + diff --git a/api/src/models/threshold.rs b/api/src/models/threshold.rs new file mode 100644 index 00000000..18593f4a --- /dev/null +++ b/api/src/models/threshold.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Threshold { +} + +impl Threshold { + pub fn new() -> Threshold { + Threshold { + } + } +} + diff --git a/api/src/models/threshold_1.rs b/api/src/models/threshold_1.rs new file mode 100644 index 00000000..716a24c1 --- /dev/null +++ b/api/src/models/threshold_1.rs @@ -0,0 +1,24 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Threshold1 { +} + +impl Threshold1 { + pub fn new() -> Threshold1 { + Threshold1 { + } + } +} + diff --git a/api/src/models/threshold_enum.rs b/api/src/models/threshold_enum.rs new file mode 100644 index 00000000..0cbc563a --- /dev/null +++ b/api/src/models/threshold_enum.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// ThresholdEnum : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum ThresholdEnum { + #[serde(rename = "auto")] + Auto, + +} + +impl std::fmt::Display for ThresholdEnum { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Auto => write!(f, "auto"), + } + } +} + +impl Default for ThresholdEnum { + fn default() -> ThresholdEnum { + Self::Auto + } +} + diff --git a/api/src/models/time_period_comparison.rs b/api/src/models/time_period_comparison.rs new file mode 100644 index 00000000..e1e48055 --- /dev/null +++ b/api/src/models/time_period_comparison.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TimePeriodComparison : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TimePeriodComparison { + #[serde(rename = "previous")] + Previous, + #[serde(rename = "same_in_previous_year")] + SameInPreviousYear, + #[serde(rename = "vs_long_running_average")] + VsLongRunningAverage, + +} + +impl std::fmt::Display for TimePeriodComparison { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Previous => write!(f, "previous"), + Self::SameInPreviousYear => write!(f, "same_in_previous_year"), + Self::VsLongRunningAverage => write!(f, "vs_long_running_average"), + } + } +} + +impl Default for TimePeriodComparison { + fn default() -> TimePeriodComparison { + Self::Previous + } +} + diff --git a/api/src/models/time_resolution.rs b/api/src/models/time_resolution.rs new file mode 100644 index 00000000..0062a20e --- /dev/null +++ b/api/src/models/time_resolution.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TimeResolution : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TimeResolution { + #[serde(rename = "day")] + Day, + #[serde(rename = "week")] + Week, + #[serde(rename = "month")] + Month, + #[serde(rename = "year")] + Year, + +} + +impl std::fmt::Display for TimeResolution { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Day => write!(f, "day"), + Self::Week => write!(f, "week"), + Self::Month => write!(f, "month"), + Self::Year => write!(f, "year"), + } + } +} + +impl Default for TimeResolution { + fn default() -> TimeResolution { + Self::Day + } +} + diff --git a/api/src/models/timestamp_range_filter.rs b/api/src/models/timestamp_range_filter.rs new file mode 100644 index 00000000..caff4c5b --- /dev/null +++ b/api/src/models/timestamp_range_filter.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TimestampRangeFilter { + #[serde(rename = "minimum", skip_serializing_if = "Option::is_none")] + pub minimum: Option, + #[serde(rename = "maximum", skip_serializing_if = "Option::is_none")] + pub maximum: Option, +} + +impl TimestampRangeFilter { + pub fn new() -> TimestampRangeFilter { + TimestampRangeFilter { + minimum: None, + maximum: None, + } + } +} + diff --git a/api/src/models/train_view.rs b/api/src/models/train_view.rs new file mode 100644 index 00000000..fe183a6d --- /dev/null +++ b/api/src/models/train_view.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TrainView : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TrainView { + #[serde(rename = "discover")] + Discover, + #[serde(rename = "explore")] + Explore, + #[serde(rename = "train_single")] + TrainSingle, + #[serde(rename = "train_multiple")] + TrainMultiple, + +} + +impl std::fmt::Display for TrainView { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Discover => write!(f, "discover"), + Self::Explore => write!(f, "explore"), + Self::TrainSingle => write!(f, "train_single"), + Self::TrainMultiple => write!(f, "train_multiple"), + } + } +} + +impl Default for TrainView { + fn default() -> TrainView { + Self::Discover + } +} + diff --git a/api/src/models/training_action.rs b/api/src/models/training_action.rs new file mode 100644 index 00000000..4f77e110 --- /dev/null +++ b/api/src/models/training_action.rs @@ -0,0 +1,56 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TrainingAction { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "kind")] + pub kind: Kind, + #[serde(rename = "plan")] + pub plan: Box, + #[serde(rename = "factor_kind")] + pub factor_kind: models::ModelRatingFactorKind, + #[serde(rename = "quality")] + pub quality: models::DatasetQuality, + #[serde(rename = "sub_kind")] + pub sub_kind: String, + #[serde(rename = "search_term", skip_serializing_if = "Option::is_none")] + pub search_term: Option, +} + +impl TrainingAction { + pub fn new(id: String, kind: Kind, plan: models::LabelAction, factor_kind: models::ModelRatingFactorKind, quality: models::DatasetQuality, sub_kind: String) -> TrainingAction { + TrainingAction { + id, + kind, + plan: Box::new(plan), + factor_kind, + quality, + sub_kind, + search_term: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "label")] + Label, +} + +impl Default for Kind { + fn default() -> Kind { + Self::Label + } +} + diff --git a/api/src/models/training_action_completeness.rs b/api/src/models/training_action_completeness.rs new file mode 100644 index 00000000..a07f504b --- /dev/null +++ b/api/src/models/training_action_completeness.rs @@ -0,0 +1,45 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// TrainingActionCompleteness : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum TrainingActionCompleteness { + #[serde(rename = "uncompletable")] + Uncompletable, + #[serde(rename = "incomplete")] + Incomplete, + #[serde(rename = "already-complete")] + AlreadyComplete, + #[serde(rename = "newly-completed")] + NewlyCompleted, + +} + +impl std::fmt::Display for TrainingActionCompleteness { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Uncompletable => write!(f, "uncompletable"), + Self::Incomplete => write!(f, "incomplete"), + Self::AlreadyComplete => write!(f, "already-complete"), + Self::NewlyCompleted => write!(f, "newly-completed"), + } + } +} + +impl Default for TrainingActionCompleteness { + fn default() -> TrainingActionCompleteness { + Self::Uncompletable + } +} + diff --git a/api/src/models/translation.rs b/api/src/models/translation.rs new file mode 100644 index 00000000..41f642ff --- /dev/null +++ b/api/src/models/translation.rs @@ -0,0 +1,60 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Translation { + /// Message sender + #[serde(rename = "from", skip_serializing_if = "Option::is_none")] + pub from: Option, + /// Message recipients + #[serde(rename = "to", skip_serializing_if = "Option::is_none")] + pub to: Option>, + /// Message cc field + #[serde(rename = "cc", skip_serializing_if = "Option::is_none")] + pub cc: Option>, + /// Message bcc field + #[serde(rename = "bcc", skip_serializing_if = "Option::is_none")] + pub bcc: Option>, + /// The time when the message was sent originally + #[serde(rename = "sent_at", skip_serializing_if = "Option::is_none")] + pub sent_at: Option, + /// The language of the translation + #[serde(rename = "language", skip_serializing_if = "Option::is_none")] + pub language: Option, + /// The body of the message + #[serde(rename = "body")] + pub body: Box, + /// The subject of the message + #[serde(rename = "subject", skip_serializing_if = "Option::is_none")] + pub subject: Option>, + /// The signature of the message + #[serde(rename = "signature", skip_serializing_if = "Option::is_none")] + pub signature: Option>, +} + +impl Translation { + pub fn new(body: models::MessageRichText) -> Translation { + Translation { + from: None, + to: None, + cc: None, + bcc: None, + sent_at: None, + language: None, + body: Box::new(body), + subject: None, + signature: None, + } + } +} + diff --git a/api/src/models/trigger.rs b/api/src/models/trigger.rs new file mode 100644 index 00000000..91b9a510 --- /dev/null +++ b/api/src/models/trigger.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Trigger { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "dataset_id")] + pub dataset_id: String, + #[serde(rename = "name")] + pub name: String, + #[serde(rename = "title")] + pub title: String, + #[serde(rename = "description")] + pub description: String, + #[serde(rename = "created_at")] + pub created_at: String, + #[serde(rename = "updated_at", deserialize_with = "Option::deserialize")] + pub updated_at: Option, + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, + #[serde(rename = "model", skip_serializing_if = "Option::is_none")] + pub model: Option>, +} + +impl Trigger { + pub fn new(id: String, dataset_id: String, name: String, title: String, description: String, created_at: String, updated_at: Option) -> Trigger { + Trigger { + id, + dataset_id, + name, + title, + description, + created_at, + updated_at, + comment_filter: None, + model: None, + } + } +} + diff --git a/api/src/models/trigger_exception.rs b/api/src/models/trigger_exception.rs new file mode 100644 index 00000000..da5205ff --- /dev/null +++ b/api/src/models/trigger_exception.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerException { + #[serde(rename = "type")] + pub r#type: String, +} + +impl TriggerException { + pub fn new(r#type: String) -> TriggerException { + TriggerException { + r#type, + } + } +} + diff --git a/api/src/models/trigger_exceptions_summary.rs b/api/src/models/trigger_exceptions_summary.rs new file mode 100644 index 00000000..1a3cd17f --- /dev/null +++ b/api/src/models/trigger_exceptions_summary.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerExceptionsSummary { + #[serde(rename = "display_name")] + pub display_name: String, + #[serde(rename = "types")] + pub types: Vec, +} + +impl TriggerExceptionsSummary { + pub fn new(display_name: String, types: Vec) -> TriggerExceptionsSummary { + TriggerExceptionsSummary { + display_name, + types, + } + } +} + diff --git a/api/src/models/trigger_label_threshold.rs b/api/src/models/trigger_label_threshold.rs new file mode 100644 index 00000000..a59f4d9a --- /dev/null +++ b/api/src/models/trigger_label_threshold.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerLabelThreshold { + #[serde(rename = "name")] + pub name: Vec, + #[serde(rename = "threshold", skip_serializing_if = "Option::is_none")] + pub threshold: Option, +} + +impl TriggerLabelThreshold { + pub fn new(name: Vec) -> TriggerLabelThreshold { + TriggerLabelThreshold { + name, + threshold: None, + } + } +} + diff --git a/api/src/models/trigger_new.rs b/api/src/models/trigger_new.rs new file mode 100644 index 00000000..d87e5dbf --- /dev/null +++ b/api/src/models/trigger_new.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerNew { + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, + #[serde(rename = "model", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model: Option>>, +} + +impl TriggerNew { + pub fn new() -> TriggerNew { + TriggerNew { + name: None, + title: None, + description: None, + comment_filter: None, + model: None, + } + } +} + diff --git a/api/src/models/trigger_update.rs b/api/src/models/trigger_update.rs new file mode 100644 index 00000000..06ae04f4 --- /dev/null +++ b/api/src/models/trigger_update.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerUpdate { + #[serde(rename = "name", skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "title", skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(rename = "comment_filter", skip_serializing_if = "Option::is_none")] + pub comment_filter: Option, + #[serde(rename = "model", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model: Option>>, +} + +impl TriggerUpdate { + pub fn new() -> TriggerUpdate { + TriggerUpdate { + name: None, + title: None, + description: None, + comment_filter: None, + model: None, + } + } +} + diff --git a/api/src/models/trigger_user_model.rs b/api/src/models/trigger_user_model.rs new file mode 100644 index 00000000..b078adec --- /dev/null +++ b/api/src/models/trigger_user_model.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct TriggerUserModel { + #[serde(rename = "version")] + pub version: i32, + #[serde(rename = "label_thresholds", skip_serializing_if = "Option::is_none")] + pub label_thresholds: Option>, +} + +impl TriggerUserModel { + pub fn new(version: i32) -> TriggerUserModel { + TriggerUserModel { + version, + label_thresholds: None, + } + } +} + diff --git a/api/src/models/ui.rs b/api/src/models/ui.rs new file mode 100644 index 00000000..e4c848ec --- /dev/null +++ b/api/src/models/ui.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Ui { + #[serde(rename = "assignment_method")] + pub assignment_method: models::AssignmentMethod, + #[serde(rename = "view")] + pub view: models::TrainView, + #[serde(rename = "reviewed_filter_rule", skip_serializing_if = "Option::is_none")] + pub reviewed_filter_rule: Option, + #[serde(rename = "retrieval_method")] + pub retrieval_method: models::RetrievalMethod, + #[serde(rename = "has_label_filter")] + pub has_label_filter: bool, +} + +impl Ui { + pub fn new(assignment_method: models::AssignmentMethod, view: models::TrainView, retrieval_method: models::RetrievalMethod, has_label_filter: bool) -> Ui { + Ui { + assignment_method, + view, + reviewed_filter_rule: None, + retrieval_method, + has_label_filter, + } + } +} + diff --git a/api/src/models/ui_annotation_metadata.rs b/api/src/models/ui_annotation_metadata.rs new file mode 100644 index 00000000..d02d1893 --- /dev/null +++ b/api/src/models/ui_annotation_metadata.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiAnnotationMetadata { + #[serde(rename = "assignment_method")] + pub assignment_method: models::AssignmentMethod, + #[serde(rename = "view")] + pub view: models::TrainView, + #[serde(rename = "reviewed_filter_rule", skip_serializing_if = "Option::is_none")] + pub reviewed_filter_rule: Option, + #[serde(rename = "retrieval_method")] + pub retrieval_method: models::RetrievalMethod, + #[serde(rename = "has_label_filter")] + pub has_label_filter: bool, +} + +impl UiAnnotationMetadata { + pub fn new(assignment_method: models::AssignmentMethod, view: models::TrainView, retrieval_method: models::RetrievalMethod, has_label_filter: bool) -> UiAnnotationMetadata { + UiAnnotationMetadata { + assignment_method, + view, + reviewed_filter_rule: None, + retrieval_method, + has_label_filter, + } + } +} + diff --git a/api/src/models/ui_path_cv_table_only_config.rs b/api/src/models/ui_path_cv_table_only_config.rs new file mode 100644 index 00000000..8d48ed00 --- /dev/null +++ b/api/src/models/ui_path_cv_table_only_config.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathCvTableOnlyConfig { + #[serde(rename = "kind", skip_serializing_if = "Option::is_none")] + pub kind: Option, +} + +impl UiPathCvTableOnlyConfig { + pub fn new() -> UiPathCvTableOnlyConfig { + UiPathCvTableOnlyConfig { + kind: None, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Kind { + #[serde(rename = "uipath_cv_table_only")] + UipathCvTableOnly, +} + +impl Default for Kind { + fn default() -> Kind { + Self::UipathCvTableOnly + } +} + diff --git a/api/src/models/ui_path_provision_create_properties.rs b/api/src/models/ui_path_provision_create_properties.rs new file mode 100644 index 00000000..ffa58635 --- /dev/null +++ b/api/src/models/ui_path_provision_create_properties.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionCreateProperties { + #[serde(rename = "TenantDisplayName", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub tenant_display_name: Option>, +} + +impl UiPathProvisionCreateProperties { + pub fn new() -> UiPathProvisionCreateProperties { + UiPathProvisionCreateProperties { + tenant_display_name: None, + } + } +} + diff --git a/api/src/models/ui_path_provision_create_request.rs b/api/src/models/ui_path_provision_create_request.rs new file mode 100644 index 00000000..c81b5e8a --- /dev/null +++ b/api/src/models/ui_path_provision_create_request.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionCreateRequest { + #[serde(rename = "callbackUrl", deserialize_with = "Option::deserialize")] + pub callback_url: Option, + #[serde(rename = "tenantId")] + pub tenant_id: String, + #[serde(rename = "organizationId")] + pub organization_id: String, + #[serde(rename = "serviceType")] + pub service_type: String, + #[serde(rename = "properties")] + pub properties: Box, +} + +impl UiPathProvisionCreateRequest { + pub fn new(callback_url: Option, tenant_id: String, organization_id: String, service_type: String, properties: models::UiPathProvisionCreateProperties) -> UiPathProvisionCreateRequest { + UiPathProvisionCreateRequest { + callback_url, + tenant_id, + organization_id, + service_type, + properties: Box::new(properties), + } + } +} + diff --git a/api/src/models/ui_path_provision_create_response.rs b/api/src/models/ui_path_provision_create_response.rs new file mode 100644 index 00000000..0c50ef57 --- /dev/null +++ b/api/src/models/ui_path_provision_create_response.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionCreateResponse { + #[serde(rename = "tenantId")] + pub tenant_id: String, + #[serde(rename = "serviceType")] + pub service_type: String, + #[serde(rename = "status")] + pub status: models::UiPathTenantServiceStatus, +} + +impl UiPathProvisionCreateResponse { + pub fn new(tenant_id: String, service_type: String, status: models::UiPathTenantServiceStatus) -> UiPathProvisionCreateResponse { + UiPathProvisionCreateResponse { + tenant_id, + service_type, + status, + } + } +} + diff --git a/api/src/models/ui_path_provision_delete_request.rs b/api/src/models/ui_path_provision_delete_request.rs new file mode 100644 index 00000000..2e1fcf9f --- /dev/null +++ b/api/src/models/ui_path_provision_delete_request.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionDeleteRequest { + #[serde(rename = "callbackUrl")] + pub callback_url: String, + #[serde(rename = "organizationId")] + pub organization_id: String, + #[serde(rename = "isHardDelete")] + pub is_hard_delete: bool, +} + +impl UiPathProvisionDeleteRequest { + pub fn new(callback_url: String, organization_id: String, is_hard_delete: bool) -> UiPathProvisionDeleteRequest { + UiPathProvisionDeleteRequest { + callback_url, + organization_id, + is_hard_delete, + } + } +} + diff --git a/api/src/models/ui_path_provision_delete_response.rs b/api/src/models/ui_path_provision_delete_response.rs new file mode 100644 index 00000000..e3cb7b25 --- /dev/null +++ b/api/src/models/ui_path_provision_delete_response.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionDeleteResponse { + #[serde(rename = "tenantId")] + pub tenant_id: String, + #[serde(rename = "serviceType")] + pub service_type: String, + #[serde(rename = "status")] + pub status: models::UiPathTenantServiceStatus, + #[serde(rename = "isHardDelete")] + pub is_hard_delete: bool, +} + +impl UiPathProvisionDeleteResponse { + pub fn new(tenant_id: String, service_type: String, status: models::UiPathTenantServiceStatus, is_hard_delete: bool) -> UiPathProvisionDeleteResponse { + UiPathProvisionDeleteResponse { + tenant_id, + service_type, + status, + is_hard_delete, + } + } +} + diff --git a/api/src/models/ui_path_provision_restore_request.rs b/api/src/models/ui_path_provision_restore_request.rs new file mode 100644 index 00000000..f77a071e --- /dev/null +++ b/api/src/models/ui_path_provision_restore_request.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionRestoreRequest { + #[serde(rename = "callbackUrl", deserialize_with = "Option::deserialize")] + pub callback_url: Option, + #[serde(rename = "status")] + pub status: models::UiPathTenantServiceStatus, + #[serde(rename = "organizationId")] + pub organization_id: String, +} + +impl UiPathProvisionRestoreRequest { + pub fn new(callback_url: Option, status: models::UiPathTenantServiceStatus, organization_id: String) -> UiPathProvisionRestoreRequest { + UiPathProvisionRestoreRequest { + callback_url, + status, + organization_id, + } + } +} + diff --git a/api/src/models/ui_path_provision_restore_response.rs b/api/src/models/ui_path_provision_restore_response.rs new file mode 100644 index 00000000..8bbfccf2 --- /dev/null +++ b/api/src/models/ui_path_provision_restore_response.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionRestoreResponse { + #[serde(rename = "tenantId")] + pub tenant_id: String, + #[serde(rename = "serviceType")] + pub service_type: String, + #[serde(rename = "status")] + pub status: models::UiPathTenantServiceStatus, +} + +impl UiPathProvisionRestoreResponse { + pub fn new(tenant_id: String, service_type: String, status: models::UiPathTenantServiceStatus) -> UiPathProvisionRestoreResponse { + UiPathProvisionRestoreResponse { + tenant_id, + service_type, + status, + } + } +} + diff --git a/api/src/models/ui_path_provision_update_properties.rs b/api/src/models/ui_path_provision_update_properties.rs new file mode 100644 index 00000000..116b30d3 --- /dev/null +++ b/api/src/models/ui_path_provision_update_properties.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionUpdateProperties { + #[serde(rename = "TenantName", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub tenant_name: Option>, +} + +impl UiPathProvisionUpdateProperties { + pub fn new() -> UiPathProvisionUpdateProperties { + UiPathProvisionUpdateProperties { + tenant_name: None, + } + } +} + diff --git a/api/src/models/ui_path_provision_update_request.rs b/api/src/models/ui_path_provision_update_request.rs new file mode 100644 index 00000000..ee149ec4 --- /dev/null +++ b/api/src/models/ui_path_provision_update_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionUpdateRequest { + #[serde(rename = "callbackUrl", deserialize_with = "Option::deserialize")] + pub callback_url: Option, + #[serde(rename = "status", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub status: Option>, + #[serde(rename = "organizationId")] + pub organization_id: String, + #[serde(rename = "properties")] + pub properties: Box, +} + +impl UiPathProvisionUpdateRequest { + pub fn new(callback_url: Option, organization_id: String, properties: models::UiPathProvisionUpdateProperties) -> UiPathProvisionUpdateRequest { + UiPathProvisionUpdateRequest { + callback_url, + status: None, + organization_id, + properties: Box::new(properties), + } + } +} + diff --git a/api/src/models/ui_path_provision_update_response.rs b/api/src/models/ui_path_provision_update_response.rs new file mode 100644 index 00000000..0c644472 --- /dev/null +++ b/api/src/models/ui_path_provision_update_response.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UiPathProvisionUpdateResponse { + #[serde(rename = "tenantId")] + pub tenant_id: String, + #[serde(rename = "serviceType")] + pub service_type: String, + #[serde(rename = "status")] + pub status: models::UiPathTenantServiceStatus, +} + +impl UiPathProvisionUpdateResponse { + pub fn new(tenant_id: String, service_type: String, status: models::UiPathTenantServiceStatus) -> UiPathProvisionUpdateResponse { + UiPathProvisionUpdateResponse { + tenant_id, + service_type, + status, + } + } +} + diff --git a/api/src/models/ui_path_tenant_service_status.rs b/api/src/models/ui_path_tenant_service_status.rs new file mode 100644 index 00000000..84a6e0fb --- /dev/null +++ b/api/src/models/ui_path_tenant_service_status.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UiPathTenantServiceStatus : Enum as documented in the official C# client https://github.com/UiPath/Cloud-RPA/blob/8e7911d86c90ef8da6321b5280acc6328b5d13da/net5/OrganizationManagementService/src/FirstPartyServiceClient/FirstPartyServiceClientV2.cs#L1151 +/// Enum as documented in the official C# client https://github.com/UiPath/Cloud-RPA/blob/8e7911d86c90ef8da6321b5280acc6328b5d13da/net5/OrganizationManagementService/src/FirstPartyServiceClient/FirstPartyServiceClientV2.cs#L1151 +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UiPathTenantServiceStatus { + #[serde(rename = "Enabling")] + Enabling, + #[serde(rename = "Enabled")] + Enabled, + #[serde(rename = "Disabling")] + Disabling, + #[serde(rename = "Disabled")] + Disabled, + #[serde(rename = "Deleting")] + Deleting, + #[serde(rename = "Deleted")] + Deleted, + +} + +impl std::fmt::Display for UiPathTenantServiceStatus { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Enabling => write!(f, "Enabling"), + Self::Enabled => write!(f, "Enabled"), + Self::Disabling => write!(f, "Disabling"), + Self::Disabled => write!(f, "Disabled"), + Self::Deleting => write!(f, "Deleting"), + Self::Deleted => write!(f, "Deleted"), + } + } +} + +impl Default for UiPathTenantServiceStatus { + fn default() -> UiPathTenantServiceStatus { + Self::Enabling + } +} + diff --git a/api/src/models/unary_label_health_action.rs b/api/src/models/unary_label_health_action.rs new file mode 100644 index 00000000..c95cc2ee --- /dev/null +++ b/api/src/models/unary_label_health_action.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UnaryLabelHealthAction { + #[serde(rename = "kind")] + pub kind: models::UnaryLabelHealthActionKind, +} + +impl UnaryLabelHealthAction { + pub fn new(kind: models::UnaryLabelHealthActionKind) -> UnaryLabelHealthAction { + UnaryLabelHealthAction { + kind, + } + } +} + diff --git a/api/src/models/unary_label_health_action_kind.rs b/api/src/models/unary_label_health_action_kind.rs new file mode 100644 index 00000000..34c60d1f --- /dev/null +++ b/api/src/models/unary_label_health_action_kind.rs @@ -0,0 +1,48 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UnaryLabelHealthActionKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UnaryLabelHealthActionKind { + #[serde(rename = "confirm_top_predicted")] + ConfirmTopPredicted, + #[serde(rename = "correct_label")] + CorrectLabel, + #[serde(rename = "missing_label")] + MissingLabel, + #[serde(rename = "teach_unreviewed")] + TeachUnreviewed, + #[serde(rename = "search_for_examples")] + SearchForExamples, + +} + +impl std::fmt::Display for UnaryLabelHealthActionKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::ConfirmTopPredicted => write!(f, "confirm_top_predicted"), + Self::CorrectLabel => write!(f, "correct_label"), + Self::MissingLabel => write!(f, "missing_label"), + Self::TeachUnreviewed => write!(f, "teach_unreviewed"), + Self::SearchForExamples => write!(f, "search_for_examples"), + } + } +} + +impl Default for UnaryLabelHealthActionKind { + fn default() -> UnaryLabelHealthActionKind { + Self::ConfirmTopPredicted + } +} + diff --git a/api/src/models/unary_label_health_warning.rs b/api/src/models/unary_label_health_warning.rs new file mode 100644 index 00000000..01ad1136 --- /dev/null +++ b/api/src/models/unary_label_health_warning.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UnaryLabelHealthWarning { + #[serde(rename = "kind")] + pub kind: models::UnaryLabelHealthWarningKind, +} + +impl UnaryLabelHealthWarning { + pub fn new(kind: models::UnaryLabelHealthWarningKind) -> UnaryLabelHealthWarning { + UnaryLabelHealthWarning { + kind, + } + } +} + diff --git a/api/src/models/unary_label_health_warning_kind.rs b/api/src/models/unary_label_health_warning_kind.rs new file mode 100644 index 00000000..fa6ae3d5 --- /dev/null +++ b/api/src/models/unary_label_health_warning_kind.rs @@ -0,0 +1,51 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UnaryLabelHealthWarningKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UnaryLabelHealthWarningKind { + #[serde(rename = "biased")] + Biased, + #[serde(rename = "low_average_precision")] + LowAveragePrecision, + #[serde(rename = "low_reviewed_comments")] + LowReviewedComments, + #[serde(rename = "very_low_average_precision")] + VeryLowAveragePrecision, + #[serde(rename = "very_low_reviewed_comments")] + VeryLowReviewedComments, + #[serde(rename = "poor_coverage")] + PoorCoverage, + +} + +impl std::fmt::Display for UnaryLabelHealthWarningKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Biased => write!(f, "biased"), + Self::LowAveragePrecision => write!(f, "low_average_precision"), + Self::LowReviewedComments => write!(f, "low_reviewed_comments"), + Self::VeryLowAveragePrecision => write!(f, "very_low_average_precision"), + Self::VeryLowReviewedComments => write!(f, "very_low_reviewed_comments"), + Self::PoorCoverage => write!(f, "poor_coverage"), + } + } +} + +impl Default for UnaryLabelHealthWarningKind { + fn default() -> UnaryLabelHealthWarningKind { + Self::Biased + } +} + diff --git a/api/src/models/uninformative_label.rs b/api/src/models/uninformative_label.rs new file mode 100644 index 00000000..b37222a1 --- /dev/null +++ b/api/src/models/uninformative_label.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UninformativeLabel { + #[serde(rename = "mode")] + pub mode: models::UninformativeMode, + #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")] + pub metadata: Option>, +} + +impl UninformativeLabel { + pub fn new(mode: models::UninformativeMode) -> UninformativeLabel { + UninformativeLabel { + mode, + metadata: None, + } + } +} + diff --git a/api/src/models/uninformative_mode.rs b/api/src/models/uninformative_mode.rs new file mode 100644 index 00000000..2106f376 --- /dev/null +++ b/api/src/models/uninformative_mode.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UninformativeMode : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UninformativeMode { + #[serde(rename = "implicit")] + Implicit, + #[serde(rename = "explicit")] + Explicit, + +} + +impl std::fmt::Display for UninformativeMode { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Implicit => write!(f, "implicit"), + Self::Explicit => write!(f, "explicit"), + } + } +} + +impl Default for UninformativeMode { + fn default() -> UninformativeMode { + Self::Implicit + } +} + diff --git a/api/src/models/unpin_model_response.rs b/api/src/models/unpin_model_response.rs new file mode 100644 index 00000000..4b6a578f --- /dev/null +++ b/api/src/models/unpin_model_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UnpinModelResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl UnpinModelResponse { + pub fn new(status: Status) -> UnpinModelResponse { + UnpinModelResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_alert_request.rs b/api/src/models/update_alert_request.rs new file mode 100644 index 00000000..fe982ad2 --- /dev/null +++ b/api/src/models/update_alert_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateAlertRequest { + #[serde(rename = "alert")] + pub alert: Box, +} + +impl UpdateAlertRequest { + pub fn new(alert: models::AlertUpdate) -> UpdateAlertRequest { + UpdateAlertRequest { + alert: Box::new(alert), + } + } +} + diff --git a/api/src/models/update_alert_response.rs b/api/src/models/update_alert_response.rs new file mode 100644 index 00000000..5aee54e7 --- /dev/null +++ b/api/src/models/update_alert_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateAlertResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "alert")] + pub alert: Box, +} + +impl UpdateAlertResponse { + pub fn new(status: Status, alert: models::Alert) -> UpdateAlertResponse { + UpdateAlertResponse { + status, + alert: Box::new(alert), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_appliance_config_response.rs b/api/src/models/update_appliance_config_response.rs new file mode 100644 index 00000000..bab5ba04 --- /dev/null +++ b/api/src/models/update_appliance_config_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateApplianceConfigResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "changes")] + pub changes: serde_json::Value, +} + +impl UpdateApplianceConfigResponse { + pub fn new(status: Status, changes: serde_json::Value) -> UpdateApplianceConfigResponse { + UpdateApplianceConfigResponse { + status, + changes, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_bucket_request.rs b/api/src/models/update_bucket_request.rs new file mode 100644 index 00000000..d73dcf5c --- /dev/null +++ b/api/src/models/update_bucket_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateBucketRequest { + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl UpdateBucketRequest { + pub fn new(bucket: models::BucketUpdate) -> UpdateBucketRequest { + UpdateBucketRequest { + bucket: Box::new(bucket), + } + } +} + diff --git a/api/src/models/update_bucket_response.rs b/api/src/models/update_bucket_response.rs new file mode 100644 index 00000000..7bf4eb79 --- /dev/null +++ b/api/src/models/update_bucket_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateBucketResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "bucket")] + pub bucket: Box, +} + +impl UpdateBucketResponse { + pub fn new(status: Status, bucket: models::Bucket) -> UpdateBucketResponse { + UpdateBucketResponse { + status, + bucket: Box::new(bucket), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_comment_labelling_request.rs b/api/src/models/update_comment_labelling_request.rs new file mode 100644 index 00000000..c015712f --- /dev/null +++ b/api/src/models/update_comment_labelling_request.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateCommentLabellingRequest { + #[serde(rename = "context", skip_serializing_if = "Option::is_none")] + pub context: Option, + #[serde(rename = "labelling", skip_serializing_if = "Option::is_none")] + pub labelling: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + #[serde(rename = "moon_forms", skip_serializing_if = "Option::is_none")] + pub moon_forms: Option>, +} + +impl UpdateCommentLabellingRequest { + pub fn new() -> UpdateCommentLabellingRequest { + UpdateCommentLabellingRequest { + context: None, + labelling: None, + entities: None, + moon_forms: None, + } + } +} + diff --git a/api/src/models/update_comment_labelling_response.rs b/api/src/models/update_comment_labelling_response.rs new file mode 100644 index 00000000..81cf89eb --- /dev/null +++ b/api/src/models/update_comment_labelling_response.rs @@ -0,0 +1,74 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateCommentLabellingResponse { + #[serde(rename = "comment")] + pub comment: Box, + #[serde(rename = "labelling")] + pub labelling: Vec, + #[serde(rename = "reviewable_blocks", skip_serializing_if = "Option::is_none")] + pub reviewable_blocks: Option>, + #[serde(rename = "entities", skip_serializing_if = "Option::is_none")] + pub entities: Option>, + #[serde(rename = "thread_properties", skip_serializing_if = "Option::is_none")] + pub thread_properties: Option>, + #[serde(rename = "trigger_exceptions", skip_serializing_if = "Option::is_none")] + pub trigger_exceptions: Option>, + #[serde(rename = "label_properties", skip_serializing_if = "Option::is_none")] + pub label_properties: Option>, + #[serde(rename = "moon_forms", skip_serializing_if = "Option::is_none")] + pub moon_forms: Option>, + #[serde(rename = "extractions", skip_serializing_if = "Option::is_none")] + pub extractions: Option>, + #[serde(rename = "highlights", skip_serializing_if = "Option::is_none")] + pub highlights: Option>, + #[serde(rename = "diagnostics", skip_serializing_if = "Option::is_none")] + pub diagnostics: Option>, + #[serde(rename = "model_version", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub model_version: Option>, + #[serde(rename = "status")] + pub status: Status, +} + +impl UpdateCommentLabellingResponse { + pub fn new(comment: models::Comment, labelling: Vec, status: Status) -> UpdateCommentLabellingResponse { + UpdateCommentLabellingResponse { + comment: Box::new(comment), + labelling, + reviewable_blocks: None, + entities: None, + thread_properties: None, + trigger_exceptions: None, + label_properties: None, + moon_forms: None, + extractions: None, + highlights: None, + diagnostics: None, + model_version: None, + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_dashboard_request.rs b/api/src/models/update_dashboard_request.rs new file mode 100644 index 00000000..39b6c183 --- /dev/null +++ b/api/src/models/update_dashboard_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateDashboardRequest { + #[serde(rename = "dashboard")] + pub dashboard: Box, +} + +impl UpdateDashboardRequest { + pub fn new(dashboard: models::DashboardUpdate) -> UpdateDashboardRequest { + UpdateDashboardRequest { + dashboard: Box::new(dashboard), + } + } +} + diff --git a/api/src/models/update_dashboard_response.rs b/api/src/models/update_dashboard_response.rs new file mode 100644 index 00000000..e7327d13 --- /dev/null +++ b/api/src/models/update_dashboard_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateDashboardResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dashboard")] + pub dashboard: Box, +} + +impl UpdateDashboardResponse { + pub fn new(status: Status, dashboard: models::Dashboard) -> UpdateDashboardResponse { + UpdateDashboardResponse { + status, + dashboard: Box::new(dashboard), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_dataset_request.rs b/api/src/models/update_dataset_request.rs new file mode 100644 index 00000000..9722672a --- /dev/null +++ b/api/src/models/update_dataset_request.rs @@ -0,0 +1,29 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UpdateDatasetRequest : Request to update an existing dataset +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateDatasetRequest { + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl UpdateDatasetRequest { + /// Request to update an existing dataset + pub fn new(dataset: models::DatasetUpdate) -> UpdateDatasetRequest { + UpdateDatasetRequest { + dataset: Box::new(dataset), + } + } +} + diff --git a/api/src/models/update_dataset_response.rs b/api/src/models/update_dataset_response.rs new file mode 100644 index 00000000..41e69073 --- /dev/null +++ b/api/src/models/update_dataset_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateDatasetResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "dataset")] + pub dataset: Box, +} + +impl UpdateDatasetResponse { + pub fn new(status: Status, dataset: models::Dataset) -> UpdateDatasetResponse { + UpdateDatasetResponse { + status, + dataset: Box::new(dataset), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_integration_request.rs b/api/src/models/update_integration_request.rs new file mode 100644 index 00000000..faf613e8 --- /dev/null +++ b/api/src/models/update_integration_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateIntegrationRequest { + #[serde(rename = "integration")] + pub integration: Box, +} + +impl UpdateIntegrationRequest { + pub fn new(integration: models::IntegrationUpdate) -> UpdateIntegrationRequest { + UpdateIntegrationRequest { + integration: Box::new(integration), + } + } +} + diff --git a/api/src/models/update_integration_response.rs b/api/src/models/update_integration_response.rs new file mode 100644 index 00000000..558e7edf --- /dev/null +++ b/api/src/models/update_integration_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateIntegrationResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "integration")] + pub integration: Box, +} + +impl UpdateIntegrationResponse { + pub fn new(status: Status, integration: models::Integration) -> UpdateIntegrationResponse { + UpdateIntegrationResponse { + status, + integration: Box::new(integration), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_issue_status_request.rs b/api/src/models/update_issue_status_request.rs new file mode 100644 index 00000000..25fa204c --- /dev/null +++ b/api/src/models/update_issue_status_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateIssueStatusRequest { + #[serde(rename = "status")] + pub status: models::IssueStatus, +} + +impl UpdateIssueStatusRequest { + pub fn new(status: models::IssueStatus) -> UpdateIssueStatusRequest { + UpdateIssueStatusRequest { + status, + } + } +} + diff --git a/api/src/models/update_issue_status_response.rs b/api/src/models/update_issue_status_response.rs new file mode 100644 index 00000000..f28f0ec1 --- /dev/null +++ b/api/src/models/update_issue_status_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateIssueStatusResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl UpdateIssueStatusResponse { + pub fn new(status: Status) -> UpdateIssueStatusResponse { + UpdateIssueStatusResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_label_def_response.rs b/api/src/models/update_label_def_response.rs new file mode 100644 index 00000000..0a9a5755 --- /dev/null +++ b/api/src/models/update_label_def_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateLabelDefResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "num_modified")] + pub num_modified: i32, + #[serde(rename = "label")] + pub label: Box, +} + +impl UpdateLabelDefResponse { + pub fn new(status: Status, num_modified: i32, label: models::LabelDef) -> UpdateLabelDefResponse { + UpdateLabelDefResponse { + status, + num_modified, + label: Box::new(label), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_model_request.rs b/api/src/models/update_model_request.rs new file mode 100644 index 00000000..e23c2ebf --- /dev/null +++ b/api/src/models/update_model_request.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateModelRequest { + #[serde(rename = "starred", skip_serializing_if = "Option::is_none")] + pub starred: Option, + #[serde(rename = "description", skip_serializing_if = "Option::is_none")] + pub description: Option, +} + +impl UpdateModelRequest { + pub fn new() -> UpdateModelRequest { + UpdateModelRequest { + starred: None, + description: None, + } + } +} + diff --git a/api/src/models/update_model_response.rs b/api/src/models/update_model_response.rs new file mode 100644 index 00000000..2f420e36 --- /dev/null +++ b/api/src/models/update_model_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateModelResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "labeller")] + pub labeller: Box, +} + +impl UpdateModelResponse { + pub fn new(status: Status, labeller: models::UserModelMetadata) -> UpdateModelResponse { + UpdateModelResponse { + status, + labeller: Box::new(labeller), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_model_tag_request.rs b/api/src/models/update_model_tag_request.rs new file mode 100644 index 00000000..0be897cd --- /dev/null +++ b/api/src/models/update_model_tag_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateModelTagRequest { + #[serde(rename = "model_tag")] + pub model_tag: Box, +} + +impl UpdateModelTagRequest { + pub fn new(model_tag: models::TaggedUserModelVersionUpdate) -> UpdateModelTagRequest { + UpdateModelTagRequest { + model_tag: Box::new(model_tag), + } + } +} + diff --git a/api/src/models/update_model_tag_response.rs b/api/src/models/update_model_tag_response.rs new file mode 100644 index 00000000..44c371eb --- /dev/null +++ b/api/src/models/update_model_tag_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateModelTagResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "model_tag")] + pub model_tag: Box, +} + +impl UpdateModelTagResponse { + pub fn new(status: Status, model_tag: models::TaggedUserModelVersion) -> UpdateModelTagResponse { + UpdateModelTagResponse { + status, + model_tag: Box::new(model_tag), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_project_request.rs b/api/src/models/update_project_request.rs new file mode 100644 index 00000000..bdb32cb7 --- /dev/null +++ b/api/src/models/update_project_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateProjectRequest { + #[serde(rename = "project")] + pub project: Box, +} + +impl UpdateProjectRequest { + pub fn new(project: models::ProjectNew) -> UpdateProjectRequest { + UpdateProjectRequest { + project: Box::new(project), + } + } +} + diff --git a/api/src/models/update_project_response.rs b/api/src/models/update_project_response.rs new file mode 100644 index 00000000..9ef7ea4a --- /dev/null +++ b/api/src/models/update_project_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateProjectResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "project")] + pub project: Box, +} + +impl UpdateProjectResponse { + pub fn new(status: Status, project: models::Project) -> UpdateProjectResponse { + UpdateProjectResponse { + status, + project: Box::new(project), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_source_request.rs b/api/src/models/update_source_request.rs new file mode 100644 index 00000000..7ec2095f --- /dev/null +++ b/api/src/models/update_source_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateSourceRequest { + #[serde(rename = "source")] + pub source: Box, +} + +impl UpdateSourceRequest { + pub fn new(source: models::SourceUpdate) -> UpdateSourceRequest { + UpdateSourceRequest { + source: Box::new(source), + } + } +} + diff --git a/api/src/models/update_source_response.rs b/api/src/models/update_source_response.rs new file mode 100644 index 00000000..29a40a67 --- /dev/null +++ b/api/src/models/update_source_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateSourceResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "source")] + pub source: Box, +} + +impl UpdateSourceResponse { + pub fn new(status: Status, source: models::Source) -> UpdateSourceResponse { + UpdateSourceResponse { + status, + source: Box::new(source), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_tenant_client_subnets_request.rs b/api/src/models/update_tenant_client_subnets_request.rs new file mode 100644 index 00000000..c71a7e0e --- /dev/null +++ b/api/src/models/update_tenant_client_subnets_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantClientSubnetsRequest { + #[serde(rename = "client_subnets")] + pub client_subnets: Vec, +} + +impl UpdateTenantClientSubnetsRequest { + pub fn new(client_subnets: Vec) -> UpdateTenantClientSubnetsRequest { + UpdateTenantClientSubnetsRequest { + client_subnets, + } + } +} + diff --git a/api/src/models/update_tenant_client_subnets_response.rs b/api/src/models/update_tenant_client_subnets_response.rs new file mode 100644 index 00000000..07a47a78 --- /dev/null +++ b/api/src/models/update_tenant_client_subnets_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantClientSubnetsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "client_subnets")] + pub client_subnets: Vec, +} + +impl UpdateTenantClientSubnetsResponse { + pub fn new(status: Status, client_subnets: Vec) -> UpdateTenantClientSubnetsResponse { + UpdateTenantClientSubnetsResponse { + status, + client_subnets, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_tenant_default_project_permissions_request.rs b/api/src/models/update_tenant_default_project_permissions_request.rs new file mode 100644 index 00000000..6fb59b0a --- /dev/null +++ b/api/src/models/update_tenant_default_project_permissions_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantDefaultProjectPermissionsRequest { + #[serde(rename = "default_project_permissions")] + pub default_project_permissions: Vec, +} + +impl UpdateTenantDefaultProjectPermissionsRequest { + pub fn new(default_project_permissions: Vec) -> UpdateTenantDefaultProjectPermissionsRequest { + UpdateTenantDefaultProjectPermissionsRequest { + default_project_permissions, + } + } +} + diff --git a/api/src/models/update_tenant_default_project_permissions_response.rs b/api/src/models/update_tenant_default_project_permissions_response.rs new file mode 100644 index 00000000..9fc376b0 --- /dev/null +++ b/api/src/models/update_tenant_default_project_permissions_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantDefaultProjectPermissionsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "default_project_permissions")] + pub default_project_permissions: Vec, +} + +impl UpdateTenantDefaultProjectPermissionsResponse { + pub fn new(status: Status, default_project_permissions: Vec) -> UpdateTenantDefaultProjectPermissionsResponse { + UpdateTenantDefaultProjectPermissionsResponse { + status, + default_project_permissions, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_tenant_domains_request.rs b/api/src/models/update_tenant_domains_request.rs new file mode 100644 index 00000000..a973b736 --- /dev/null +++ b/api/src/models/update_tenant_domains_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantDomainsRequest { + #[serde(rename = "domains")] + pub domains: Vec, +} + +impl UpdateTenantDomainsRequest { + pub fn new(domains: Vec) -> UpdateTenantDomainsRequest { + UpdateTenantDomainsRequest { + domains, + } + } +} + diff --git a/api/src/models/update_tenant_domains_response.rs b/api/src/models/update_tenant_domains_response.rs new file mode 100644 index 00000000..8e1713a4 --- /dev/null +++ b/api/src/models/update_tenant_domains_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantDomainsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "domains")] + pub domains: Vec, +} + +impl UpdateTenantDomainsResponse { + pub fn new(status: Status, domains: Vec) -> UpdateTenantDomainsResponse { + UpdateTenantDomainsResponse { + status, + domains, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_tenant_entity_def_ids_request.rs b/api/src/models/update_tenant_entity_def_ids_request.rs new file mode 100644 index 00000000..f40b75dd --- /dev/null +++ b/api/src/models/update_tenant_entity_def_ids_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantEntityDefIdsRequest { + #[serde(rename = "entity_def_ids")] + pub entity_def_ids: Vec, +} + +impl UpdateTenantEntityDefIdsRequest { + pub fn new(entity_def_ids: Vec) -> UpdateTenantEntityDefIdsRequest { + UpdateTenantEntityDefIdsRequest { + entity_def_ids, + } + } +} + diff --git a/api/src/models/update_tenant_entity_def_ids_response.rs b/api/src/models/update_tenant_entity_def_ids_response.rs new file mode 100644 index 00000000..246ecfe9 --- /dev/null +++ b/api/src/models/update_tenant_entity_def_ids_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantEntityDefIdsResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "entity_def_ids")] + pub entity_def_ids: Vec, +} + +impl UpdateTenantEntityDefIdsResponse { + pub fn new(status: Status, entity_def_ids: Vec) -> UpdateTenantEntityDefIdsResponse { + UpdateTenantEntityDefIdsResponse { + status, + entity_def_ids, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_tenant_request.rs b/api/src/models/update_tenant_request.rs new file mode 100644 index 00000000..0cd04f46 --- /dev/null +++ b/api/src/models/update_tenant_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantRequest { + #[serde(rename = "tenant")] + pub tenant: Box, +} + +impl UpdateTenantRequest { + pub fn new(tenant: models::TenantUpdate) -> UpdateTenantRequest { + UpdateTenantRequest { + tenant: Box::new(tenant), + } + } +} + diff --git a/api/src/models/update_tenant_response.rs b/api/src/models/update_tenant_response.rs new file mode 100644 index 00000000..d566c8b6 --- /dev/null +++ b/api/src/models/update_tenant_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTenantResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "tenant")] + pub tenant: Box, +} + +impl UpdateTenantResponse { + pub fn new(status: Status, tenant: models::Tenant) -> UpdateTenantResponse { + UpdateTenantResponse { + status, + tenant: Box::new(tenant), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_trigger_request.rs b/api/src/models/update_trigger_request.rs new file mode 100644 index 00000000..f9294937 --- /dev/null +++ b/api/src/models/update_trigger_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTriggerRequest { + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl UpdateTriggerRequest { + pub fn new(trigger: models::TriggerUpdate) -> UpdateTriggerRequest { + UpdateTriggerRequest { + trigger: Box::new(trigger), + } + } +} + diff --git a/api/src/models/update_trigger_response.rs b/api/src/models/update_trigger_response.rs new file mode 100644 index 00000000..04833fb4 --- /dev/null +++ b/api/src/models/update_trigger_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateTriggerResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "trigger")] + pub trigger: Box, +} + +impl UpdateTriggerResponse { + pub fn new(status: Status, trigger: models::Trigger) -> UpdateTriggerResponse { + UpdateTriggerResponse { + status, + trigger: Box::new(trigger), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/update_user_request.rs b/api/src/models/update_user_request.rs new file mode 100644 index 00000000..949ec663 --- /dev/null +++ b/api/src/models/update_user_request.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateUserRequest { + #[serde(rename = "user")] + pub user: Box, +} + +impl UpdateUserRequest { + pub fn new(user: models::UserUpdate) -> UpdateUserRequest { + UpdateUserRequest { + user: Box::new(user), + } + } +} + diff --git a/api/src/models/update_user_response.rs b/api/src/models/update_user_response.rs new file mode 100644 index 00000000..ccaf986b --- /dev/null +++ b/api/src/models/update_user_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UpdateUserResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "user")] + pub user: Box, +} + +impl UpdateUserResponse { + pub fn new(status: Status, user: models::User) -> UpdateUserResponse { + UpdateUserResponse { + status, + user: Box::new(user), + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/upload_attachment_response.rs b/api/src/models/upload_attachment_response.rs new file mode 100644 index 00000000..3694d49e --- /dev/null +++ b/api/src/models/upload_attachment_response.rs @@ -0,0 +1,41 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UploadAttachmentResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "content_hash")] + pub content_hash: String, +} + +impl UploadAttachmentResponse { + pub fn new(status: Status, content_hash: String) -> UploadAttachmentResponse { + UploadAttachmentResponse { + status, + content_hash, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/upload_document_response.rs b/api/src/models/upload_document_response.rs new file mode 100644 index 00000000..3d93b9ed --- /dev/null +++ b/api/src/models/upload_document_response.rs @@ -0,0 +1,44 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UploadDocumentResponse { + #[serde(rename = "status")] + pub status: Status, + #[serde(rename = "comment_id")] + pub comment_id: String, + #[serde(rename = "attachment_ref")] + pub attachment_ref: String, +} + +impl UploadDocumentResponse { + pub fn new(status: Status, comment_id: String, attachment_ref: String) -> UploadDocumentResponse { + UploadDocumentResponse { + status, + comment_id, + attachment_ref, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/upload_files_response.rs b/api/src/models/upload_files_response.rs new file mode 100644 index 00000000..48c9fdfc --- /dev/null +++ b/api/src/models/upload_files_response.rs @@ -0,0 +1,38 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UploadFilesResponse { + #[serde(rename = "status")] + pub status: Status, +} + +impl UploadFilesResponse { + pub fn new(status: Status) -> UploadFilesResponse { + UploadFilesResponse { + status, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/user.rs b/api/src/models/user.rs new file mode 100644 index 00000000..6afe7557 --- /dev/null +++ b/api/src/models/user.rs @@ -0,0 +1,66 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct User { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "created")] + pub created: String, + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "verified")] + pub verified: bool, + #[serde(rename = "organisation_permissions")] + pub organisation_permissions: std::collections::HashMap>, + #[serde(rename = "derived_organisation_permissions")] + pub derived_organisation_permissions: std::collections::HashMap>, + #[serde(rename = "global_permissions")] + pub global_permissions: Vec, + #[serde(rename = "sso_global_permissions")] + pub sso_global_permissions: Vec, + #[serde(rename = "derived_user_global_permissions")] + pub derived_user_global_permissions: Vec, + #[serde(rename = "derived_global_permissions")] + pub derived_global_permissions: Vec, + #[serde(rename = "last_login_at", deserialize_with = "Option::deserialize")] + pub last_login_at: Option, + #[serde(rename = "is_support_user")] + pub is_support_user: bool, + #[serde(rename = "user_access_token", skip_serializing_if = "Option::is_none")] + pub user_access_token: Option, +} + +impl User { + pub fn new(id: String, created: String, username: String, email: String, verified: bool, organisation_permissions: std::collections::HashMap>, derived_organisation_permissions: std::collections::HashMap>, global_permissions: Vec, sso_global_permissions: Vec, derived_user_global_permissions: Vec, derived_global_permissions: Vec, last_login_at: Option, is_support_user: bool) -> User { + User { + id, + created, + username, + email, + verified, + organisation_permissions, + derived_organisation_permissions, + global_permissions, + sso_global_permissions, + derived_user_global_permissions, + derived_global_permissions, + last_login_at, + is_support_user, + user_access_token: None, + } + } +} + diff --git a/api/src/models/user_access_model.rs b/api/src/models/user_access_model.rs new file mode 100644 index 00000000..93050139 --- /dev/null +++ b/api/src/models/user_access_model.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserAccessModel { + #[serde(rename = "kind")] + pub kind: models::UserAccessModelKind, + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "password", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub password: Option>, +} + +impl UserAccessModel { + pub fn new(kind: models::UserAccessModelKind, username: String) -> UserAccessModel { + UserAccessModel { + kind, + username, + password: None, + } + } +} + diff --git a/api/src/models/user_access_model_kind.rs b/api/src/models/user_access_model_kind.rs new file mode 100644 index 00000000..41aa3db4 --- /dev/null +++ b/api/src/models/user_access_model_kind.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UserAccessModelKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UserAccessModelKind { + #[serde(rename = "user_access")] + UserAccess, + +} + +impl std::fmt::Display for UserAccessModelKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::UserAccess => write!(f, "user_access"), + } + } +} + +impl Default for UserAccessModelKind { + fn default() -> UserAccessModelKind { + Self::UserAccess + } +} + diff --git a/api/src/models/user_license.rs b/api/src/models/user_license.rs new file mode 100644 index 00000000..1cb91eb1 --- /dev/null +++ b/api/src/models/user_license.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UserLicense : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UserLicense { + #[serde(rename = "NonV2")] + NonV2, + #[serde(rename = "V2NoLicense")] + V2NoLicense, + #[serde(rename = "V2")] + V2, + +} + +impl std::fmt::Display for UserLicense { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::NonV2 => write!(f, "NonV2"), + Self::V2NoLicense => write!(f, "V2NoLicense"), + Self::V2 => write!(f, "V2"), + } + } +} + +impl Default for UserLicense { + fn default() -> UserLicense { + Self::NonV2 + } +} + diff --git a/api/src/models/user_license_check.rs b/api/src/models/user_license_check.rs new file mode 100644 index 00000000..0fc094d8 --- /dev/null +++ b/api/src/models/user_license_check.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UserLicenseCheck : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UserLicenseCheck { + #[serde(rename = "Failed")] + Failed, + #[serde(rename = "Succeeded")] + Succeeded, + +} + +impl std::fmt::Display for UserLicenseCheck { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Failed => write!(f, "Failed"), + Self::Succeeded => write!(f, "Succeeded"), + } + } +} + +impl Default for UserLicenseCheck { + fn default() -> UserLicenseCheck { + Self::Failed + } +} + diff --git a/api/src/models/user_model.rs b/api/src/models/user_model.rs new file mode 100644 index 00000000..2bb0adbd --- /dev/null +++ b/api/src/models/user_model.rs @@ -0,0 +1,27 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserModel { + #[serde(rename = "definition")] + pub definition: Box, +} + +impl UserModel { + pub fn new(definition: models::ModelDefinition) -> UserModel { + UserModel { + definition: Box::new(definition), + } + } +} + diff --git a/api/src/models/user_model_metadata.rs b/api/src/models/user_model_metadata.rs new file mode 100644 index 00000000..f72625e1 --- /dev/null +++ b/api/src/models/user_model_metadata.rs @@ -0,0 +1,79 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserModelMetadata { + /// The version of the model + #[serde(rename = "version")] + pub version: i32, + /// The type of model + #[serde(rename = "model_id")] + pub model_id: String, + /// The name of the model + #[serde(rename = "model_name")] + pub model_name: models::ModelName, + /// The fingerprint of the model + #[serde(rename = "fingerprint")] + pub fingerprint: String, + /// Timestamp when the model was trained + #[serde(rename = "trained_time")] + pub trained_time: String, + /// Duration of training in seconds + #[serde(rename = "training_duration")] + pub training_duration: f64, + /// Timestamp when the model was trained + #[serde(rename = "input_updated_at")] + pub input_updated_at: String, + /// Whether the model has been validated + #[serde(rename = "validated")] + pub validated: bool, + /// Whether the model is pinned + #[serde(rename = "pinned")] + pub pinned: bool, + /// The number of times each label has been reviewed + #[serde(rename = "reviewed_counts")] + pub reviewed_counts: std::collections::HashMap, + /// Whether the model is used by triggers + #[serde(rename = "used_by_triggers")] + pub used_by_triggers: bool, + /// Settings for the model + #[serde(rename = "settings")] + pub settings: Box, + /// Whether the model is fresh, deprecated or unsupported + #[serde(rename = "freshness")] + pub freshness: models::Freshness, + #[serde(rename = "flags")] + pub flags: Vec, +} + +impl UserModelMetadata { + pub fn new(version: i32, model_id: String, model_name: models::ModelName, fingerprint: String, trained_time: String, training_duration: f64, input_updated_at: String, validated: bool, pinned: bool, reviewed_counts: std::collections::HashMap, used_by_triggers: bool, settings: models::UserModelMetadataSettings, freshness: models::Freshness, flags: Vec) -> UserModelMetadata { + UserModelMetadata { + version, + model_id, + model_name, + fingerprint, + trained_time, + training_duration, + input_updated_at, + validated, + pinned, + reviewed_counts, + used_by_triggers, + settings: Box::new(settings), + freshness, + flags, + } + } +} + diff --git a/api/src/models/user_model_metadata_flag.rs b/api/src/models/user_model_metadata_flag.rs new file mode 100644 index 00000000..a4f5a39b --- /dev/null +++ b/api/src/models/user_model_metadata_flag.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UserModelMetadataFlag : The flags that can be set on a user model. +/// The flags that can be set on a user model. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum UserModelMetadataFlag { + #[serde(rename = "genx")] + Genx, + #[serde(rename = "external_genx")] + ExternalGenx, + #[serde(rename = "cross_validation")] + CrossValidation, + +} + +impl std::fmt::Display for UserModelMetadataFlag { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Genx => write!(f, "genx"), + Self::ExternalGenx => write!(f, "external_genx"), + Self::CrossValidation => write!(f, "cross_validation"), + } + } +} + +impl Default for UserModelMetadataFlag { + fn default() -> UserModelMetadataFlag { + Self::Genx + } +} + diff --git a/api/src/models/user_model_metadata_settings.rs b/api/src/models/user_model_metadata_settings.rs new file mode 100644 index 00000000..33df49b8 --- /dev/null +++ b/api/src/models/user_model_metadata_settings.rs @@ -0,0 +1,32 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserModelMetadataSettings { + /// Whether the model is starred + #[serde(rename = "starred")] + pub starred: bool, + /// The description + #[serde(rename = "description")] + pub description: String, +} + +impl UserModelMetadataSettings { + pub fn new(starred: bool, description: String) -> UserModelMetadataSettings { + UserModelMetadataSettings { + starred, + description, + } + } +} + diff --git a/api/src/models/user_new.rs b/api/src/models/user_new.rs new file mode 100644 index 00000000..92cc18be --- /dev/null +++ b/api/src/models/user_new.rs @@ -0,0 +1,36 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserNew { + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "organisation_permissions", skip_serializing_if = "Option::is_none")] + pub organisation_permissions: Option>>, + #[serde(rename = "global_permissions", skip_serializing_if = "Option::is_none")] + pub global_permissions: Option>, +} + +impl UserNew { + pub fn new(username: String, email: String) -> UserNew { + UserNew { + username, + email, + organisation_permissions: None, + global_permissions: None, + } + } +} + diff --git a/api/src/models/user_properties_summary.rs b/api/src/models/user_properties_summary.rs new file mode 100644 index 00000000..87d2caeb --- /dev/null +++ b/api/src/models/user_properties_summary.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserPropertiesSummary { + #[serde(rename = "number")] + pub number: Vec, + #[serde(rename = "string")] + pub string: Vec, +} + +impl UserPropertiesSummary { + pub fn new(number: Vec, string: Vec) -> UserPropertiesSummary { + UserPropertiesSummary { + number, + string, + } + } +} + diff --git a/api/src/models/user_properties_value.rs b/api/src/models/user_properties_value.rs new file mode 100644 index 00000000..6466ab7d --- /dev/null +++ b/api/src/models/user_properties_value.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// UserPropertiesValue - Fixed version that properly handles the API's mixed-type user property values. +/// This replaces the broken generated empty struct with proper support for string/number/boolean values, +/// matching the legacy reinfer_client's PropertyValue enum pattern. +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +#[serde(untagged)] +pub enum UserPropertiesValue { + String(String), + Number(f64), + Boolean(bool), +} + +impl Default for UserPropertiesValue { + fn default() -> Self { + UserPropertiesValue::String(String::new()) + } +} + +impl UserPropertiesValue { + pub fn new() -> UserPropertiesValue { + UserPropertiesValue::String(String::new()) + } +} diff --git a/api/src/models/user_update.rs b/api/src/models/user_update.rs new file mode 100644 index 00000000..1483f28b --- /dev/null +++ b/api/src/models/user_update.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserUpdate { + #[serde(rename = "organisation_permissions", skip_serializing_if = "Option::is_none")] + pub organisation_permissions: Option>>, + #[serde(rename = "global_permissions", skip_serializing_if = "Option::is_none")] + pub global_permissions: Option>, +} + +impl UserUpdate { + pub fn new() -> UserUpdate { + UserUpdate { + organisation_permissions: None, + global_permissions: None, + } + } +} + diff --git a/api/src/models/user_v1.rs b/api/src/models/user_v1.rs new file mode 100644 index 00000000..94269263 --- /dev/null +++ b/api/src/models/user_v1.rs @@ -0,0 +1,33 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserV1 { + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "last_login_at", deserialize_with = "Option::deserialize")] + pub last_login_at: Option, + #[serde(rename = "username")] + pub username: String, +} + +impl UserV1 { + pub fn new(email: String, last_login_at: Option, username: String) -> UserV1 { + UserV1 { + email, + last_login_at, + username, + } + } +} + diff --git a/api/src/models/user_with_license_check.rs b/api/src/models/user_with_license_check.rs new file mode 100644 index 00000000..4eac1c04 --- /dev/null +++ b/api/src/models/user_with_license_check.rs @@ -0,0 +1,72 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct UserWithLicenseCheck { + #[serde(rename = "id")] + pub id: String, + #[serde(rename = "created")] + pub created: String, + #[serde(rename = "username")] + pub username: String, + #[serde(rename = "email")] + pub email: String, + #[serde(rename = "verified")] + pub verified: bool, + #[serde(rename = "organisation_permissions")] + pub organisation_permissions: std::collections::HashMap>, + #[serde(rename = "derived_organisation_permissions")] + pub derived_organisation_permissions: std::collections::HashMap>, + #[serde(rename = "global_permissions")] + pub global_permissions: Vec, + #[serde(rename = "sso_global_permissions")] + pub sso_global_permissions: Vec, + #[serde(rename = "derived_user_global_permissions")] + pub derived_user_global_permissions: Vec, + #[serde(rename = "derived_global_permissions")] + pub derived_global_permissions: Vec, + #[serde(rename = "last_login_at")] + pub last_login_at: String, + #[serde(rename = "is_support_user")] + pub is_support_user: bool, + #[serde(rename = "user_access_token", skip_serializing_if = "Option::is_none")] + pub user_access_token: Option, + #[serde(rename = "license")] + pub license: models::UserLicense, + #[serde(rename = "license_check")] + pub license_check: models::UserLicenseCheck, +} + +impl UserWithLicenseCheck { + pub fn new(id: String, created: String, username: String, email: String, verified: bool, organisation_permissions: std::collections::HashMap>, derived_organisation_permissions: std::collections::HashMap>, global_permissions: Vec, sso_global_permissions: Vec, derived_user_global_permissions: Vec, derived_global_permissions: Vec, last_login_at: String, is_support_user: bool, license: models::UserLicense, license_check: models::UserLicenseCheck) -> UserWithLicenseCheck { + UserWithLicenseCheck { + id, + created, + username, + email, + verified, + organisation_permissions, + derived_organisation_permissions, + global_permissions, + sso_global_permissions, + derived_user_global_permissions, + derived_global_permissions, + last_login_at, + is_support_user, + user_access_token: None, + license, + license_check, + } + } +} + diff --git a/api/src/models/validate_exchange_credentials_request.rs b/api/src/models/validate_exchange_credentials_request.rs new file mode 100644 index 00000000..92bb3bae --- /dev/null +++ b/api/src/models/validate_exchange_credentials_request.rs @@ -0,0 +1,35 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ValidateExchangeCredentialsRequest { + #[serde(rename = "connection")] + pub connection: Box, + /// A mailbox must be provided to test the connection for ntlmcredentials + #[serde(rename = "test_mailbox", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub test_mailbox: Option>, + /// ID of an existing integration to validate credentials without providing all secrets + #[serde(rename = "integration_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")] + pub integration_id: Option>, +} + +impl ValidateExchangeCredentialsRequest { + pub fn new(connection: models::ConnectionModel) -> ValidateExchangeCredentialsRequest { + ValidateExchangeCredentialsRequest { + connection: Box::new(connection), + test_mailbox: None, + integration_id: None, + } + } +} + diff --git a/api/src/models/validate_exchange_credentials_response.rs b/api/src/models/validate_exchange_credentials_response.rs new file mode 100644 index 00000000..b35d19ce --- /dev/null +++ b/api/src/models/validate_exchange_credentials_response.rs @@ -0,0 +1,42 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ValidateExchangeCredentialsResponse { + #[serde(rename = "status")] + pub status: Status, + /// response to inform if provided crendetials are valid + #[serde(rename = "result")] + pub result: String, +} + +impl ValidateExchangeCredentialsResponse { + pub fn new(status: Status, result: String) -> ValidateExchangeCredentialsResponse { + ValidateExchangeCredentialsResponse { + status, + result, + } + } +} +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum Status { + #[serde(rename = "ok")] + Ok, +} + +impl Default for Status { + fn default() -> Status { + Self::Ok + } +} + diff --git a/api/src/models/validation_summary.rs b/api/src/models/validation_summary.rs new file mode 100644 index 00000000..15b33f9f --- /dev/null +++ b/api/src/models/validation_summary.rs @@ -0,0 +1,78 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ValidationSummary { + #[serde(rename = "fingerprint")] + pub fingerprint: String, + #[serde(rename = "model_kind")] + pub model_kind: String, + #[serde(rename = "version")] + pub version: i32, + #[serde(rename = "training_time")] + pub training_time: f64, + #[serde(rename = "input_updated_at")] + pub input_updated_at: String, + #[serde(rename = "trained_time")] + pub trained_time: String, + #[serde(rename = "entities")] + pub entities: Box, + #[serde(rename = "train_size")] + pub train_size: i32, + #[serde(rename = "test_size")] + pub test_size: i32, + #[serde(rename = "reviewed_size")] + pub reviewed_size: i32, + #[serde(rename = "min_comments_threshold")] + pub min_comments_threshold: i32, + #[serde(rename = "mean_average_precision_safe", deserialize_with = "Option::deserialize")] + pub mean_average_precision_safe: Option, + #[serde(rename = "recalls")] + pub recalls: Vec, + #[serde(rename = "mean_precision_curve_safe")] + pub mean_precision_curve_safe: Vec, + #[serde(rename = "labels")] + pub labels: std::collections::HashMap, + #[serde(rename = "model_rating")] + pub model_rating: Box, + #[serde(rename = "cooccurrence", skip_serializing_if = "Option::is_none")] + pub cooccurrence: Option>, + #[serde(rename = "has_uninformative")] + pub has_uninformative: bool, +} + +impl ValidationSummary { + pub fn new(fingerprint: String, model_kind: String, version: i32, training_time: f64, input_updated_at: String, trained_time: String, entities: models::EntitiesPrStats, train_size: i32, test_size: i32, reviewed_size: i32, min_comments_threshold: i32, mean_average_precision_safe: Option, recalls: Vec, mean_precision_curve_safe: Vec, labels: std::collections::HashMap, model_rating: models::ModelRating, has_uninformative: bool) -> ValidationSummary { + ValidationSummary { + fingerprint, + model_kind, + version, + training_time, + input_updated_at, + trained_time, + entities: Box::new(entities), + train_size, + test_size, + reviewed_size, + min_comments_threshold, + mean_average_precision_safe, + recalls, + mean_precision_curve_safe, + labels, + model_rating: Box::new(model_rating), + cooccurrence: None, + has_uninformative, + } + } +} + diff --git a/api/src/models/validation_summary_v1.rs b/api/src/models/validation_summary_v1.rs new file mode 100644 index 00000000..16a0d715 --- /dev/null +++ b/api/src/models/validation_summary_v1.rs @@ -0,0 +1,85 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct ValidationSummaryV1 { + /// Version of the API + #[serde(rename = "version")] + pub version: i32, + /// List of labels + #[serde(rename = "labels")] + pub labels: Vec, + /// List of entities + #[serde(rename = "entities")] + pub entities: Vec, + /// Number of reviewed comments + #[serde(rename = "num_reviewed_comments")] + pub num_reviewed_comments: i32, + /// Number of labels + #[serde(rename = "num_labels")] + pub num_labels: i32, + /// Number of amber labels + #[serde(rename = "num_amber_labels")] + pub num_amber_labels: i32, + /// Number of red labels + #[serde(rename = "num_red_labels")] + pub num_red_labels: i32, + /// Mean average precision safe + #[serde(rename = "mean_average_precision_safe", deserialize_with = "Option::deserialize")] + pub mean_average_precision_safe: Option, + /// Dataset quality + #[serde(rename = "dataset_quality")] + pub dataset_quality: models::DatasetQuality, + /// Dataset score + #[serde(rename = "dataset_score")] + pub dataset_score: i32, + /// Balance + #[serde(rename = "balance", deserialize_with = "Option::deserialize")] + pub balance: Option, + /// Balance quality + #[serde(rename = "balance_quality", deserialize_with = "Option::deserialize")] + pub balance_quality: Option, + /// Coverage + #[serde(rename = "coverage", deserialize_with = "Option::deserialize")] + pub coverage: Option, + #[serde(rename = "coverage_quality", deserialize_with = "Option::deserialize")] + pub coverage_quality: Option, + #[serde(rename = "underperforming_labels_quality", deserialize_with = "Option::deserialize")] + pub underperforming_labels_quality: Option, + #[serde(rename = "all_labels_quality", deserialize_with = "Option::deserialize")] + pub all_labels_quality: Option, +} + +impl ValidationSummaryV1 { + pub fn new(version: i32, labels: Vec, entities: Vec, num_reviewed_comments: i32, num_labels: i32, num_amber_labels: i32, num_red_labels: i32, mean_average_precision_safe: Option, dataset_quality: models::DatasetQuality, dataset_score: i32, balance: Option, balance_quality: Option, coverage: Option, coverage_quality: Option, underperforming_labels_quality: Option, all_labels_quality: Option) -> ValidationSummaryV1 { + ValidationSummaryV1 { + version, + labels, + entities, + num_reviewed_comments, + num_labels, + num_amber_labels, + num_red_labels, + mean_average_precision_safe, + dataset_quality, + dataset_score, + balance, + balance_quality, + coverage, + coverage_quality, + underperforming_labels_quality, + all_labels_quality, + } + } +} + diff --git a/api/src/models/variation_kind.rs b/api/src/models/variation_kind.rs new file mode 100644 index 00000000..4995141b --- /dev/null +++ b/api/src/models/variation_kind.rs @@ -0,0 +1,39 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +/// VariationKind : An enumeration. +/// An enumeration. +#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)] +pub enum VariationKind { + #[serde(rename = "relative")] + Relative, + #[serde(rename = "absolute")] + Absolute, + +} + +impl std::fmt::Display for VariationKind { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + match self { + Self::Relative => write!(f, "relative"), + Self::Absolute => write!(f, "absolute"), + } + } +} + +impl Default for VariationKind { + fn default() -> VariationKind { + Self::Relative + } +} + diff --git a/api/src/models/vertex.rs b/api/src/models/vertex.rs new file mode 100644 index 00000000..07dc1a48 --- /dev/null +++ b/api/src/models/vertex.rs @@ -0,0 +1,30 @@ +/* + * Communications Mining - OpenAPI 3.1 + * + * # Overview Welcome to the Communications Mining API. We strive to make the API predictable, easy to use and painless to integrate. Other resources: - [Communications Mining Product Documentation](https://docs.uipath.com/communications-mining/automation-cloud/latest) - [Communications Mining API Tutorials](https://docs.uipath.com/communications-mining/automation-cloud/latest/developer-guide/tutorials) ## API Endpoint All API requests are sent to Communications Mining as JSON objects to an endpoint over HTTPS. ### Development and production environments In Communications Mining, development and production data and workflows are separated by placing them in separate projects, each of which is permissioned separately (so that developers can have admin access in the development projects while having stricter access controls in production). Both development and production data are accessed over the same API URL. ## Authentication All API requests require authentication to identify the user making the request. Authentication is provided through an access token. The developer access token can be obtained from your Manage Account page. You need to include the following HTTP header for every API call you make, where `$API_TOKEN` is your Communications Mining API token. ```txt Authorization: Bearer $API_TOKEN ``` ## Permissions Each API endpoint lists its required permissions. You can view the permissions you have by going to your Manage Account page. ## Errors We use conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that resulted from the provided request and codes in the `5xx` range indicate a problem with the Communications Mining platform. Requests that error will also return a body with a `status` value of `error` instead of `ok`, and an error message describing the error. ```json { \"message\": \"404 Not Found\", \"status\": \"error\" } ``` Note that your request can fail due to issues in your network before it reaches Communications Mining. In such cases the response you receive will look different from the Communications Mining error response described above. ## Performance Timing We use the [Server-Timing HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) to communicate the time taken for requests to our API to be processed. We include a single metric, `total`, which you can use to measure how long our platform took to process your request free from latency of the network request. An example of the header as it will be seen in a response: ```txt Server-Timing: total;dur=37.7 ``` `Server-Timing` values are always in milliseconds, so in this case the API request with this header value took 37.7 milliseconds to process on our platform. + * + * The version of the OpenAPI document: 0.1.0 + * + * Generated by: https://openapi-generator.tech + */ + +use crate::models; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)] +pub struct Vertex { + #[serde(rename = "x")] + pub x: f64, + #[serde(rename = "y")] + pub y: f64, +} + +impl Vertex { + pub fn new(x: f64, y: f64) -> Vertex { + Vertex { + x, + y, + } + } +} + diff --git a/api/src/resources/attachments.rs b/api/src/resources/attachments.rs deleted file mode 100644 index e9464c52..00000000 --- a/api/src/resources/attachments.rs +++ /dev/null @@ -1,31 +0,0 @@ -use std::path::Path; - -use crate::AttachmentReference; -use serde::{Deserialize, Serialize}; - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct ContentHash(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct UploadAttachmentResponse { - pub content_hash: ContentHash, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct AttachmentMetadata { - pub name: String, - pub size: u64, - pub content_type: String, - #[serde(skip_serializing_if = "Option::is_none")] - pub attachment_reference: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub content_hash: Option, -} - -impl AttachmentMetadata { - pub fn extension(&self) -> Option { - let path = Path::new(&self.name); - path.extension() - .map(|path| path.to_string_lossy().to_string()) - } -} diff --git a/api/src/resources/audit.rs b/api/src/resources/audit.rs deleted file mode 100644 index c289575e..00000000 --- a/api/src/resources/audit.rs +++ /dev/null @@ -1,201 +0,0 @@ -use chrono::{DateTime, Utc}; - -use crate::{Continuation, DatasetId, DatasetName, ProjectName, UserEmail, UserId, Username}; - -use super::{comment::CommentTimestampFilter, project::Id as ProjectId}; -use serde::{Deserialize, Serialize}; - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct AuditQueryFilter { - pub timestamp: CommentTimestampFilter, -} - -#[derive(PartialEq, Eq, Debug, Clone, Deserialize, Serialize)] -pub struct AuditEventId(pub String); - -#[derive(PartialEq, Eq, Debug, Clone, Deserialize, Serialize)] -pub struct AuditEventType(pub String); - -#[derive(PartialEq, Eq, Debug, Clone, Deserialize, Serialize)] -pub struct AuditTenantName(pub String); - -#[derive(PartialEq, Eq, Debug, Clone, Deserialize, Serialize)] -pub struct AuditTenantId(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct AuditQueryRequest { - pub filter: AuditQueryFilter, - #[serde(skip_serializing_if = "Option::is_none", default)] - pub continuation: Option, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct AuditEvent { - actor_user_id: UserId, - actor_tenant_id: AuditTenantId, - #[serde(skip_serializing_if = "Vec::is_empty", default)] - dataset_ids: Vec, - event_id: AuditEventId, - event_type: AuditEventType, - #[serde(skip_serializing_if = "Vec::is_empty", default)] - project_ids: Vec, - tenant_ids: Vec, - timestamp: DateTime, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct PrintableAuditEvent { - pub actor_email: UserEmail, - pub actor_tenant_name: AuditTenantName, - pub event_type: AuditEventType, - pub dataset_names: Vec, - pub event_id: AuditEventId, - pub project_names: Vec, - pub tenant_names: Vec, - pub timestamp: DateTime, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -struct AuditDataset { - id: DatasetId, - name: DatasetName, - project_id: ProjectId, - title: String, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -struct AuditProject { - id: ProjectId, - name: ProjectName, - tenant_id: AuditTenantId, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -struct AuditTenant { - id: AuditTenantId, - name: AuditTenantName, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -struct AuditUser { - display_name: Username, - email: UserEmail, - id: UserId, - tenant_id: AuditTenantId, - username: Username, -} - -#[derive(Debug, Clone, Deserialize, Serialize)] -pub struct AuditQueryResponse { - audit_events: Vec, - projects: Vec, - pub continuation: Option, - datasets: Vec, - tenants: Vec, - users: Vec, -} - -impl AuditQueryResponse { - pub fn into_iter_printable(self) -> QueryResponseIterator { - QueryResponseIterator { - response: self, - index: 0, - } - } - - fn get_user(&self, user_id: &UserId) -> Option<&AuditUser> { - self.users.iter().find(|user| user.id == *user_id) - } - - fn get_dataset(&self, dataset_id: &DatasetId) -> Option<&AuditDataset> { - self.datasets - .iter() - .find(|dataset| dataset.id == *dataset_id) - } - - fn get_project(&self, project_id: &ProjectId) -> Option<&AuditProject> { - self.projects - .iter() - .find(|project| project.id == *project_id) - } - - fn get_tenant(&self, tenant_id: &AuditTenantId) -> Option<&AuditTenant> { - self.tenants.iter().find(|tenant| tenant.id == *tenant_id) - } -} - -pub struct QueryResponseIterator { - response: AuditQueryResponse, - index: usize, -} - -impl Iterator for QueryResponseIterator { - type Item = PrintableAuditEvent; - fn next(&mut self) -> Option { - let event = self.response.audit_events.get(self.index)?; - - let actor_email = &self - .response - .get_user(&event.actor_user_id) - .unwrap_or_else(|| panic!("Could not find user for id `{}`", event.actor_user_id.0)) - .email; - - let dataset_names = event - .dataset_ids - .iter() - .map(|dataset_id| { - &self - .response - .get_dataset(dataset_id) - .unwrap_or_else(|| panic!("Could not get dataset for id `{}`", dataset_id.0)) - .name - }) - .cloned() - .collect(); - - let project_names = event - .project_ids - .iter() - .map(|project_id| { - &self - .response - .get_project(project_id) - .unwrap_or_else(|| panic!("Could not get project for id `{}`", project_id.0)) - .name - }) - .cloned() - .collect(); - - let tenant_names = event - .tenant_ids - .iter() - .map(|tenant_id| { - &self - .response - .get_tenant(tenant_id) - .unwrap_or_else(|| panic!("Could not get tenant for id `{}`", tenant_id.0)) - .name - }) - .cloned() - .collect(); - - let actor_tenant_name = &self - .response - .get_tenant(&event.actor_tenant_id) - .unwrap_or_else(|| panic!("Could not get tenant for id `{}`", event.actor_tenant_id.0)) - .name; - - self.index += 1; - - Some(PrintableAuditEvent { - event_type: event.event_type.clone(), - actor_tenant_name: actor_tenant_name.clone(), - event_id: event.event_id.clone(), - timestamp: event.timestamp, - actor_email: actor_email.clone(), - dataset_names, - project_names, - tenant_names, - }) - } -} diff --git a/api/src/resources/auth.rs b/api/src/resources/auth.rs deleted file mode 100644 index 65b0d0cf..00000000 --- a/api/src/resources/auth.rs +++ /dev/null @@ -1,9 +0,0 @@ -use serde::{Deserialize, Serialize}; - -#[derive(Debug, Serialize, Deserialize)] -pub struct RefreshUserPermissionsRequest {} - -#[derive(Debug, Serialize, Deserialize)] -pub struct RefreshUserPermissionsResponse { - pub permissions_refreshed: Option, -} diff --git a/api/src/resources/bucket.rs b/api/src/resources/bucket.rs deleted file mode 100644 index f64dc742..00000000 --- a/api/src/resources/bucket.rs +++ /dev/null @@ -1,215 +0,0 @@ -use chrono::{DateTime, Utc}; -use core::fmt; -use once_cell::sync::Lazy; -use regex::Regex; -use serde::{Deserialize, Serialize}; -use std::fmt::{Display, Formatter, Result as FmtResult}; -use std::str::FromStr; - -use crate::{ - error::{Error, Result}, - resources::user::Username, -}; - -static FULL_NAME_REGEX: Lazy = - Lazy::new(|| Regex::new("^[A-Za-z0-9-_]{1,256}/[A-Za-z0-9-_]{1,256}$").unwrap()); - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct Bucket { - pub id: Id, - pub name: Name, - pub owner: Username, - pub created_at: DateTime, -} - -impl Bucket { - pub fn full_name(&self) -> FullName { - FullName(format!("{}/{}", self.owner.0, self.name.0)) - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct Name(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct FullName(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct Id(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct ModelFamily(pub String); - -// TODO(mcobzarenco)[3963]: Make `Identifier` into a trait (ensure it still implements -// `FromStr` so we can take T: Identifier as a clap command line argument). -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub enum Identifier { - Id(Id), - FullName(FullName), -} - -impl From for Identifier { - fn from(full_name: FullName) -> Self { - Identifier::FullName(full_name) - } -} - -impl From for Identifier { - fn from(id: Id) -> Self { - Identifier::Id(id) - } -} - -impl FromStr for Identifier { - type Err = Error; - - fn from_str(string: &str) -> Result { - if string.chars().all(|c| c.is_ascii_hexdigit()) { - Ok(Identifier::Id(Id(string.into()))) - } else if FULL_NAME_REGEX.is_match(string) { - Ok(Identifier::FullName(FullName(string.into()))) - } else { - Err(Error::BadBucketIdentifier { - identifier: string.into(), - }) - } - } -} - -impl Display for FullName { - fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult { - write!(formatter, "{}", self.0) - } -} - -impl Display for Id { - fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult { - write!(formatter, "{}", self.0) - } -} - -impl Display for Identifier { - fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult { - match self { - Identifier::Id(id) => Display::fmt(id, formatter), - Identifier::FullName(full_name) => Display::fmt(full_name, formatter), - } - } -} - -#[derive(Debug, Clone, Serialize, PartialEq, Eq)] -pub struct NewBucket<'request> { - pub bucket_type: BucketType, - #[serde(skip_serializing_if = "Option::is_none")] - pub title: Option<&'request str>, -} - -#[derive(Debug, Clone, Serialize, PartialEq, Eq)] -pub(crate) struct CreateRequest<'request> { - pub bucket: NewBucket<'request>, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub(crate) struct CreateResponse { - pub bucket: Bucket, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FolderStatus { - InProgress, - UpToDate, -} - -impl fmt::Display for FolderStatus { - fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult { - match *self { - Self::InProgress => write!(f, "In progress"), - Self::UpToDate => write!(f, "Up to date"), - } - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct KeyedSyncState { - pub mailbox_name: String, - pub folder_id: Option, - pub folder_path: Option>, - pub status: FolderStatus, - pub synced_until: Option>, - pub last_synced_at: DateTime, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub(crate) struct GetKeyedSyncStatesResponse { - pub keyed_sync_states: Vec, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct KeyedSyncStateId(pub String); - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct GetKeyedSyncStateIdsRequest { - pub mailbox_name: String, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub(crate) struct GetKeyedSyncStateIdsResponse { - pub keyed_sync_state_ids: Vec, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub(crate) struct GetAvailableResponse { - pub buckets: Vec, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub(crate) struct GetResponse { - pub bucket: Bucket, -} - -#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub enum BucketType { - #[serde(rename = "emails")] - Emails, -} - -impl FromStr for BucketType { - type Err = Error; - - fn from_str(string: &str) -> Result { - match string { - "emails" => Ok(Self::Emails), - _ => Err(Error::BadBucketType { - bucket_type: string.into(), - }), - } - } -} - -impl Default for BucketType { - fn default() -> Self { - Self::Emails - } -} - -impl Display for BucketType { - fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult { - match *self { - Self::Emails => write!(formatter, "emails"), - } - } -} - -impl FromStr for FullName { - type Err = Error; - fn from_str(string: &str) -> Result { - if FULL_NAME_REGEX.is_match(string) { - Ok(FullName(string.into())) - } else { - Err(Error::BadBucketName { - name: string.into(), - }) - } - } -} diff --git a/api/src/resources/bucket_statistics.rs b/api/src/resources/bucket_statistics.rs deleted file mode 100644 index 6abc89f7..00000000 --- a/api/src/resources/bucket_statistics.rs +++ /dev/null @@ -1,32 +0,0 @@ -use serde::{Deserialize, Serialize}; - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct GetBucketStatisticsResponse { - pub statistics: Statistics, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -#[serde(tag = "kind")] -pub enum Count { - #[serde(rename = "lower_bound")] - LowerBoundBucketCount { value: i32 }, - #[serde(rename = "exact")] - ExactBucketCount { value: i32 }, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct Statistics { - pub count: Count, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct LowerBoundBucketCount { - pub kind: String, - pub value: i32, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct ExactBucketCount { - pub kind: String, - pub value: i32, -} diff --git a/api/src/resources/comment.rs b/api/src/resources/comment.rs deleted file mode 100644 index 07578bcf..00000000 --- a/api/src/resources/comment.rs +++ /dev/null @@ -1,1116 +0,0 @@ -use crate::{ - error::{Error, Result}, - resources::attachments::AttachmentMetadata, - resources::entity_def::Name as EntityName, - resources::label_def::Name as LabelName, - resources::label_group::Name as LabelGroupName, - resources::label_group::DEFAULT_LABEL_GROUP_NAME, - ReducibleResponse, SourceId, SplittableRequest, -}; -use chrono::{DateTime, Utc}; -use ordered_float::NotNan; -use serde::{ - de::{Deserializer, Error as SerdeError, MapAccess, Visitor}, - ser::{SerializeMap, Serializer}, - Deserialize, Serialize, -}; -use serde_json::Value as JsonValue; -use std::{ - collections::HashMap, - fmt::{Formatter, Result as FmtResult}, - ops::{Deref, DerefMut}, - path::PathBuf, - result::Result as StdResult, - str::FromStr, -}; - -#[derive(Debug, Default, Clone, Deserialize, Serialize, PartialEq, Eq, Hash, PartialOrd, Ord)] -pub struct Id(pub String); - -impl FromStr for Id { - type Err = Error; - - fn from_str(string: &str) -> Result { - Ok(Self(string.to_owned())) - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct Uid(pub String); - -impl FromStr for Uid { - type Err = Error; - - fn from_str(string: &str) -> Result { - Ok(Self(string.to_owned())) - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct ThreadId(pub String); - -#[derive(Debug, Clone, Serialize, Deserialize, Default)] -pub struct CommentTimestampFilter { - #[serde(skip_serializing_if = "Option::is_none")] - pub minimum: Option>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub maximum: Option>, -} - -#[derive(Debug, Clone, Serialize, Deserialize)] -#[serde(rename_all = "snake_case")] -pub enum ReviewedFilterEnum { - OnlyReviewed, - OnlyUnreviewed, -} - -type UserPropertyName = String; - -#[derive(Debug, Clone, Serialize, Deserialize)] -pub struct UserPropertiesFilter(pub HashMap); - -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct PropertyFilter { - #[serde(skip_serializing_if = "<[_]>::is_empty", default)] - pub one_of: Vec, - #[serde(skip_serializing_if = "<[_]>::is_empty", default)] - pub not_one_of: Vec, - #[serde(skip_serializing_if = "<[_]>::is_empty", default)] - pub domain_not_one_of: Vec, - #[serde(skip_serializing_if = "Option::is_none")] - pub minimum: Option>, - #[serde(skip_serializing_if = "Option::is_none")] - pub maximum: Option>, -} - -impl PropertyFilter { - pub fn new( - one_of: Vec, - not_one_of: Vec, - domain_not_one_of: Vec, - ) -> Self { - Self { - one_of, - not_one_of, - domain_not_one_of, - ..Default::default() - } - } -} - -#[derive(Debug, Clone, Serialize, Deserialize, Default)] -pub struct CommentFilter { - #[serde(skip_serializing_if = "Option::is_none")] - pub reviewed: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub timestamp: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub user_properties: Option, - - #[serde(skip_serializing_if = "Vec::is_empty")] - #[serde(default)] - pub sources: Vec, - - #[serde(skip_serializing_if = "Option::is_none")] - pub messages: Option, -} - -#[derive(Debug, Clone, Serialize, Deserialize, Default)] -pub struct MessagesFilter { - #[serde(skip_serializing_if = "Option::is_none")] - pub from: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub to: Option, -} - -#[derive(Debug, Clone, Serialize)] -#[serde(rename_all(serialize = "lowercase"))] -pub enum CommentPredictionsThreshold { - Auto, -} - -#[derive(Debug, Clone, Serialize)] -pub struct TriggerLabelThreshold { - pub name: Vec, - pub threshold: NotNan, -} - -#[derive(Debug, Clone, Serialize)] -pub struct GetCommentPredictionsRequest { - pub uids: Vec, - #[serde(skip_serializing_if = "Option::is_none")] - pub threshold: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub labels: Option>, -} - -#[derive(Debug, Clone, Serialize)] -pub(crate) struct GetRecentRequest<'a> { - pub limit: usize, - pub filter: &'a CommentFilter, - #[serde(skip_serializing_if = "Option::is_none")] - pub continuation: Option<&'a Continuation>, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct Continuation(pub String); - -#[derive(Debug, Clone, Deserialize)] -pub struct RecentCommentsPage { - pub results: Vec, - pub continuation: Option, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)] -pub struct GetLabellingsAfter(pub String); - -#[derive(Debug, Clone, Deserialize)] -pub struct GetAnnotationsResponse { - pub results: Vec, - #[serde(default)] - pub after: Option, -} - -#[derive(Debug, Clone, Deserialize)] -pub struct GetPredictionsResponse { - pub predictions: Vec, -} - -#[derive(Debug, Clone, Serialize)] -pub struct UpdateAnnotationsRequest<'a> { - #[serde(skip_serializing_if = "Option::is_none")] - pub labelling: Option<&'a [NewLabelling]>, - #[serde(skip_serializing_if = "Option::is_none")] - pub entities: Option<&'a NewEntities>, - #[serde(skip_serializing_if = "Option::is_none")] - pub moon_forms: Option<&'a [NewMoonForm]>, -} - -#[derive(Debug, Clone, Deserialize)] -pub struct CommentsIterPage { - pub comments: Vec, - pub continuation: Option, -} - -#[derive(Debug, Clone, Serialize)] -pub(crate) struct PutCommentsRequest { - pub comments: Vec, -} - -impl SplittableRequest for PutCommentsRequest { - fn split(self) -> impl Iterator { - self.comments.into_iter().map(|comment| Self { - comments: vec![comment], - }) - } - - fn count(&self) -> usize { - self.comments.len() - } -} - -#[derive(Default, Debug, Copy, Clone, Deserialize)] -pub struct PutCommentsResponse; - -impl ReducibleResponse for PutCommentsResponse {} - -#[derive(Debug, Clone, Serialize)] -pub(crate) struct SyncCommentsRequest { - pub comments: Vec, -} - -impl SplittableRequest for SyncCommentsRequest { - fn split(self) -> impl Iterator - where - Self: Sized, - { - self.comments.into_iter().map(|comment| Self { - comments: vec![comment], - }) - } - - fn count(&self) -> usize { - self.comments.len() - } -} - -#[derive(Debug, Clone, Deserialize, Default)] -pub struct SyncCommentsResponse { - pub new: usize, - pub updated: usize, - pub unchanged: usize, -} - -impl ReducibleResponse for SyncCommentsResponse { - fn empty() -> Self { - Self { - new: 0, - updated: 0, - unchanged: 0, - } - } - fn merge(self, b: Self) -> Self { - Self { - new: self.new + b.new, - updated: self.updated + b.updated, - unchanged: self.unchanged + b.unchanged, - } - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct GetCommentResponse { - pub comment: Comment, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct Comment { - pub id: Id, - pub uid: Uid, - #[serde(skip_serializing_if = "Option::is_none")] - pub thread_id: Option, - pub timestamp: DateTime, - pub messages: Vec, - #[serde(skip_serializing_if = "PropertyMap::is_empty", default)] - pub user_properties: PropertyMap, - #[serde(skip_serializing_if = "Vec::is_empty", default)] - pub attachments: Vec, - pub created_at: DateTime, - - #[serde(default)] - pub has_annotations: bool, -} - -#[derive(Debug, Default, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct NewComment { - pub id: Id, - #[serde(skip_serializing_if = "Option::is_none")] - pub thread_id: Option, - pub timestamp: DateTime, - pub messages: Vec, - #[serde(skip_serializing_if = "PropertyMap::is_empty", default)] - pub user_properties: PropertyMap, - #[serde(skip_serializing_if = "Vec::is_empty", default)] - pub attachments: Vec, -} - -#[derive(Debug, Default, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct Message { - pub body: MessageBody, - - #[serde(skip_serializing_if = "Option::is_none")] - pub language: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub subject: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub signature: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub from: Option, - - #[serde(skip_serializing_if = "Option::is_none")] - pub to: Option>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub cc: Option>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub bcc: Option>, - - #[serde(skip_serializing_if = "Option::is_none")] - pub sent_at: Option>, -} - -#[derive(Debug, Default, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct MessageBody { - pub text: String, - #[serde(skip_serializing_if = "Option::is_none")] - pub translated_from: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub text_markup: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub translated_from_markup: Option, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct MessageSubject { - pub text: String, - #[serde(skip_serializing_if = "Option::is_none")] - pub translated_from: Option, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct MessageSignature { - pub text: String, - #[serde(skip_serializing_if = "Option::is_none")] - pub translated_from: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub text_markup: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub translated_from_markup: Option, -} - -#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, Eq)] -pub enum Sentiment { - #[serde(rename = "positive")] - Positive, - - #[serde(rename = "negative")] - Negative, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct AttachmentReference(pub String); - -#[derive(Debug, Clone, PartialEq, Default, Eq)] -pub struct PropertyMap(HashMap); - -#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] -#[serde(untagged)] -pub enum PropertyValue { - String(String), - Number(NotNan), -} - -impl Deref for PropertyMap { - type Target = HashMap; - - fn deref(&self) -> &Self::Target { - &self.0 - } -} - -impl DerefMut for PropertyMap { - fn deref_mut(&mut self) -> &mut Self::Target { - &mut self.0 - } -} - -impl PropertyMap { - #[inline] - pub fn new() -> Self { - Default::default() - } - - #[inline] - pub fn with_capacity(capacity: usize) -> Self { - PropertyMap(HashMap::with_capacity(capacity)) - } - - #[inline] - pub fn insert_number(&mut self, key: String, value: NotNan) { - self.0.insert(key, PropertyValue::Number(value)); - } - - #[inline] - pub fn insert_string(&mut self, key: String, value: String) { - self.0.insert(key, PropertyValue::String(value)); - } - - // Provided despite deref, for `skip_serializing_if`. - #[inline] - pub fn is_empty(&self) -> bool { - self.0.is_empty() - } -} - -const STRING_PROPERTY_PREFIX: &str = "string:"; -const NUMBER_PROPERTY_PREFIX: &str = "number:"; - -impl Serialize for PropertyMap { - fn serialize(&self, serializer: S) -> StdResult { - let mut state = serializer.serialize_map(Some(self.len()))?; - if self.0.is_empty() { - return state.end(); - } - - let mut full_name = String::with_capacity(32); - for (key, value) in &self.0 { - full_name.clear(); - match value { - PropertyValue::String(value) => { - if !value.trim().is_empty() { - full_name.push_str(STRING_PROPERTY_PREFIX); - full_name.push_str(key); - state.serialize_entry(&full_name, &value)?; - } - } - PropertyValue::Number(value) => { - full_name.push_str(NUMBER_PROPERTY_PREFIX); - full_name.push_str(key); - state.serialize_entry(&full_name, &value)?; - } - } - } - state.end() - } -} - -impl<'de> Deserialize<'de> for PropertyMap { - #[inline] - fn deserialize>(deserializer: D) -> StdResult { - deserializer.deserialize_any(PropertyMapVisitor) - } -} - -struct PropertyMapVisitor; -impl<'de> Visitor<'de> for PropertyMapVisitor { - type Value = PropertyMap; - - fn expecting(&self, formatter: &mut Formatter<'_>) -> FmtResult { - write!(formatter, "a user property map") - } - - #[inline] - fn visit_unit(self) -> StdResult { - Ok(PropertyMap::new()) - } - - fn visit_map(self, mut access: M) -> StdResult - where - M: MapAccess<'de>, - { - let mut values = PropertyMap::with_capacity(access.size_hint().unwrap_or(0)); - - while let Some(mut key) = access.next_key()? { - if strip_prefix(&mut key, STRING_PROPERTY_PREFIX) { - values.insert(key, PropertyValue::String(access.next_value()?)); - } else if strip_prefix(&mut key, NUMBER_PROPERTY_PREFIX) { - values.insert(key, PropertyValue::Number(access.next_value()?)); - } else { - return Err(M::Error::custom(format!( - "user property full name `{key}` has invalid \ - type prefix" - ))); - } - } - - Ok(values) - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct AnnotatedComment { - pub comment: Comment, - #[serde(skip_serializing_if = "should_skip_serializing_labelling")] - pub labelling: Option>, - #[serde(skip_serializing_if = "should_skip_serializing_entities")] - pub entities: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub thread_properties: Option, - #[serde(skip_serializing_if = "should_skip_serializing_optional_vec", default)] - pub moon_forms: Option>, - #[serde(skip_serializing_if = "should_skip_serializing_optional_vec", default)] - pub label_properties: Option>, -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct Prediction { - pub uid: Uid, - #[serde(skip_serializing_if = "should_skip_serializing_optional_vec")] - pub labels: Option>, - #[serde(skip_serializing_if = "should_skip_serializing_optional_vec")] - pub entities: Option>, -} - -pub fn get_default_labelling_group(labelling: &Option>) -> Option<&Labelling> { - labelling - .iter() - .flatten() - .find(|&labelling_group| labelling_group.is_default_group()) -} - -impl Labelling { - pub fn is_default_group(&self) -> bool { - self.group == *DEFAULT_LABEL_GROUP_NAME - } -} - -impl NewLabelling { - pub fn is_default_group(&self) -> bool { - self.group == *DEFAULT_LABEL_GROUP_NAME - } -} - -impl HasAnnotations for AnnotatedComment { - fn has_annotations(&self) -> bool { - let has_labels = self.labelling.iter().flatten().any(|labelling_group| { - !labelling_group.assigned.is_empty() || !labelling_group.dismissed.is_empty() - }); - let has_entities = self - .entities - .as_ref() - .map(|entities| !entities.assigned.is_empty() || !entities.dismissed.is_empty()) - .unwrap_or(false); - has_labels || has_entities || self.moon_forms.has_annotations() - } -} - -impl AnnotatedComment { - pub fn without_predictions(mut self) -> Self { - self.labelling = self.labelling.and_then(|mut labelling| { - if labelling.iter().all(|labelling_group| { - labelling_group.assigned.is_empty() && labelling_group.dismissed.is_empty() - }) { - None - } else { - for comment_labelling in &mut labelling { - comment_labelling.predicted = None; - } - Some(labelling) - } - }); - self.entities = self.entities.and_then(|mut entities| { - if entities.assigned.is_empty() && entities.dismissed.is_empty() { - None - } else { - entities.predicted = None; - Some(entities) - } - }); - self - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct ThreadProperties { - duration: Option>, - response_time: Option>, - num_messages: u64, - thread_position: Option, - first_sender: Option, -} - -#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] -#[serde(untagged)] -pub enum EitherLabelling { - Labelling(Vec), - LegacyLabelling(NewLegacyLabelling), -} - -impl EitherLabelling { - fn into_new_labellings(self) -> Vec { - match self { - EitherLabelling::Labelling(new_labelling_vec) => new_labelling_vec, - EitherLabelling::LegacyLabelling(new_legacy_labelling) => { - vec![NewLabelling { - group: DEFAULT_LABEL_GROUP_NAME.clone(), - assigned: new_legacy_labelling.assigned, - dismissed: new_legacy_labelling.dismissed, - }] - } - } - } -} - -impl From for Vec { - fn from(either_labelling: EitherLabelling) -> Vec { - either_labelling.into_new_labellings() - } -} - -impl HasAnnotations for EitherLabelling { - fn has_annotations(&self) -> bool { - match self { - EitherLabelling::Labelling(new_labelling) => { - new_labelling.iter().any(|labelling_group| { - labelling_group.assigned.is_some() || labelling_group.dismissed.is_some() - }) - } - EitherLabelling::LegacyLabelling(new_legacy_labelling) => { - new_legacy_labelling.assigned.is_some() || new_legacy_labelling.dismissed.is_some() - } - } - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] -pub struct NewAnnotatedComment { - pub comment: NewComment, - #[serde(skip_serializing_if = "Option::is_none")] - pub labelling: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub entities: Option, - #[serde(skip_serializing_if = "Option::is_none")] - pub audio_path: Option, - #[serde(skip_serializing_if = "should_skip_serializing_optional_vec", default)] - pub moon_forms: Option>, -} - -impl HasAnnotations for Option -where - T: HasAnnotations, -{ - fn has_annotations(&self) -> bool { - self.as_ref().is_some_and(HasAnnotations::has_annotations) - } -} - -impl HasAnnotations for Vec { - fn has_annotations(&self) -> bool { - self.iter().any(|form| !form.assigned.is_empty()) - } -} - -impl HasAnnotations for Vec { - fn has_annotations(&self) -> bool { - self.iter().any(|form| !form.assigned.is_empty()) - } -} - -impl NewAnnotatedComment { - pub fn has_annotations(&self) -> bool { - self.labelling.has_annotations() - || self.entities.has_annotations() - || self.moon_forms.has_annotations() - } -} - -#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] -pub struct Labelling { - pub group: LabelGroupName, - #[serde(skip_serializing_if = "Vec::is_empty", default)] - pub assigned: Vec