openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
1,838 lines • 109 kB
TypeScript
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}, 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* 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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}, 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}, 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;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* 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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
}[];
pageToken: string;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: () => AsyncGenerator<{
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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
}[];
pageToken: string;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: null;
} & {
again: () => 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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
}[];
pageToken: string;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}, any, unknown>;
} & {
again: () => 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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
}[];
pageToken: string;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Invites a user to an organization.
* @endpoint POST /v1/organizations/{orgId}/invitations
*
* @param orgId The ID of the organization to invite a user to.
* @param userId The ID of the user to invite to the organization.
*
* @example
* const { data:inviteInfo } = await ClassicOrganizationsApi.createOrgInvitation({
orgId: "4244556007738484576", userId: 2655994471
})
* @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 createOrgInvitation: <OrgId extends Identifier, UserId extends Identifier>(this: any, args: {
orgId: OrgId;
userId: UserId;
}) => Promise<{
data: {
id: Identifier;
organizationId: OrgId;
recipientUserId: UserId;
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: {
id: Identifier;
organizationId: OrgId;
recipientUserId: UserId;
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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: {
id: Identifier;
organizationId: OrgId;
recipientUserId: UserId;
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: {
id: Identifier;
organizationId: OrgId;
recipientUserId: UserId;
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}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Invites a user to an organization.
* @endpoint DELETE /v1/organizations/{orgId}/invitations/{invitationId}
*
* @param orgId The ID of the organization to invite a user to.
* @param invitationId The ID of the invitation to remove.
*
* @example
* const { data:success } = await ClassicOrganizationsApi.removeOrgInvitation({
orgId: "4244556007738484576", invitationId: "2985153037232505065"
})
* @exampleData true
* @exampleRawBody { success: true }
*/
export declare const removeOrgInvitation: import("../../apiGroup/apiGroup.types").CallApiMethod<{
orgId: Identifier;
invitationId: 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: {
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 permissions for a specific member of an organization.
* @endpoint GET /v1/organizations/{orgId}/users/{userId}/permissions
*
* @param orgId The ID of the organization to get a users permissions for.
* @param userId The ID of the user to get permissions for.
*
* @example const { data:perms } = await ClassicOrganizationsApi.orgMemberPermissions({ orgId: "4244556007738484576", userId: 45348281 })
* @exampleData {"isOwner":true,"canConfigureOrganization":true,"canManageRoles":true,"canManageMembers":true,"canViewAnalytics":true,"canPlayExperiences":true,"canEditExperiences":true}
* @exampleRawBody {"isOwner":true,"canConfigureOrganization":true,"canManageRoles":true,"canManageMembers":true,"canViewAnalytics":true,"canPlayExperiences":true,"canEditExperiences":true}
*/
export declare const orgMemberPermissions: import("../../apiGroup/apiGroup.types").CallApiMethod<{
orgId: Identifier;
userId: 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: OrgMemberPermissionsData) => string) | undefined;
getCursorsFn?: ((rawData: {
isOwner: boolean;
canConfigureOrganization: boolean;
canManageRoles: boolean;
canManageMembers: boolean;
canViewAnalytics: boolean;
canPlayExperiences: boolean;
canEditExperiences: boolean;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
isOwner: boolean;
canConfigureOrganization: boolean;
canManageRoles: boolean;
canManageMembers: boolean;
canViewAnalytics: boolean;
canPlayExperiences: boolean;
canEditExperiences: boolean;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
isOwner: boolean;
canConfigureOrganization: boolean;
canManageRoles: boolean;
canManageMembers: boolean;
canViewAnalytics: boolean;
canPlayExperiences: boolean;
canEditExperiences: boolean;
} | undefined;
}, false>;
/**
* Gives a specifc role to an organization member.
* @endpoint POST /v1/organizations/{orgId}/users/{userId}/roles/{roleId}
*
* @param orgId The ID of the organization to give a user a role in.
* @param userId The ID of the user to give a role to.
* @param roleId The ID of the role to be given.
*
* @example
* const { data:success } = await ClassicOrganizationsApi.giveRoleToOrgMember({
orgId: "4244556007738484576", userId: 45348281, roleId: "914257001913009232"
})
* @exampleData { success: true }
* @exampleRawBody true
*/
export declare const giveRoleToOrgMember: import("../../apiGroup/apiGroup.types").CallApiMethod<{
orgId: Identifier;
userId: 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: {
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>;
/**
* Removes a specifc role from an organization member.
* @endpoint DELETE /v1/organizations/{orgId}/users/{userId}/roles/{roleId}
*
* @param orgId The ID of the organization to give a user a role in.
* @param userId The ID of the user to give a role to.
* @param roleId The ID of the role to be given.
*
* @example
* const { data:success } = await ClassicOrganizationsApi.removeRoleFromOrgMember({
orgId: "4244556007738484576", userId: 45348281, roleId: "914257001913009232"
})
* @exampleData { success: true }
* @exampleRawBody true
*/
export declare const removeRoleFromOrgMember: import("../../apiGroup/apiGroup.types").CallApiMethod<{
orgId: Identifier;
userId: 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: {
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>;
/**
* Creates a role in a specific organization.
* @endpoint POST /v1/organizations/{orgId}/roles
*
* @param orgId The ID of the organization to create a role in.
* @param roleName The name for the new role.
* @param roleColor The color for the new role.
*
* @example
* const { data } = await ClassicOrganizationsApi.createOrgRole({
orgId: "4244556007738484576", roleName: "Admin", roleColor: "LightOrange"
})
* @exampleData {"id":"4508567586590971666","organizationId":"4244556007738484576","name":"Admin","color":"LightOrange","updatedTime":2024-05-31T03:25:37.841Z}
* @exampleRawBody {"id":"4508567586590971666","organizationId":"4244556007738484576","name":"Admin","color":"LightOrange","updatedTime":"2024-05-31T03:25:37.8410158Z"}
*/
export declare const createOrgRole: <OrgId extends Identifier, RoleName extends string, RoleColor extends "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal">(this: any, args: {
orgId: OrgId;
roleName: RoleName;
roleColor: RoleColor;
}) => Promise<{
data: {
id: Identifier;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
updatedTime: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: Identifier;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: {
id: Identifier;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
updatedTime: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: Identifier;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Updates an existing role in a specific organization.
* @endpoint PATCH /v1/organizations/{orgId}/roles/{roleId}/metadata
*
* @param orgId The ID of the organization to update a role in.
* @param roleId The ID of the role to update.
* @param roleName The new name for the role.
* @param roleColor The new color for the role.
*
* @example
* const { data:updatedRoleInfo } = await ClassicOrganizationsApi.updateOrgRole({
orgId: "4244556007738484576", roleId: "517896615410563397", roleName: "Admin", roleColor: "LightOrange"
})
* @exampleData {"id":"4508567586590971666","organizationId":"4244556007738484576","name":"Admin","color":"LightOrange","updatedTime":2024-05-31T03:25:37.841Z}
* @exampleRawBody {"id":"4508567586590971666","organizationId":"4244556007738484576","name":"Admin","color":"LightOrange","updatedTime":"2024-05-31T03:25:37.8410158Z"}
*/
export declare const updateOrgRole: <OrgId extends Identifier, RoleId extends Identifier, RoleName extends string, RoleColor extends "Blue" | "Green" | "Purple" | "Yellow" | "Orange" | "Red" | "LightOrange" | "Pink" | "Teal">(this: any, args: {
orgId: OrgId;
roleId: RoleId;
roleName: RoleName;
roleColor: RoleColor;
}) => Promise<{
data: {
id: RoleId;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
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: RoleName;
color: RoleColor;
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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: {
id: RoleId;
organizationId: OrgId;
name: RoleName;
color: RoleColor;
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: RoleName;
color: RoleColor;
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}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Deletes a role from a specific organization.
* @endpoint DELETE /v1/organizations/{orgId}/roles/{roleId}
*
* @param orgId The ID of the organization to delete a role from.
* @param roleId The ID of the role to be deleted.
*
* @example
* const { data:success } = await ClassicOrganizationsApi.deleteOrgRole({
orgId: "4244556007738484576", roleId: "3960412067952396265"
})
* @exampleData true
* @exampleRawBody { success: true }
*/
export declare const deleteOrgRole: 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: {
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>;