bucketeer-io · gabrielraeder · Jun 24, 2024 · Jun 24, 2024
@@ -0,0 +1,46 @@
+---
+id: gateway-get-segment-users
+title: "Gateway_GetSegmentUsers"
+description: "Gateway_GetSegmentUsers"
+sidebar_label: "Gateway_GetSegmentUsers"
+hide_title: true
+hide_table_of_contents: true
+api: eJy1WG1z2zYS/it7+NDIV5Zq3M59UM4358aO61zG9thWejOmJ4bIpYgaBBgAlMJ69N9vFgBFWnZeZnr1F1MEsPvssw+WCzww3aDhTmh1WrAZO+EO17z7cILuCpc1Kje3aCxLmEHbaGXRstkD2//xR/pXoM2NaGg1m7FDsG2eo7VlK6GfnrKE5Vo5VI5W8KaRIvf+pr9bWvbAbF5hzenJdQ2yGdOL3zF3LGGNIXROBKd2DGiYzY3hHUuYcFjbb7ZC0W6nWmeEWrJNwto/Z1w8b/XrPj8zZB13+HQkYajams1u2OnZ63fzo+MjlrDj/8bH24QVWPJWOjYbJmzorUSHY08LrSVyxTabDQFpCu6wOHTPeSy1qTlZFMr94+e4Ilq86uP7Fur66DakqY8t2m926d/kOPcwPxNFQBWjf6JQBa3CTw3mDgtAY7T5K4Sa62IMTyiHSzQ7Af20TwHVaC1fPpNiH4bjQv4JNf47DD8ldnffzi/fTQ1a3ZocQfEawVXcQavExxZlB6JA5UQp0IKrEMgc6NI/WzSCS/EHFplqjHY61xIWbVmigRhcCteVsBC8Q91aB0Q0Fwq4A4ncukxphZCxacYgr7jhuUND6xAktw7iBuqdzi/fvbDQcFcFcwYbgxaVyxQNl62UHXxsuSTMRYgoLvXYJ9yCUJm6IxPTpdZLialHv2jL9KgNBfFuLyDwy22lW1nAAoFgQ86VViLnEiinmZpgukwTCqagIDOWZgyEBaUd8DzHxmGxl2YqU6cKGopP5JiAQ15baG3LCXFjMNd1IyQ5cdrjXQjFTQdcSg/dhsy4CrssKhmEA6ehtR4arfEy/uTZOlRdCr/qNa7QJISVuLOwrkRe+SWuwkx5YSPcVc41d0n4b+8S0AaUhjCaAKUo5wq0F45HbNFB2wD32DJl0azQBIg1b2xg23t0upcDFFgKJciGBW6h1FLqtZ0ROX+H03JwSQQ2Rq9EgcUWFb3k1rY1FiktOFTw6/X1BZwcX4NWvTyCLjqBsgAON7spvu4avL25zRTAisvWMxeZDnvUx94YXbQ5AlehVgR/Q2GwwA1SavQaC4ow5zkpVuv7tqHC0kpnYcEtFhEaOZxfvvPWK77y9NejvBch8bwHQ88rLQrgqqO1wbSXpcFSG0z6mWSAO7EQUrgOFGLhOV8g+K1hVrRBgWDkFVdL9KNeUSlM5hZhhcYKrSgQShqJPmSNK770wBcG+T2pO1pI9yhlZ9rhDBzt8LJVeZAGYYjqz1tjUDnZAV9xIflCbnWqy1LkgstYORZtCQapHmACXBUk7GikJQpJvYOgFrgUShGctXBVpmgkDXnmjbBprmu/3668lCxoVwVpql2dw4QMVwhYN66L2tuDWiwrBwvMlPdOXkDUjUSqRD7/YBvMRSlysFhz5URuU/9d40UhAhEX44K82a28d4equ+uLoSWdcbMQzlBCh8IKn6mrwKWO4QPPFKne77zgY/HFYr2tzUTRRc++FAvvO246C7ZtGm18fWl4fj9tFf2jqhL2je1TGaqgLqF1QYG9FixJfeADlqio3/QIXKUL22Mjmz6HhOj4Eyem4eUMLsghqSH65tvwhYLX33/v5wMAvNEaSq3hANI0fRXekVGuuviLqy4lc2+Mriel1nvxfZqm4UGUMKFJc+/qWk++o1l78BCGRzM3Y5T7X0H5lq/4t8CEA1+vycAX4Qk7eaN1mktu7RhdMEszAorRrFdb2PRvOqWsPGP3itdItfEweFiiOwq91KmyjqscJ3tfdfjsolcj2qDn7aev8HbRuUqrLXPB2xutJ2lKtSemNLA22XucY0/gU/5o+DQEd3R89fry9OL6/HJv1gc0JH+0PloYAf/5K8BPdI/Zg54dwHfNIn2j9UOapjEH5Cuh7woNc9U1i/QM12O3ovTDfzsAJeRA+hBPn87Rmx13m8emgqd0rmpubMXltQ46+wY/maJWyIfab9z+0wyLDprdErIWUtJA7MWpgmfqxTNFekrdWuoH6JvzglqCbd2imkYk04tAdKa2dUPJrm9hnrR8228Y8NJhKO++k3wxfZGpWLR6F6ExwpjcjJVapwtuPLpP0y79I2MhntBPhF7HG8+YH/XqeHt1fpapg4ODg8AV/R460/DB0KRACGU/NB6tjXXa4LKV3GTq6RIaLnAo3glgvcCiGMp4Er8CKlOjWlt6uHf+GHAXe77tx2ZMQNore9brlqgmMQ+NUykkxl3cK/0CjdVqUEzs8EthrPvg+TmAl692RikL/eD+o7IAMJjKwuElYzPI2HOqeQwsDVAylgwGPIwzXnsj/wze/zUaJyC7wyM4p2XsCR4zHTgTFtYo5Q/3Sq+VV2jFLR0LWut0DUEKjxOZhI/zTnbDNhm5ofSpJfCQvEzdeZn02au0LELqRp78iSRmHeKxISY9U97MNr8wIaX3oTxpi/uTz+3N7d7sz+TksblHafHxBBsv0/2X+zZjkfV4fh9dDPyiiy4cqP+fF0h//TVFOEk/d6cz3NzMz/5zdv7bGUvY4dnR5fkpXeGcnl+xhP12/AtL2Mn5h6vjy/fHlyxhZ+dHx8Ovt4fvD8On6/FVT2+RABT370M//1xEW4qFodsgZ1rcJMzxpSVg8Qow2B53q5+/Gwwlmc1Yo62nnbuKzdh0ie5DJP1DG+dS0i6H9EZh7qbnpkd7u0P/QORA8ojLceCjqxShSu2ZEI58MS/R6TIENKXjkcijcFnCVlsL8cmfQSw6MkUh1tzzSlVs4AVO0EEkBnpmHjG4zQSdzqeN5EL5+z8jaSyQdsOeknabsIqInd2whwc6Ts6N3Gzo9ccWTcdmN7cJW3Ej6HBFvzYJq5AXaNjs5oHdY8dm7HXYQz9Qe0cx0jYk+e/up03Srzj09xZfnHs7yv3F+dU1S9gi7tnaX4Ixw9d0eczXbMYyljGWsHB/4Peaf//AJFfL1l+DsWCX/v4HFAy9Fw==
+sidebar_class_name: "post api-method"
+info_path: api/proto-gateway-service-proto
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import Markdown from "@theme/Markdown";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+
+<h1 className={"openapi__heading"}>Gateway_GetSegmentUsers</h1>
+
+<MethodEndpoint method={"post"} path={"/get_segment_users"}></MethodEndpoint>
+
+
+
+Gateway_GetSegmentUsers
+
+## Request
+
+<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"segmentIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"requestedAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"string","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`UNKNOWN`, `ANDROID`, `IOS`, `WEB`, `GO_SERVER`, `NODE_SERVER`, `JAVASCRIPT`]"} schema={{"type":"string","enum":["UNKNOWN","ANDROID","IOS","WEB","GO_SERVER","NODE_SERVER","JAVASCRIPT"],"default":"UNKNOWN"}}></SchemaItem><SchemaItem collapsible={false} name={"sdkVersion"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+
+A successful response.
+
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>segmentUsers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"segmentId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>users</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"segmentId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"userId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`INCLUDED`, `EXCLUDED`]"} schema={{"type":"string","enum":["INCLUDED","EXCLUDED"],"default":"INCLUDED"}}></SchemaItem><SchemaItem collapsible={false} name={"deleted"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"string","format":"int64"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"deletedSegmentIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"requestedAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"string","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"forceUpdate"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"segmentUsers\": [\n    {\n      \"segmentId\": \"string\",\n      \"users\": [\n        {\n          \"id\": \"string\",\n          \"segmentId\": \"string\",\n          \"userId\": \"string\",\n          \"state\": \"INCLUDED\",\n          \"deleted\": true\n        }\n      ],\n      \"updatedAt\": \"string\"\n    }\n  ],\n  \"deletedSegmentIds\": [\n    \"string\"\n  ],\n  \"requestedAt\": \"string\",\n  \"forceUpdate\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"default"} value={"default"}><div>
+
+An unexpected error response.
+
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"code"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>details</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"@type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"code\": 0,\n  \"message\": \"string\",\n  \"details\": [\n    {\n      \"@type\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
+