Class OrgsClient


  • public class OrgsClient
    extends java.lang.Object
    • Field Detail

      • connectionsClient

        protected final java.util.function.Supplier<ConnectionsClient> connectionsClient
      • offChrtProviderOrgClient

        protected final java.util.function.Supplier<OffChrtProviderOrgClient> offChrtProviderOrgClient
      • offChrtShipperOrgClient

        protected final java.util.function.Supplier<OffChrtShipperOrgClient> offChrtShipperOrgClient
      • complianceDocumentsClient

        protected final java.util.function.Supplier<ComplianceDocumentsClient> complianceDocumentsClient
      • privateDataClient

        protected final java.util.function.Supplier<PrivateDataClient> privateDataClient
      • orgProfilesClient

        protected final java.util.function.Supplier<OrgProfilesClient> orgProfilesClient
      • publicDataClient

        protected final java.util.function.Supplier<PublicDataClient> publicDataClient
    • Constructor Detail

    • Method Detail

      • withRawResponse

        public RawOrgsClient withRawResponse()
        Get responses with HTTP metadata like headers
      • getInfoV1

        public OrgInfoResponse getInfoV1()
        Retrieves basic organization information from the authentication service. | () -> (OrgInfoResponse)
      • getInfoV1

        public OrgInfoResponse getInfoV1​(RequestOptions requestOptions)
        Retrieves basic organization information from the authentication service. | () -> (OrgInfoResponse)
      • listMembersV1

        public OrgMemberListRes listMembersV1()
        Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
      • listMembersV1

        public OrgMemberListRes listMembersV1​(OrgsListMembersV1Request request)
        Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
      • listMembersV1

        public OrgMemberListRes listMembersV1​(OrgsListMembersV1Request request,
                                              RequestOptions requestOptions)
        Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
      • setupOrgV1

        public boolean setupOrgV1​(SetupOrgReq request)
        Single onboarding entry point. Sets org_type in WorkOS JWT metadata (immutable once set) and idempotently creates org_private_data + org_public_data for the caller's organization. Optional handle and company_name populate the public doc on first call; later updates go through PATCH /orgs/org_public_data/v1. Returns True on success (including idempotent retries), 400 on org_type conflict or handle collision. | (SetupOrgReq) -> (bool)
      • setupOrgV1

        public boolean setupOrgV1​(SetupOrgReq request,
                                  RequestOptions requestOptions)
        Single onboarding entry point. Sets org_type in WorkOS JWT metadata (immutable once set) and idempotently creates org_private_data + org_public_data for the caller's organization. Optional handle and company_name populate the public doc on first call; later updates go through PATCH /orgs/org_public_data/v1. Returns True on success (including idempotent retries), 400 on org_type conflict or handle collision. | (SetupOrgReq) -> (bool)
      • getStripeConnectAccountIdV1

        public java.lang.String getStripeConnectAccountIdV1()
        Retrieves the Stripe Connect account ID for the caller's organization. Returns 404 if not set. | () -> (str)
      • getStripeConnectAccountIdV1

        public java.lang.String getStripeConnectAccountIdV1​(RequestOptions requestOptions)
        Retrieves the Stripe Connect account ID for the caller's organization. Returns 404 if not set. | () -> (str)