@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/events/list.mdx

@@ -0,0 +1,246 @@
+---
+descriptions:
+  list_events:
+    after: >-
+      Pagination cursor to receive records after a provided event ID. Mutually
+      exclusive with the `range_start` parameter.
+    range_start: >-
+      ISO 8601 formatted date range start for a stream of events. Can be
+      provided without `range_end` to fetch all events since `range_start`.
+      Mutually exclusive with the `after` parameter.
+    range_end: ISO 8601 formatted date range end for a stream of events.
+    events: Filter to only return events of particular types.
+    organization_id: >-
+      Filter to only return events belonging only to specific Organizations.
+      User events (e.g user.created) will not be Organization specific.
+    limit: >-
+      Maximum number of records to return. Accepts values between `1` and `100`.
+      Default is `10`.
+    data: List of the corresponding event objects.
+reference:
+  curl:
+    - key: list_events
+      type: GET
+      id: list_events
+      url: /reference/events/list
+      title: /events
+      parameters:
+        - key: events
+          type: array
+          description: (list_events.events)
+        - key: organization_id
+          type: string
+          description: (list_events.organization_id)
+        - key: limit
+          optional: true
+          type: number
+          description: (list_events.limit)
+        - key: range_start
+          optional: true
+          type: string
+          description: (list_events.range_start)
+        - key: range_end
+          optional: true
+          type: string
+          description: (list_events.range_end)
+        - key: after
+          optional: true
+          type: string
+          description: (list_events.after)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_events.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (after)
+  js:
+    - key: listEvents
+      id: list_events
+      url: /reference/events/list
+      title: events.listEvents()
+      parameters:
+        - key: events
+          type: 'EventNames[]'
+          description: (list_events.events)
+        - key: limit
+          optional: true
+          type: number
+          description: (list_events.limit)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (list_events.limit)
+        - key: rangeStart
+          optional: true
+          type: string
+          description: (list_events.range_start)
+        - key: rangeEnd
+          optional: true
+          type: string
+          description: (list_events.range_end)
+        - key: after
+          optional: true
+          type: string
+          description: >-
+            Pagination cursor to receive records after a provided event ID.
+            Mutually exclusive with the `rangeStart` parameter.
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Event[]'
+              description: (list_events.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (after)
+  go:
+    - key: ListEvents
+      id: list_events
+      url: /reference/events/list
+      title: events.ListEvents()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: events.ListEventsOpts
+          expanded: true
+          properties:
+            - key: Events
+              type: '[]string'
+              description: (list_events.events)
+            - key: Limit
+              optional: true
+              type: int
+            - key: OrganizationId
+              optional: true
+              type: int
+              description: (list_events.limit)
+            - key: RangeStart
+              optional: true
+              type: string
+              description: >-
+                Date range start for stream of events. Mutually exclusive with
+                the `After` parameter.
+            - key: RangeEnd
+              optional: true
+              type: string
+              description: (list_events.range_end)
+            - key: After
+              optional: true
+              type: string
+              description: >-
+                Pagination cursor to receive records after a provided event ID.
+                Mutually exclusive with the `RangeStart` parameter.
+      returns:
+        - key: list
+          type: events.ListEventsResponse
+          expanded: true
+          properties:
+            - key: Data
+              type: '[]events.Event'
+              description: (list_events.data)
+            - key: ListMetadata
+              type: common.ListMetadata
+              properties:
+                - (After)
+        - (err)
+  ruby:
+    - key: list_events
+      id: list_events
+      url: /reference/events/list
+      title: Events.list_events()
+      parameters:
+        - key: events
+          type: 'Array[String]'
+          description: (list_events.events)
+        - key: limit
+          optional: true
+          type: Integer
+          description: (list_events.limit)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (list_events.limit)
+        - key: range_start
+          optional: true
+          type: String
+          description: (list_events.range_start)
+        - key: range_end
+          optional: true
+          type: String
+          description: (list_events.range_end)
+        - key: after
+          optional: true
+          type: String
+          description: (list_events.after)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[Event]'
+              description: (list_events.data)
+            - key: list_metadata
+              type: Struct
+              properties:
+                - (after)
+  python:
+    - key: list_events
+      id: list_events
+      url: /reference/events/list
+      title: events.list_events()
+      parameters:
+        - key: events
+          type: 'Sequence[EventType]'
+          description: (list_events.events)
+        - key: limit
+          optional: true
+          type: int
+        - key: organization_id
+          optional: true
+          type: str
+          description: (list_events.limit)
+        - key: range_start
+          optional: true
+          type: str
+          description: (list_events.range_start)
+        - key: range_end
+          optional: true
+          type: str
+          description: (list_events.range_end)
+        - key: after
+          optional: true
+          type: str
+          description: (list_events.after)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[Event]'
+              description: (list_events.data)
+            - key: list_metadata
+              type: ListAfterMetadata
+              properties:
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/events/list.mdx
+---
+
+## List events
+
+Get a list of all of events up to 30 days old.
+
+<CodeBlock referenceId="list_events">
+  <CodeBlockTab title="Request" file="list-events-request" />
+  <CodeBlockTab title="Response" file="list-events-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/batch-check.mdx

@@ -0,0 +1,277 @@
+---
+descriptions:
+  check:
+    batch_op: >
+      Returns a list of check results (one for each check provided in `checks`).
+      The order of this list will match the order of `checks`.
+reference:
+  curl:
+    - key: batch_check
+      id: batch_check
+      url: /reference/fga/batch-check
+      title: /fga/v1/check
+      type: POST
+      parameters:
+        - key: warrant_token
+          type: string
+          optional: true
+          description: (warrant.warrant_token_header)
+        - key: op
+          type: '"batch"'
+          description: (check.op)
+        - key: checks
+          type: array
+          expanded: true
+          properties:
+            - (warrant.resource_type)
+            - (warrant.resource_id)
+            - (warrant.relation)
+            - (warrant.subject)
+            - key: context
+              type: object
+              optional: true
+              description: (check.context)
+      returns:
+        - key: results
+          type: array
+          properties:
+            - key: result
+              type: string
+              description: (check.check_result.result)
+            - key: is_implicit
+              type: boolean
+              description: (check.check_result.is_implicit)
+            - key: warrant_token
+              type: string
+              description: (check.check_result.warrant_token)
+  js:
+    - key: batchCheck
+      id: batch_check
+      url: /reference/fga/batch-check
+      title: fga.checkBatch()
+      parameters:
+        - key: options
+          type: object
+          properties:
+            - key: checks
+              type: array
+              properties:
+                - key: resource
+                  type: object
+                  unwrap: true
+                  properties:
+                    - key: resourceType
+                      type: string
+                      description: (warrant.resource_type)
+                    - key: resourceId
+                      type: string
+                      description: (warrant.resource_id)
+                - key: relation
+                  type: string
+                  description: (warrant.relation)
+                - key: subject
+                  type: object
+                  unwrap: true
+                  properties:
+                    - key: resourceType
+                      type: string
+                    - key: resourceId
+                      type: string
+                    - key: relation
+                      type: string
+                      optional: true
+                - key: context
+                  type: object
+                  optional: true
+                  description: (check.context)
+        - key: requestOptions
+          type: object
+          optional: true
+          properties:
+            - key: warrantToken
+              type: string
+              optional: true
+              description: (warrant.warrant_token)
+      returns:
+        - key: checkResults
+          type: array
+          properties:
+            - key: result
+              type: string
+              description: (check.check_result.result)
+            - key: isImplicit
+              type: boolean
+              description: (check.check_result.is_implicit)
+            - key: warrantToken
+              type: string
+              description: (check.check_result.warrant_token)
+  go:
+    - key: BatchCheck
+      id: batch_check
+      url: /reference/fga/batch-check
+      title: fga.BatchCheck()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.BatchCheckOpts
+          expanded: true
+          properties:
+            - key: Checks
+              type: array
+              expanded: true
+              properties:
+                - key: ResourceType
+                  type: string
+                  description: (warrant.resource_type)
+                - key: ResourceId
+                  type: string
+                  description: (warrant.resource_id)
+                - key: Relation
+                  type: string
+                  description: (warrant.relation)
+                - key: Subject
+                  type: fga.Subject
+                  properties:
+                    - key: ResourceType
+                      type: string
+                    - key: ResourceId
+                      type: string
+                    - key: Relation
+                      type: string
+                      optional: true
+                - key: Context
+                  type: 'map[string]interface{}'
+                  optional: true
+                  description: (check.context)
+            - key: WarrantToken
+              type: string
+              optional: true
+              description: (warrant.warrant_token)
+      returns:
+        - key: checkResponses
+          type: '[]fga.CheckResponse'
+          properties:
+            - key: Result
+              type: string
+              description: (check.check_result.result)
+            - key: IsImplicit
+              type: bool
+              description: (check.check_result.is_implicit)
+            - key: WarrantToken
+              type: string
+              description: (check.check_result.warrant_token)
+  java:
+    - key: batchCheck
+      id: batch_check
+      url: /reference/fga/batch-check
+      title: fga.checkBatch()
+      parameters:
+        - key: options
+          type: CheckBatchOptions
+          properties:
+            - key: op
+              type: '"batch"'
+              description: (check.op)
+            - key: checks
+              type: List<WarrantCheckOptions>
+              properties:
+                - key: resourceType
+                  type: String
+                  description: (warrant.resource_type)
+                - key: resourceId
+                  type: String
+                  description: (warrant.resource_id)
+                - key: relation
+                  type: String
+                  description: (warrant.relation)
+                - key: subject
+                  type: Subject
+                  description: (warrant.subject)
+                - key: context
+                  type: 'Map<String, Any>'
+                  optional: true
+                  description: (check.context)
+        - key: requestOptions
+          type: CheckRequestOptions
+          optional: true
+          properties:
+            - key: warrantToken
+              type: String
+              optional: true
+              description: (warrant.warrant_token)
+      returns:
+        - key: checkResults
+          type: Array<CheckResponse>
+          properties:
+            - key: result
+              type: String
+              description: (check.check_result.result)
+            - key: isImplicit
+              type: boolean
+              description: (check.check_result.is_implicit)
+            - key: warrantToken
+              type: string
+              description: (check.check_result.warrant_token)
+  python:
+    - key: batch_check
+      id: batch_check
+      url: /reference/fga/batch-check
+      title: fga.check_batch()
+      parameters:
+        - key: warrant_token
+          type: str
+          optional: true
+          description: (warrant.warrant_token)
+        - key: checks
+          expanded: true
+          type: 'List[Dict[str, Any]]'
+          properties:
+            - key: resource_type
+              type: str
+              description: (warrant.resource_type)
+            - key: resource_id
+              type: str
+              description: (warrant.resource_id)
+            - key: relation
+              type: str
+              description: (warrant.relation)
+            - key: subject
+              type: 'Dict[str, Any]'
+              properties:
+                - key: resource_type
+                  type: str
+                - key: resource_id
+                  type: str
+                - key: relation
+                  type: str
+                  optional: true
+            - key: context
+              type: 'Dict[str, Any]'
+              optional: true
+              description: (check.context)
+      returns:
+        - key: results
+          type: 'List[CheckResponse]'
+          properties:
+            - key: result
+              type: str
+              description: (check.check_result.result)
+            - key: is_implicit
+              type: bool
+              description: (check.check_result.is_implicit)
+            - key: warrant_token
+              type: string
+              description: (check.check_result.warrant_token)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/batch-check.mdx
+---
+
+---
+
+# Batch Check
+
+Executes a batch of checks and returns a list of results in a single operation.
+
+<CodeBlock referenceId="batch_check">
+  <CodeBlockTab title="Request" file="batch-check-request" />
+  <CodeBlockTab title="Response" file="batch-check-response" />
+</CodeBlock>