openblox

import type { Identifier } from "typeforge"; import type { OrgMemberPermissionsData, OverwriteOrgRolePermissions_NewPermissions, PrettifiedOrgRolePermissionsData, RawOrgRolePermissionsData } from "./organizations.types"; /** * Gets organization info for a group. * @endpoint GET /v1/organizations * * @param groupId The ID of the group to get organization info about. * * @example const { data:orgInfo } = await ClassicOrganizationsApi.orgInfoForGroup({ groupId: 15842838 }) * @exampleData { id: "4244556007738484576", groupId: "15842838" } * @exampleRawBody { id: "4244556007738484576", groupId: "15842838" } */ export declare const orgInfoForGroup: <GroupId extends Identifier>(this: any, args: { groupId: GroupId; }) => Promise<{ data: { id: Identifier; groupId: GroupId; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: Identifier; groupId: GroupId; }; }; } & { again: () => Promise<{ data: { id: Identifier; groupId: GroupId; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: Identifier; groupId: GroupId; }; }; }>; }>; /** * Gets a page of roles for an organization. * @endpoint GET /v1/organizations/{orgId}/roles * * @param orgId The ID of the organization to get roles for. * @param limit The maximum amount of roles to return. * @param cursor The paging cursor for the previous or next page. * * @example const { data:roles } = await ClassicOrganizationsApi.orgRoles({ orgId: "4244556007738484576" }) * @exampleData [{"id":"2011766837304130930","organizationId":"4244556007738484576","name":"New Role 7275","color":"Green","updatedTime":"2024-05-31T02:34:51.832Z"},{"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime":"2024-05-31T01:24:02.823Z"},{"id":"3456593169348895666","organizationId":"4244556007738484576","name":"Tester","color":"Teal","updatedTime":"2024-05-31T01:24:02.827Z"}] * @exampleRawBody {"roles":[{"id":"2011766837304130930","organizationId":"4244556007738484576","name":"New Role 7275","color":"Green","updatedTime":"2024-05-31T02:34:51.8329242Z"},{"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime":"2024-05-31T01:24:02.8238408Z"},{"id":"3456593169348895666","organizationId":"4244556007738484576","name":"Tester","color":"Teal","updatedTime":"2024-05-31T01:24:02.8271342Z"}],"pageToken":""} */ export declare const orgRoles: <OrgId extends Identifier>(this: any, args: { orgId: OrgId; limit?: number | undefined; cursor?: string | undefined; }) => Promise<{ data: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; pageToken: string; }; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; pageToken: string; }; }; }>; }>; /** * Gets permissions for a specific role of an organization. * @endpoint GET /v1/organizations/{orgId}/roles/{roleId}/permissions * * @param orgId The ID of the organization to get a roles permissions for. * @param roleId The ID of the role to get permissions for. * * @example * const { data:perms } = await ClassicOrganizationsApi.orgRolePermissions({ * orgId: "4244556007738484576", roleId: "2011766837304130930" * }) * @exampleData [{"category":"Organization","operation":"ManageMembers","enabled":false},{"category":"Organization","operation":"ManageRoles","enabled":false},{"category":"Organization","operation":"Configure","enabled":false},{"category":"Experience","operation":"Play","enabled":false},{"category":"Experience","operation":"Edit","enabled":false},{"category":"Experience","operation":"ViewAnalytics","enabled":false}] * @exampleRawBody {"permissions":[{"category":"Organization","operation":"ManageMembers","enabled":false},{"category":"Organization","operation":"ManageRoles","enabled":false},{"category":"Organization","operation":"Configure","enabled":false},{"category":"Experience","operation":"Play","enabled":false},{"category":"Experience","operation":"Edit","enabled":false},{"category":"Experience","operation":"ViewAnalytics","enabled":false}]} */ export declare const orgRolePermissions: import("../../apiGroup/apiGroup.types").CallApiMethod<{ orgId: Identifier; roleId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawOrgRolePermissionsData) => string) | undefined; getCursorsFn?: ((rawData: { permissions: ({ category: "Organization"; operation: "ManageMembers"; enabled: boolean; } | { category: "Organization"; operation: "ManageRoles"; enabled: boolean; } | { category: "Organization"; operation: "Configure"; enabled: boolean; } | { category: "Experience"; operation: "Play"; enabled: boolean; } | { category: "Experience"; operation: "Edit"; enabled: boolean; } | { category: "Experience"; operation: "ViewAnalytics"; enabled: boolean; })[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { permissions: ({ category: "Organization"; operation: "ManageMembers"; enabled: boolean; } | { category: "Organization"; operation: "ManageRoles"; enabled: boolean; } | { category: "Organization"; operation: "Configure"; enabled: boolean; } | { category: "Experience"; operation: "Play"; enabled: boolean; } | { category: "Experience"; operation: "Edit"; enabled: boolean; } | { category: "Experience"; operation: "ViewAnalytics"; enabled: boolean; })[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: ({ category: "Organization"; operation: "ManageMembers"; enabled: boolean; } | { category: "Organization"; operation: "ManageRoles"; enabled: boolean; } | { category: "Organization"; operation: "Configure"; enabled: boolean; } | { category: "Experience"; operation: "Play"; enabled: boolean; } | { category: "Experience"; operation: "Edit"; enabled: boolean; } | { category: "Experience"; operation: "ViewAnalytics"; enabled: boolean; })[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawOrgRolePermissionsData, PrettifiedOrgRolePermissionsData>, false>; /** * Gets metadata for a specific role of an organization. * @endpoint GET /v1/organizations/{orgId}/roles/{roleId}/metadata * * @param orgId The ID of the organization to get a roles metadata for. * @param roleId The ID of the role to get metadata for. * * @example const { data:metadata } = await ClassicOrganizationsApi.orgRoleMetadata({ * orgId: "4244556007738484576", roleId: "914257001913009232" * }) * @exampleData {"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime": 2024-05-31T01:24:02.823Z} * @exampleRawBody {"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime":"2024-05-31T01:24:02.823Z"} */ export declare const orgRoleMetadata: <OrgId extends Identifier, RoleId extends Identifier>(this: any, args: { orgId: OrgId; roleId: RoleId; }) => Promise<{ data: { id: RoleId; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: RoleId; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }; }; } & { again: () => Promise<{ data: { id: RoleId; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: RoleId; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }; }; }>; }>; /** * Overwrites permissions for a role of an organizations. * @endpoint PATCH /v1/organizations/{orgId}/roles/{roleId}/permissions * * @param orgId The ID of the organization to overwrite a roles permissions in. * @param roleId The ID of the group to overwrite permissions for. * @param newPermissions The new permissions to assign to the role. * * @example * const { data:success } = await ClassicOrganizationsApi.overwriteOrgRolePermissions({ orgId: "4244556007738484576", roleId: "4500991930780611394", newPermissions: { manageMembers: true, manageRoles: true, configure: true, play: true, edit: true, viewAnalytics: true } }) * @exampleData true * @exampleRawBody { success: true } */ export declare const overwriteOrgRolePermissions: import("../../apiGroup/apiGroup.types").CallApiMethod<{ orgId: Identifier; roleId: Identifier; newPermissions: OverwriteOrgRolePermissions_NewPermissions; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { success: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { success: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { success: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ success: boolean; }, boolean>, false>; /** * Gets a page of members for a specific role in an organization. * @endpoint GET /v1/organizations/{orgId}/roles/{roleId}/users * * @param orgId The ID of the organization to get members for. * @param limit The maximum amount of members to return. * @param cursor The paging cursor for the previous or next page. * * @example * const { data:members } = await ClassicOrganizationsApi.orgRoleMembers({ orgId: "4244556007738484576", roleId: "4500991930780611394" }) * @exampleData [{"userId":"45348281","roles":[{"id":"4500991930780611394","organizationId":"4244556007738484576","name":"Orange","color":"Orange","updatedTime":2024-05-31T03:13:24.753Z}]}] * @exampleRawBody {"users":[{"userId":"45348281","roles":[{"id":"4500991930780611394","organizationId":"4244556007738484576","name":"Orange","color":"Orange","updatedTime":"2024-05-31T03:13:24.7539993Z"}]}],"pageToken":""} */ export declare const orgRoleMembers: <OrgId extends Identifier>(this: any, args: { orgId: Identifier; roleId: Identifier; limit?: number | undefined; cursor?: string | undefined; }) => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; }>; }>; /** * Gets a page of members for an organization. * @endpoint GET /v1/organizations/{orgId}/users * * @param orgId The ID of the organization to get members for. * @param limit The maximum amount of members to return. * @param cursor The paging cursor for the previous or next page. * * @example const { data:members } = await ClassicOrganizationsApi.orgMembers({ orgId: "4244556007738484576" }) * @exampleData [{"userId":"45348281","roles":[{"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime":"2024-05-31T01:24:02.823Z"}]}] * @exampleRawBody {"users":[{"userId":"45348281","roles":[{"id":"914257001913009232","organizationId":"4244556007738484576","name":"Developer","color":"LightOrange","updatedTime":"2024-05-31T01:24:02.8238408Z"}]}],"pageToken":""} */ export declare const orgMembers: <OrgId extends Identifier>(this: any, args: { orgId: OrgId; limit?: number | undefined; cursor?: string | undefined; }) => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: Date; }[]; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { users: { userId: Identifier; roles: { id: Identifier; organizationId: OrgId; name: string; color: "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`; }[]; }[]; pageToken: string; }; }; }>; }>; /** * Gets a page of members for an organization. * @endpoint GET /v1/organizations/{orgId}/users * * @param orgId The ID of the organization to get invitations for. * @param limit The maximum amount of roles to return. * @param cursor The paging cursor for the previous or next page. * * @example const { data:invitations } = await ClassicOrganizationsApi.orgInvitations({ orgId: "4244556007738484576" }) * @exampleData [{"id":"7659171709868310756","organizationId":"4244556007738484576","recipientUserId":"2655994471","senderUserId":"45348281","invitationStatusType":"Open","updatedTime":"2024-05-31T04:30:08.713Z"}] * @exampleRawBody {"invitations":[{"id":"7659171709868310756","organizationId":"4244556007738484576","recipientUserId":"2655994471","senderUserId":"45348281","invitationStatusType":"Open","updatedTime":"2024-05-31T04:30:08.713Z"}],"pageToken":""} */ export declare const orgInvitations: <OrgId extends Identifier>(this: any, args: { orgId: OrgId; limit?: number | undefined; cursor?: string | undefined; }) => Promise<{ data: { id: Identifier; organizationId: OrgId; recipientUserId: Identifier; senderUserId: Identifier; invitationStatusType: "Open"; updatedTime: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { invitations: { id: Identifier; organizationId: OrgId; recipientUserId: Identifier; senderUserId: Identifier; invitationStatusType: "Open"; updatedTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${