@taskeren/bungie-api-ts 5.10.0

package/generated-src/groupv2/api.ts

@@ -0,0 +1,515 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+
+import { HttpClient, get, post } from '../http.js';
+
+import {
+  BungieMembershipType,
+  ServerResponse
+} from '../common.js';
+import {
+  ClanBanner,
+  EntityActionResult,
+  GetGroupsForMemberResponse,
+  GroupApplicationListRequest,
+  GroupApplicationRequest,
+  GroupApplicationResponse,
+  GroupBanRequest,
+  GroupDateRange,
+  GroupEditAction,
+  GroupMemberLeaveResult,
+  GroupMembershipSearchResponse,
+  GroupNameSearchRequest,
+  GroupOptionalConversation,
+  GroupOptionalConversationAddRequest,
+  GroupOptionalConversationEditRequest,
+  GroupOptionsEditAction,
+  GroupPotentialMemberStatus,
+  GroupPotentialMembershipSearchResponse,
+  GroupQuery,
+  GroupResponse,
+  GroupSearchResponse,
+  GroupTheme,
+  GroupType,
+  GroupV2Card,
+  GroupsForMemberFilter,
+  RuntimeGroupMemberType,
+  SearchResultOfGroupBan,
+  SearchResultOfGroupEditHistory,
+  SearchResultOfGroupMember,
+  SearchResultOfGroupMemberApplication
+} from './interfaces.js';
+
+const API_BASE = "https://www.bungie.net/Platform/GroupV2/";
+
+/** Returns a list of all available group avatars for the signed-in user. */
+export function getAvailableAvatars(http: HttpClient): Promise<ServerResponse<{ [key: number]: string }>> {
+  return get(http, `${API_BASE}GetAvailableAvatars/`);
+}
+
+/** Returns a list of all available group themes. */
+export function getAvailableThemes(http: HttpClient): Promise<ServerResponse<GroupTheme[]>> {
+  return get(http, `${API_BASE}GetAvailableThemes/`);
+}
+
+export interface GetUserClanInviteSettingParams {
+  /** The Destiny membership type of the account we wish to access settings. */
+  mType: BungieMembershipType;
+}
+
+/**
+ * Gets the state of the user's clan invite preferences for a particular membership
+ * type - true if they wish to be invited to clans, false otherwise.
+ */
+export function getUserClanInviteSetting(http: HttpClient, params: GetUserClanInviteSettingParams): Promise<ServerResponse<boolean>> {
+  return get(http, `${API_BASE}GetUserClanInviteSetting/${params.mType}/`);
+}
+
+export interface GetRecommendedGroupsParams {
+  /** Requested range in which to pull recommended groups */
+  createDateRange: GroupDateRange;
+  /** Type of groups requested */
+  groupType: GroupType;
+}
+
+/**
+ * Gets groups recommended for you based on the groups to whom those you follow
+ * belong.
+ */
+export function getRecommendedGroups(http: HttpClient, params: GetRecommendedGroupsParams): Promise<ServerResponse<GroupV2Card[]>> {
+    return post(http, `${API_BASE}Recommended/${params.groupType}/${params.createDateRange}/`);
+}
+
+/** Search for Groups. */
+export function groupSearch(http: HttpClient, body: GroupQuery): Promise<ServerResponse<GroupSearchResponse>> {
+    return post(http, `${API_BASE}Search/`, body);
+}
+
+export interface GetGroupParams {
+  /** Requested group's id. */
+  groupId: string;
+}
+
+/** Get information about a specific group of the given ID. */
+export function getGroup(http: HttpClient, params: GetGroupParams): Promise<ServerResponse<GroupResponse>> {
+  return get(http, `${API_BASE}${params.groupId}/`);
+}
+
+export interface GetGroupByNameParams {
+  /** Exact name of the group to find. */
+  groupName: string;
+  /** Type of group to find. */
+  groupType: GroupType;
+}
+
+/** Get information about a specific group with the given name and type. */
+export function getGroupByName(http: HttpClient, params: GetGroupByNameParams): Promise<ServerResponse<GroupResponse>> {
+  return get(http, `${API_BASE}Name/${params.groupName}/${params.groupType}/`);
+}
+
+/**
+ * Get information about a specific group with the given name and type. The POST
+ * version.
+ */
+export function getGroupByNameV2(http: HttpClient, body: GroupNameSearchRequest): Promise<ServerResponse<GroupResponse>> {
+    return post(http, `${API_BASE}NameV2/`, body);
+}
+
+export interface GetGroupOptionalConversationsParams {
+  /** Requested group's id. */
+  groupId: string;
+}
+
+/** Gets a list of available optional conversation channels and their settings. */
+export function getGroupOptionalConversations(http: HttpClient, params: GetGroupOptionalConversationsParams): Promise<ServerResponse<GroupOptionalConversation[]>> {
+  return get(http, `${API_BASE}${params.groupId}/OptionalConversations/`);
+}
+
+export interface EditGroupParams {
+  /** Group ID of the group to edit. */
+  groupId: string;
+}
+
+/**
+ * Edit an existing group. You must have suitable permissions in the group to
+ * perform this operation. This latest revision will only edit the fields you pass
+ * in - pass null for properties you want to leave unaltered.
+ */
+export function editGroup(http: HttpClient, params: EditGroupParams, body: GroupEditAction): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/Edit/`, body);
+}
+
+export interface EditClanBannerParams {
+  /** Group ID of the group to edit. */
+  groupId: string;
+}
+
+/**
+ * Edit an existing group's clan banner. You must have suitable permissions in the
+ * group to perform this operation. All fields are required.
+ */
+export function editClanBanner(http: HttpClient, params: EditClanBannerParams, body: ClanBanner): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/EditClanBanner/`, body);
+}
+
+export interface EditFounderOptionsParams {
+  /** Group ID of the group to edit. */
+  groupId: string;
+}
+
+/**
+ * Edit group options only available to a founder. You must have suitable
+ * permissions in the group to perform this operation.
+ */
+export function editFounderOptions(http: HttpClient, params: EditFounderOptionsParams, body: GroupOptionsEditAction): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/EditFounderOptions/`, body);
+}
+
+export interface AddOptionalConversationParams {
+  /** Group ID of the group to edit. */
+  groupId: string;
+}
+
+/**
+ * Add a new optional conversation/chat channel. Requires admin permissions to the
+ * group.
+ */
+export function addOptionalConversation(http: HttpClient, params: AddOptionalConversationParams, body: GroupOptionalConversationAddRequest): Promise<ServerResponse<string>> {
+    return post(http, `${API_BASE}${params.groupId}/OptionalConversations/Add/`, body);
+}
+
+export interface EditOptionalConversationParams {
+  /** Conversation Id of the channel being edited. */
+  conversationId: string;
+  /** Group ID of the group to edit. */
+  groupId: string;
+}
+
+/**
+ * Edit the settings of an optional conversation/chat channel. Requires admin
+ * permissions to the group.
+ */
+export function editOptionalConversation(http: HttpClient, params: EditOptionalConversationParams, body: GroupOptionalConversationEditRequest): Promise<ServerResponse<string>> {
+    return post(http, `${API_BASE}${params.groupId}/OptionalConversations/Edit/${params.conversationId}/`, body);
+}
+
+export interface GetMembersOfGroupParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 items per page. */
+  currentpage: number;
+  /** The ID of the group. */
+  groupId: string;
+  /** Filter out other member types. Use None for all members. */
+  memberType?: RuntimeGroupMemberType;
+  /**
+   * The name fragment upon which a search should be executed for members with
+   * matching display or unique names.
+   */
+  nameSearch?: string;
+}
+
+/** Get the list of members in a given group. */
+export function getMembersOfGroup(http: HttpClient, params: GetMembersOfGroupParams): Promise<ServerResponse<SearchResultOfGroupMember>> {
+  const strParams: Record<string, string> = {};
+  if (params.memberType !== undefined) { strParams.memberType = params.memberType.toString(); }
+  if (params.nameSearch !== undefined) { strParams.nameSearch = params.nameSearch; }
+  return get(http, `${API_BASE}${params.groupId}/Members/`, strParams);
+}
+
+export interface GetAdminsAndFounderOfGroupParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 items per page. */
+  currentpage: number;
+  /** The ID of the group. */
+  groupId: string;
+}
+
+/** Get the list of members in a given group who are of admin level or higher. */
+export function getAdminsAndFounderOfGroup(http: HttpClient, params: GetAdminsAndFounderOfGroupParams): Promise<ServerResponse<SearchResultOfGroupMember>> {
+  return get(http, `${API_BASE}${params.groupId}/AdminsAndFounder/`);
+}
+
+export interface EditGroupMembershipParams {
+  /** ID of the group to which the member belongs. */
+  groupId: string;
+  /** Membership ID to modify. */
+  membershipId: string;
+  /** Membership type of the provide membership ID. */
+  membershipType: BungieMembershipType;
+  /** New membertype for the specified member. */
+  memberType: RuntimeGroupMemberType;
+}
+
+/**
+ * Edit the membership type of a given member. You must have suitable permissions
+ * in the group to perform this operation.
+ */
+export function editGroupMembership(http: HttpClient, params: EditGroupMembershipParams): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/${params.membershipType}/${params.membershipId}/SetMembershipType/${params.memberType}/`);
+}
+
+export interface KickMemberParams {
+  /** Group ID to kick the user from. */
+  groupId: string;
+  /** Membership ID to kick. */
+  membershipId: string;
+  /** Membership type of the provided membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Kick a member from the given group, forcing them to reapply if they wish to re-
+ * join the group. You must have suitable permissions in the group to perform this
+ * operation.
+ */
+export function kickMember(http: HttpClient, params: KickMemberParams): Promise<ServerResponse<GroupMemberLeaveResult>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/${params.membershipType}/${params.membershipId}/Kick/`);
+}
+
+export interface BanMemberParams {
+  /** Group ID that has the member to ban. */
+  groupId: string;
+  /** Membership ID of the member to ban from the group. */
+  membershipId: string;
+  /** Membership type of the provided membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Bans the requested member from the requested group for the specified period of
+ * time.
+ */
+export function banMember(http: HttpClient, params: BanMemberParams, body: GroupBanRequest): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/${params.membershipType}/${params.membershipId}/Ban/`, body);
+}
+
+export interface UnbanMemberParams {
+  groupId: string;
+  /** Membership ID of the member to unban from the group */
+  membershipId: string;
+  /** Membership type of the provided membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/** Unbans the requested member, allowing them to re-apply for membership. */
+export function unbanMember(http: HttpClient, params: UnbanMemberParams): Promise<ServerResponse<number>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/${params.membershipType}/${params.membershipId}/Unban/`);
+}
+
+export interface GetBannedMembersOfGroupParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 entries. */
+  currentpage: number;
+  /** Group ID whose banned members you are fetching */
+  groupId: string;
+}
+
+/**
+ * Get the list of banned members in a given group. Only accessible to group Admins
+ * and above. Not applicable to all groups. Check group features.
+ */
+export function getBannedMembersOfGroup(http: HttpClient, params: GetBannedMembersOfGroupParams): Promise<ServerResponse<SearchResultOfGroupBan>> {
+  return get(http, `${API_BASE}${params.groupId}/Banned/`);
+}
+
+export interface GetGroupEditHistoryParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 entries. */
+  currentpage: number;
+  /** Group ID whose edit history you are fetching */
+  groupId: string;
+}
+
+/**
+ * Get the list of edits made to a given group. Only accessible to group Admins and
+ * above.
+ */
+export function getGroupEditHistory(http: HttpClient, params: GetGroupEditHistoryParams): Promise<ServerResponse<SearchResultOfGroupEditHistory>> {
+  return get(http, `${API_BASE}${params.groupId}/EditHistory/`);
+}
+
+export interface AbdicateFoundershipParams {
+  /** The new founder for this group. Must already be a group admin. */
+  founderIdNew: string;
+  /** The target group id. */
+  groupId: string;
+  /** Membership type of the provided founderIdNew. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * An administrative method to allow the founder of a group or clan to give up
+ * their position to another admin permanently.
+ */
+export function abdicateFoundership(http: HttpClient, params: AbdicateFoundershipParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}${params.groupId}/Admin/AbdicateFoundership/${params.membershipType}/${params.founderIdNew}/`);
+}
+
+export interface GetPendingMembershipsParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 items per page. */
+  currentpage: number;
+  /** ID of the group. */
+  groupId: string;
+}
+
+/**
+ * Get the list of users who are awaiting a decision on their application to join a
+ * given group. Modified to include application info.
+ */
+export function getPendingMemberships(http: HttpClient, params: GetPendingMembershipsParams): Promise<ServerResponse<SearchResultOfGroupMemberApplication>> {
+  return get(http, `${API_BASE}${params.groupId}/Members/Pending/`);
+}
+
+export interface GetInvitedIndividualsParams {
+  /** Page number (starting with 1). Each page has a fixed size of 50 items per page. */
+  currentpage: number;
+  /** ID of the group. */
+  groupId: string;
+}
+
+/** Get the list of users who have been invited into the group. */
+export function getInvitedIndividuals(http: HttpClient, params: GetInvitedIndividualsParams): Promise<ServerResponse<SearchResultOfGroupMemberApplication>> {
+  return get(http, `${API_BASE}${params.groupId}/Members/InvitedIndividuals/`);
+}
+
+export interface ApproveAllPendingParams {
+  /** ID of the group. */
+  groupId: string;
+}
+
+/** Approve all of the pending users for the given group. */
+export function approveAllPending(http: HttpClient, params: ApproveAllPendingParams, body: GroupApplicationRequest): Promise<ServerResponse<EntityActionResult[]>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/ApproveAll/`, body);
+}
+
+export interface DenyAllPendingParams {
+  /** ID of the group. */
+  groupId: string;
+}
+
+/** Deny all of the pending users for the given group. */
+export function denyAllPending(http: HttpClient, params: DenyAllPendingParams, body: GroupApplicationRequest): Promise<ServerResponse<EntityActionResult[]>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/DenyAll/`, body);
+}
+
+export interface ApprovePendingForListParams {
+  /** ID of the group. */
+  groupId: string;
+}
+
+/** Approve all of the pending users for the given group. */
+export function approvePendingForList(http: HttpClient, params: ApprovePendingForListParams, body: GroupApplicationListRequest): Promise<ServerResponse<EntityActionResult[]>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/ApproveList/`, body);
+}
+
+export interface ApprovePendingParams {
+  /** ID of the group. */
+  groupId: string;
+  /** The membership id being approved. */
+  membershipId: string;
+  /** Membership type of the supplied membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Approve the given membershipId to join the group/clan as long as they have
+ * applied.
+ */
+export function approvePending(http: HttpClient, params: ApprovePendingParams, body: GroupApplicationRequest): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/Approve/${params.membershipType}/${params.membershipId}/`, body);
+}
+
+export interface DenyPendingForListParams {
+  /** ID of the group. */
+  groupId: string;
+}
+
+/** Deny all of the pending users for the given group that match the passed-in . */
+export function denyPendingForList(http: HttpClient, params: DenyPendingForListParams, body: GroupApplicationListRequest): Promise<ServerResponse<EntityActionResult[]>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/DenyList/`, body);
+}
+
+export interface GetGroupsForMemberParams {
+  /** Filter apply to list of joined groups. */
+  filter: GroupsForMemberFilter;
+  /** Type of group the supplied member founded. */
+  groupType: GroupType;
+  /** Membership ID to for which to find founded groups. */
+  membershipId: string;
+  /** Membership type of the supplied membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/** Get information about the groups that a given member has joined. */
+export function getGroupsForMember(http: HttpClient, params: GetGroupsForMemberParams): Promise<ServerResponse<GetGroupsForMemberResponse>> {
+  return get(http, `${API_BASE}User/${params.membershipType}/${params.membershipId}/${params.filter}/${params.groupType}/`);
+}
+
+export interface RecoverGroupForFounderParams {
+  /** Type of group the supplied member founded. */
+  groupType: GroupType;
+  /** Membership ID to for which to find founded groups. */
+  membershipId: string;
+  /** Membership type of the supplied membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Allows a founder to manually recover a group they can see in game but not on
+ * bungie.net
+ */
+export function recoverGroupForFounder(http: HttpClient, params: RecoverGroupForFounderParams): Promise<ServerResponse<GroupMembershipSearchResponse>> {
+  return get(http, `${API_BASE}Recover/${params.membershipType}/${params.membershipId}/${params.groupType}/`);
+}
+
+export interface GetPotentialGroupsForMemberParams {
+  /** Filter apply to list of potential joined groups. */
+  filter: GroupPotentialMemberStatus;
+  /** Type of group the supplied member applied. */
+  groupType: GroupType;
+  /** Membership ID to for which to find applied groups. */
+  membershipId: string;
+  /** Membership type of the supplied membership ID. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Get information about the groups that a given member has applied to or been
+ * invited to.
+ */
+export function getPotentialGroupsForMember(http: HttpClient, params: GetPotentialGroupsForMemberParams): Promise<ServerResponse<GroupPotentialMembershipSearchResponse>> {
+  return get(http, `${API_BASE}User/Potential/${params.membershipType}/${params.membershipId}/${params.filter}/${params.groupType}/`);
+}
+
+export interface IndividualGroupInviteParams {
+  /** ID of the group you would like to join. */
+  groupId: string;
+  /** Membership id of the account being invited. */
+  membershipId: string;
+  /** MembershipType of the account being invited. */
+  membershipType: BungieMembershipType;
+}
+
+/** Invite a user to join this group. */
+export function individualGroupInvite(http: HttpClient, params: IndividualGroupInviteParams, body: GroupApplicationRequest): Promise<ServerResponse<GroupApplicationResponse>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/IndividualInvite/${params.membershipType}/${params.membershipId}/`, body);
+}
+
+export interface IndividualGroupInviteCancelParams {
+  /** ID of the group you would like to join. */
+  groupId: string;
+  /** Membership id of the account being cancelled. */
+  membershipId: string;
+  /** MembershipType of the account being cancelled. */
+  membershipType: BungieMembershipType;
+}
+
+/** Cancels a pending invitation to join a group. */
+export function individualGroupInviteCancel(http: HttpClient, params: IndividualGroupInviteCancelParams): Promise<ServerResponse<GroupApplicationResponse>> {
+    return post(http, `${API_BASE}${params.groupId}/Members/IndividualInviteCancel/${params.membershipType}/${params.membershipId}/`);
+}

package/generated-src/groupv2/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Bungie.Net API
+ * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
+ *
+ * OpenAPI spec version: 2.21.9
+ * Contact: support@bungie.com
+ *
+ * NOTE: This class is auto generated by the bungie-api-ts code generator program.
+ * https://github.com/DestinyItemManager/bungie-api-ts
+ * Do not edit these files manually.
+ */
+
+export * from '../common.js';
+export * from '../platform.js';
+export type {HttpClientConfig, HttpClient} from '../http.js';
+export * from './api.js';
+export * from './interfaces.js';