async-playfab-web-sdk 1.192.250526-1

package/dist/Experimentation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts","../src/PlayFabContext.ts","../src/PlayFabCommon.ts","../src/apis/PlayFabExperimentationApi.ts"],"sourcesContent":["export interface ISettings {\n  /** You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) */\n  titleId: string;\n  /** For security reasons you must never expose this value to the client or players - You must set this value for Server-APIs to work properly (Found in the Game Manager for your title, at the PlayFab Website) */\n  developerSecretKey: string;\n  productionServerUrl: string;\n  GlobalHeaderInjection?: { [key: string]: string };\n  /** The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this */\n  verticalName?: string | null;\n}\n\nexport const AuthInfoMap = {\n  \"X-EntityToken\": {\n    authAttr: \"entityToken\",\n    authError: \"errorEntityToken\",\n  },\n  \"X-Authorization\": {\n    authAttr: \"sessionTicket\",\n    authError: \"errorLoggedIn\",\n  },\n  \"X-SecretKey\": {\n    authAttr: \"developerSecretKey\",\n    authError: \"errorSecretKey\",\n  },\n};\n\nexport default {\n  sdkVersion: \"1.192.250526\",\n  sdkFingerprint: \"JavaScriptSDK-1.192.250526\",\n  buildIdentifier: \"custom_async-javascriptsdk\",\n  defaultSettings: {\n    titleId: \"\",\n    developerSecretKey: \"\",\n    GlobalHeaderInjection: {},\n    productionServerUrl: \".playfabapi.com\",\n    verticalName: null\n  } as ISettings\n};\n","import constants, { type ISettings } from \"./constants\";\n\nexport type AuthContext = {\n  PlayFabId: string | null;\n  EntityId: string | null;\n  EntityType: string | null;\n  SessionTicket: string | null;\n  EntityToken: string | null;\n};\n\nexport class PlayFabContext {\n  private static _instance: PlayFabContext;\n\n  settings: ISettings = constants.defaultSettings;\n\n  authenticationContext: AuthContext = {\n    PlayFabId: null,\n    EntityId: null,\n    EntityType: null,\n    SessionTicket: null,\n    EntityToken: null,\n  };\n\n  sessionTicket: string | null = null;\n\n  entityToken: string | null = null;\n\n  private constructor() {}\n\n  public static get instance(): PlayFabContext {\n    if (!PlayFabContext._instance) {\n      PlayFabContext._instance = new PlayFabContext();\n    }\n\n    return PlayFabContext._instance;\n  }\n}\n","import constants, { ISettings, AuthInfoMap } from \"./constants\";\nimport { AuthContext, PlayFabContext } from \"./PlayFabContext\";\nimport { IPlayFabError, IPlayFabResultCommon } from \"./types/PlayFab\";\n\nexport class PlayFabCommon {\n  buildIdentifier: string = constants.buildIdentifier;\n  requestGetParams = {\n    sdk: constants.sdkFingerprint,\n  } as const;\n  errorTitleId = \"Must be have settings.titleId set to call this method\";\n  errorLoggedIn = \"Must be logged in to call this method\";\n  errorEntityToken =\n    \"You must successfully call GetEntityToken before calling this\";\n  errorSecretKey =\n    \"Must have settings.developerSecretKey set to call this method\";\n  private _context = PlayFabContext.instance;\n\n  constructor(settings: Partial<ISettings> | undefined = undefined) {\n    if (settings) {\n      Object.assign(this._context.settings, settings);\n    }\n  }\n\n  get settings() {\n    return this._context.settings;\n  }\n\n  get authenticationContext() {\n    return this._context.authenticationContext;\n  }\n\n  get sessionTicket() {\n    return this._context.sessionTicket;\n  }\n\n  set sessionTicket(value: string | null) {\n    this._context.sessionTicket = value;\n  }\n\n  get entityToken() {\n    return this._context.entityToken;\n  }\n\n  set entityToken(value: string | null) {\n    this._context.entityToken = value;\n  }\n\n  GetServerUrl() {\n    if (!(this.settings.productionServerUrl.substring(0, 4) === \"http\")) {\n      return `https://${this.settings.verticalName || this.settings.titleId}${\n        this.settings.productionServerUrl\n      }`;\n    } else {\n      return this.settings.productionServerUrl;\n    }\n  }\n\n  InjectHeaders(\n    xhr: XMLHttpRequest,\n    headersObj: Record<string, string> | undefined\n  ) {\n    if (!headersObj) return;\n\n    for (const headerKey in headersObj) {\n      try {\n        xhr.setRequestHeader(headerKey, headersObj[headerKey]);\n      } catch (e) {\n        console.log(\n          `Failed to append header: ${headerKey} = ${headersObj[headerKey]} Error: ${e}`\n        );\n      }\n    }\n  }\n\n  ExecuteRequest<T extends IPlayFabResultCommon>(\n    url: string,\n    body: any,\n    authkey: string | null,\n    authValue: string | null,\n    customData: any,\n    extraHeaders?: Record<string, string>\n  ): Promise<T> {\n    return new Promise((resolve, reject) => {\n      if (body == null) body = {};\n\n      var startTime = new Date().getTime();\n      var requestBody = JSON.stringify(body);\n\n      var urlArr = [url];\n      var getParams = this.requestGetParams;\n      if (getParams != null) {\n        var firstParam = true;\n        for (var key in getParams) {\n          if (firstParam) {\n            urlArr.push(\"?\");\n            firstParam = false;\n          } else {\n            urlArr.push(\"&\");\n          }\n          urlArr.push(key);\n          urlArr.push(\"=\");\n          urlArr.push(getParams[key as keyof typeof getParams]);\n        }\n      }\n\n      var completeUrl = urlArr.join(\"\");\n\n      var xhr = new XMLHttpRequest();\n      xhr.open(\"POST\", completeUrl, true);\n\n      xhr.setRequestHeader(\"Content-Type\", \"application/json\");\n      xhr.setRequestHeader(\n        \"X-PlayFabSDK\",\n        \"JavaScriptSDK-\" + constants.sdkVersion\n      );\n      if (authkey != null) {\n        xhr.setRequestHeader(authkey, authValue!);\n      }\n      this.InjectHeaders(xhr, this.settings.GlobalHeaderInjection);\n      this.InjectHeaders(xhr, extraHeaders);\n\n      xhr.onloadend = () => {\n        var result = this.GetPlayFabResponse(body, xhr, startTime, customData);\n        if (result.code === 200) {\n          resolve(result.data || result);\n        } else {\n          reject(result);\n        }\n      };\n\n      xhr.onerror = () => {\n        var result = this.GetPlayFabResponse(body, xhr, startTime, customData);\n        reject(result);\n      };\n\n      xhr.send(requestBody);\n    });\n  }\n\n  GetPlayFabResponse(\n    request: any,\n    xhr: XMLHttpRequest,\n    startTime: number,\n    customData: any\n  ) {\n    var result = null as any;\n    try {\n      // window.console.log(\"parsing json result: \" + xhr.responseText);\n      result = JSON.parse(xhr.responseText);\n    } catch (e) {\n      result = {\n        code: 503, // Service Unavailable\n        status: \"Service Unavailable\",\n        error: \"Connection error\",\n        errorCode: 2, // PlayFabErrorCode.ConnectionError\n        errorMessage: xhr.responseText,\n      };\n    }\n\n    result.CallBackTimeMS = new Date().getTime() - startTime;\n    result.Request = request;\n    result.CustomData = customData;\n    return result;\n  }\n\n  UpdateAuthenticationContext(currentAuthContext: AuthContext, result: any) {\n    var authenticationContextUpdates = {} as AuthContext;\n    if (result?.PlayFabId) {\n      authenticationContextUpdates.PlayFabId = result.PlayFabId;\n    }\n    if (result?.SessionTicket) {\n      authenticationContextUpdates.SessionTicket = result.SessionTicket;\n    }\n    if (result?.EntityToken) {\n      authenticationContextUpdates.EntityId = result.EntityToken.Entity.Id;\n      authenticationContextUpdates.EntityType = result.EntityToken.Entity.Type;\n      authenticationContextUpdates.EntityToken = result.EntityToken.EntityToken;\n    }\n    // Update the authenticationContext with values from the result\n    currentAuthContext = Object.assign(\n      currentAuthContext,\n      authenticationContextUpdates\n    );\n\n    this._context.authenticationContext = currentAuthContext;\n\n    return currentAuthContext;\n  }\n\n  GetAuthInfo(request: any, authKey: string) {\n    // Use the most-recently saved authKey, unless one was provided in the request via the AuthenticationContext\n    var authError = AuthInfoMap[authKey as keyof typeof AuthInfoMap].authError;\n    var authAttr = AuthInfoMap[authKey as keyof typeof AuthInfoMap].authAttr;\n    var defaultAuthValue: string | null = null;\n    if (authAttr === \"entityToken\") defaultAuthValue = this.entityToken;\n    else if (authAttr === \"sessionTicket\")\n      defaultAuthValue = this.sessionTicket;\n    else if (authAttr === \"developerSecretKey\")\n      defaultAuthValue = this.settings.developerSecretKey;\n    var authValue = request.AuthenticationContext\n      ? request.AuthenticationContext[authAttr]\n      : defaultAuthValue;\n    return { authKey, authValue, authError };\n  }\n\n  ExecuteRequestWrapper<T extends IPlayFabResultCommon>(\n    apiURL: string,\n    request: any,\n    authKey: string | null,\n    customData: any,\n    extraHeaders?: Record<string, string>\n  ) {\n    var authValue = null;\n    if (authKey !== null) {\n      const { authError, ...authInfo } = this.GetAuthInfo(request, authKey);\n      authKey = authInfo.authKey;\n      authValue = authInfo.authValue;\n      if (!authValue) throw authError;\n    }\n    return this.ExecuteRequest<T>(\n      this.GetServerUrl() + apiURL,\n      request,\n      authKey,\n      authValue,\n      customData,\n      extraHeaders\n    );\n  }\n\n  GenerateErrorReport(error: IPlayFabError | null): string {\n    if (error == null) return \"\";\n    var fullErrors = error.errorMessage;\n    for (var paramName in error.errorDetails)\n      for (var msgIdx in error.errorDetails[paramName])\n        fullErrors +=\n          \"\\n\" + paramName + \": \" + error.errorDetails[paramName][msgIdx];\n    return fullErrors;\n  }\n\n  ForgetAllCredentials() {\n    this._context.sessionTicket = null;\n    this._context.entityToken = null;\n  }\n}\n","import type { EmptyResponse } from \"../types/PlayFab\";\nimport type {\n\n  CreateExclusionGroupRequest,\n  CreateExperimentRequest,\n  DeleteExclusionGroupRequest,\n  DeleteExperimentRequest,\n  GetExclusionGroupsRequest,\n  GetExclusionGroupTrafficRequest,\n  GetExperimentsRequest,\n  GetLatestScorecardRequest,\n  GetTreatmentAssignmentRequest,\n  StartExperimentRequest,\n  StopExperimentRequest,\n  UpdateExclusionGroupRequest,\n  UpdateExperimentRequest,\n  CreateExclusionGroupResult,\n  CreateExperimentResult,\n  GetExclusionGroupsResult,\n  GetExclusionGroupTrafficResult,\n  GetExperimentsResult,\n  GetLatestScorecardResult,\n  GetTreatmentAssignmentResult,\n} from \"../types/PlayFabExperimentationApi\";\nimport { PlayFabCommon } from \"../PlayFabCommon\";\n\nexport default class PlayFabExperimentationApi extends PlayFabCommon {\n\n    /**\n     * Creates a new experiment exclusion group for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexclusiongroup\n     */\n    CreateExclusionGroup (request: CreateExclusionGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<CreateExclusionGroupResult>(\"/Experimentation/CreateExclusionGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Creates a new experiment for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexperiment\n     */\n    CreateExperiment (request: CreateExperimentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<CreateExperimentResult>(\"/Experimentation/CreateExperiment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Deletes an existing exclusion group for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexclusiongroup\n     */\n    DeleteExclusionGroup (request: DeleteExclusionGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/DeleteExclusionGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Deletes an existing experiment for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexperiment\n     */\n    DeleteExperiment (request: DeleteExperimentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/DeleteExperiment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Gets the details of all exclusion groups for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongroups\n     */\n    GetExclusionGroups (request: GetExclusionGroupsRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<GetExclusionGroupsResult>(\"/Experimentation/GetExclusionGroups\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Gets the details of all exclusion groups for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongrouptraffic\n     */\n    GetExclusionGroupTraffic (request: GetExclusionGroupTrafficRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<GetExclusionGroupTrafficResult>(\"/Experimentation/GetExclusionGroupTraffic\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Gets the details of all experiments for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexperiments\n     */\n    GetExperiments (request: GetExperimentsRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<GetExperimentsResult>(\"/Experimentation/GetExperiments\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Gets the latest scorecard of the experiment for the title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getlatestscorecard\n     */\n    GetLatestScorecard (request: GetLatestScorecardRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<GetLatestScorecardResult>(\"/Experimentation/GetLatestScorecard\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Gets the treatment assignments for a player for every running experiment in the title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/gettreatmentassignment\n     */\n    GetTreatmentAssignment (request: GetTreatmentAssignmentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<GetTreatmentAssignmentResult>(\"/Experimentation/GetTreatmentAssignment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Starts an existing experiment for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/startexperiment\n     */\n    StartExperiment (request: StartExperimentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/StartExperiment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Stops an existing experiment for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/stopexperiment\n     */\n    StopExperiment (request: StopExperimentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/StopExperiment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Updates an existing exclusion group for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexclusiongroup\n     */\n    UpdateExclusionGroup (request: UpdateExclusionGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/UpdateExclusionGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n    /**\n     * Updates an existing experiment for a title.\n     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexperiment\n     */\n    UpdateExperiment (request: UpdateExperimentRequest, customData?: any, extraHeaders?: Record<string, string>) {\n        return this.ExecuteRequestWrapper<EmptyResponse>(\"/Experimentation/UpdateExperiment\", request, \"X-EntityToken\", customData, extraHeaders);\n    }\n\n};\n"],"mappings":";AAWO,IAAM,cAAc;AAAA,EACzB,iBAAiB;AAAA,IACf,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AAAA,EACA,mBAAmB;AAAA,IACjB,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AAAA,EACA,eAAe;AAAA,IACb,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AACF;AAEA,IAAO,oBAAQ;AAAA,EACb,YAAY;AAAA,EACZ,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,IACf,SAAS;AAAA,IACT,oBAAoB;AAAA,IACpB,uBAAuB,CAAC;AAAA,IACxB,qBAAqB;AAAA,IACrB,cAAc;AAAA,EAChB;AACF;;;AC3BO,IAAM,iBAAN,MAAM,gBAAe;AAAA,EAiBlB,cAAc;AAdtB,oBAAsB,kBAAU;AAEhC,iCAAqC;AAAA,MACnC,WAAW;AAAA,MACX,UAAU;AAAA,MACV,YAAY;AAAA,MACZ,eAAe;AAAA,MACf,aAAa;AAAA,IACf;AAEA,yBAA+B;AAE/B,uBAA6B;AAAA,EAEN;AAAA,EAEvB,WAAkB,WAA2B;AAC3C,QAAI,CAAC,gBAAe,WAAW;AAC7B,sBAAe,YAAY,IAAI,gBAAe;AAAA,IAChD;AAEA,WAAO,gBAAe;AAAA,EACxB;AACF;;;AChCO,IAAM,gBAAN,MAAoB;AAAA,EAazB,YAAY,WAA2C,QAAW;AAZlE,2BAA0B,kBAAU;AACpC,4BAAmB;AAAA,MACjB,KAAK,kBAAU;AAAA,IACjB;AACA,wBAAe;AACf,yBAAgB;AAChB,4BACE;AACF,0BACE;AACF,SAAQ,WAAW,eAAe;AAGhC,QAAI,UAAU;AACZ,aAAO,OAAO,KAAK,SAAS,UAAU,QAAQ;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,IAAI,WAAW;AACb,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,wBAAwB;AAC1B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,gBAAgB;AAClB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,cAAc,OAAsB;AACtC,SAAK,SAAS,gBAAgB;AAAA,EAChC;AAAA,EAEA,IAAI,cAAc;AAChB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,YAAY,OAAsB;AACpC,SAAK,SAAS,cAAc;AAAA,EAC9B;AAAA,EAEA,eAAe;AACb,QAAI,EAAE,KAAK,SAAS,oBAAoB,UAAU,GAAG,CAAC,MAAM,SAAS;AACnE,aAAO,WAAW,KAAK,SAAS,gBAAgB,KAAK,SAAS,OAAO,GACnE,KAAK,SAAS,mBAChB;AAAA,IACF,OAAO;AACL,aAAO,KAAK,SAAS;AAAA,IACvB;AAAA,EACF;AAAA,EAEA,cACE,KACA,YACA;AACA,QAAI,CAAC,WAAY;AAEjB,eAAW,aAAa,YAAY;AAClC,UAAI;AACF,YAAI,iBAAiB,WAAW,WAAW,SAAS,CAAC;AAAA,MACvD,SAAS,GAAG;AACV,gBAAQ;AAAA,UACN,4BAA4B,SAAS,MAAM,WAAW,SAAS,CAAC,WAAW,CAAC;AAAA,QAC9E;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,eACE,KACA,MACA,SACA,WACA,YACA,cACY;AACZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,QAAQ,KAAM,QAAO,CAAC;AAE1B,UAAI,aAAY,oBAAI,KAAK,GAAE,QAAQ;AACnC,UAAI,cAAc,KAAK,UAAU,IAAI;AAErC,UAAI,SAAS,CAAC,GAAG;AACjB,UAAI,YAAY,KAAK;AACrB,UAAI,aAAa,MAAM;AACrB,YAAI,aAAa;AACjB,iBAAS,OAAO,WAAW;AACzB,cAAI,YAAY;AACd,mBAAO,KAAK,GAAG;AACf,yBAAa;AAAA,UACf,OAAO;AACL,mBAAO,KAAK,GAAG;AAAA,UACjB;AACA,iBAAO,KAAK,GAAG;AACf,iBAAO,KAAK,GAAG;AACf,iBAAO,KAAK,UAAU,GAA6B,CAAC;AAAA,QACtD;AAAA,MACF;AAEA,UAAI,cAAc,OAAO,KAAK,EAAE;AAEhC,UAAI,MAAM,IAAI,eAAe;AAC7B,UAAI,KAAK,QAAQ,aAAa,IAAI;AAElC,UAAI,iBAAiB,gBAAgB,kBAAkB;AACvD,UAAI;AAAA,QACF;AAAA,QACA,mBAAmB,kBAAU;AAAA,MAC/B;AACA,UAAI,WAAW,MAAM;AACnB,YAAI,iBAAiB,SAAS,SAAU;AAAA,MAC1C;AACA,WAAK,cAAc,KAAK,KAAK,SAAS,qBAAqB;AAC3D,WAAK,cAAc,KAAK,YAAY;AAEpC,UAAI,YAAY,MAAM;AACpB,YAAI,SAAS,KAAK,mBAAmB,MAAM,KAAK,WAAW,UAAU;AACrE,YAAI,OAAO,SAAS,KAAK;AACvB,kBAAQ,OAAO,QAAQ,MAAM;AAAA,QAC/B,OAAO;AACL,iBAAO,MAAM;AAAA,QACf;AAAA,MACF;AAEA,UAAI,UAAU,MAAM;AAClB,YAAI,SAAS,KAAK,mBAAmB,MAAM,KAAK,WAAW,UAAU;AACrE,eAAO,MAAM;AAAA,MACf;AAEA,UAAI,KAAK,WAAW;AAAA,IACtB,CAAC;AAAA,EACH;AAAA,EAEA,mBACE,SACA,KACA,WACA,YACA;AACA,QAAI,SAAS;AACb,QAAI;AAEF,eAAS,KAAK,MAAM,IAAI,YAAY;AAAA,IACtC,SAAS,GAAG;AACV,eAAS;AAAA,QACP,MAAM;AAAA;AAAA,QACN,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,WAAW;AAAA;AAAA,QACX,cAAc,IAAI;AAAA,MACpB;AAAA,IACF;AAEA,WAAO,kBAAiB,oBAAI,KAAK,GAAE,QAAQ,IAAI;AAC/C,WAAO,UAAU;AACjB,WAAO,aAAa;AACpB,WAAO;AAAA,EACT;AAAA,EAEA,4BAA4B,oBAAiC,QAAa;AACxE,QAAI,+BAA+B,CAAC;AACpC,QAAI,iCAAQ,WAAW;AACrB,mCAA6B,YAAY,OAAO;AAAA,IAClD;AACA,QAAI,iCAAQ,eAAe;AACzB,mCAA6B,gBAAgB,OAAO;AAAA,IACtD;AACA,QAAI,iCAAQ,aAAa;AACvB,mCAA6B,WAAW,OAAO,YAAY,OAAO;AAClE,mCAA6B,aAAa,OAAO,YAAY,OAAO;AACpE,mCAA6B,cAAc,OAAO,YAAY;AAAA,IAChE;AAEA,yBAAqB,OAAO;AAAA,MAC1B;AAAA,MACA;AAAA,IACF;AAEA,SAAK,SAAS,wBAAwB;AAEtC,WAAO;AAAA,EACT;AAAA,EAEA,YAAY,SAAc,SAAiB;AAEzC,QAAI,YAAY,YAAY,OAAmC,EAAE;AACjE,QAAI,WAAW,YAAY,OAAmC,EAAE;AAChE,QAAI,mBAAkC;AACtC,QAAI,aAAa,cAAe,oBAAmB,KAAK;AAAA,aAC/C,aAAa;AACpB,yBAAmB,KAAK;AAAA,aACjB,aAAa;AACpB,yBAAmB,KAAK,SAAS;AACnC,QAAI,YAAY,QAAQ,wBACpB,QAAQ,sBAAsB,QAAQ,IACtC;AACJ,WAAO,EAAE,SAAS,WAAW,UAAU;AAAA,EACzC;AAAA,EAEA,sBACE,QACA,SACA,SACA,YACA,cACA;AACA,QAAI,YAAY;AAChB,QAAI,YAAY,MAAM;AACpB,YAAM,EAAE,WAAW,GAAG,SAAS,IAAI,KAAK,YAAY,SAAS,OAAO;AACpE,gBAAU,SAAS;AACnB,kBAAY,SAAS;AACrB,UAAI,CAAC,UAAW,OAAM;AAAA,IACxB;AACA,WAAO,KAAK;AAAA,MACV,KAAK,aAAa,IAAI;AAAA,MACtB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,oBAAoB,OAAqC;AACvD,QAAI,SAAS,KAAM,QAAO;AAC1B,QAAI,aAAa,MAAM;AACvB,aAAS,aAAa,MAAM;AAC1B,eAAS,UAAU,MAAM,aAAa,SAAS;AAC7C,sBACE,OAAO,YAAY,OAAO,MAAM,aAAa,SAAS,EAAE,MAAM;AACpE,WAAO;AAAA,EACT;AAAA,EAEA,uBAAuB;AACrB,SAAK,SAAS,gBAAgB;AAC9B,SAAK,SAAS,cAAc;AAAA,EAC9B;AACF;;;ACzNA,IAAqB,4BAArB,cAAuD,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAMjE,qBAAsB,SAAsC,YAAkB,cAAuC;AACjH,WAAO,KAAK,sBAAkD,yCAAyC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7J;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAkB,SAAkC,YAAkB,cAAuC;AACzG,WAAO,KAAK,sBAA8C,qCAAqC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACrJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAsB,SAAsC,YAAkB,cAAuC;AACjH,WAAO,KAAK,sBAAqC,yCAAyC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAChJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAkB,SAAkC,YAAkB,cAAuC;AACzG,WAAO,KAAK,sBAAqC,qCAAqC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC5I;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,mBAAoB,SAAoC,YAAkB,cAAuC;AAC7G,WAAO,KAAK,sBAAgD,uCAAuC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACzJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,yBAA0B,SAA0C,YAAkB,cAAuC;AACzH,WAAO,KAAK,sBAAsD,6CAA6C,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACrK;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAgB,SAAgC,YAAkB,cAAuC;AACrG,WAAO,KAAK,sBAA4C,mCAAmC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACjJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,mBAAoB,SAAoC,YAAkB,cAAuC;AAC7G,WAAO,KAAK,sBAAgD,uCAAuC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACzJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,uBAAwB,SAAwC,YAAkB,cAAuC;AACrH,WAAO,KAAK,sBAAoD,2CAA2C,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACjK;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAiB,SAAiC,YAAkB,cAAuC;AACvG,WAAO,KAAK,sBAAqC,oCAAoC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC3I;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAgB,SAAgC,YAAkB,cAAuC;AACrG,WAAO,KAAK,sBAAqC,mCAAmC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC1I;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAsB,SAAsC,YAAkB,cAAuC;AACjH,WAAO,KAAK,sBAAqC,yCAAyC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAChJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAkB,SAAkC,YAAkB,cAAuC;AACzG,WAAO,KAAK,sBAAqC,qCAAqC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC5I;AAEJ;","names":[]}

package/dist/Groups.d.ts

@@ -0,0 +1,546 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
+
+interface AcceptGroupApplicationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Type of the entity to accept as. Must be the same entity as the claimant or an entity that is a child of the claimant
+     * entity.
+     */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface AcceptGroupInvitationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface AddMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** List of entities to add to the group. Only entities of type title_player_account and character may be added to groups. */
+    Members: EntityKey[];
+    /**
+     * Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the
+     * group will be used. Role IDs must be between 1 and 64 characters long.
+     */
+    RoleId?: string;
+}
+interface ApplyToGroupRequest extends IPlayFabRequestCommon {
+    /** Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application */
+    AutoAcceptOutstandingInvite?: boolean;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ApplyToGroupResponse extends IPlayFabResultCommon {
+    /** Type of entity that requested membership */
+    Entity?: EntityWithLineage;
+    /** When the application to join will expire and be deleted */
+    Expires: string;
+    /** ID of the group that the entity requesting membership to */
+    Group?: EntityKey;
+}
+interface BlockEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ChangeMemberRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1
+     * and 64 characters long.
+     */
+    DestinationRoleId?: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * List of entities to move between roles in the group. All entities in this list must be members of the group and origin
+     * role.
+     */
+    Members: EntityKey[];
+    /** The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long. */
+    OriginRoleId: string;
+}
+interface CreateGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The name of the group. This is unique at the title level by default. */
+    GroupName: string;
+}
+interface CreateGroupResponse extends IPlayFabResultCommon {
+    /** The ID of the administrator role for the group. */
+    AdminRoleId?: string;
+    /** The server date and time the group was created. */
+    Created: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The name of the group. */
+    GroupName?: string;
+    /** The ID of the default member role for the group. */
+    MemberRoleId?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles and names that belong to the group. */
+    Roles?: Record<string, string | null>;
+}
+interface CreateGroupRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64
+     * characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
+     */
+    RoleId: string;
+    /**
+     * The name of the role. This must be unique within the group and can be changed later. Role names must be between 1 and
+     * 100 characters long
+     */
+    RoleName: string;
+}
+interface CreateGroupRoleResponse extends IPlayFabResultCommon {
+    /** The current version of the group profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** ID for the role */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface DeleteGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** ID of the group or role to remove */
+    Group: EntityKey;
+}
+interface DeleteRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The ID of the role to delete. Role IDs must be between 1 and 64 characters long. */
+    RoleId?: string;
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    Id: string;
+    /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
+    Type?: string;
+}
+interface EntityMemberRole {
+    /** The list of members in the role */
+    Members?: EntityWithLineage[];
+    /** The ID of the role. */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface EntityWithLineage {
+    /** The entity key for the specified entity */
+    Key?: EntityKey;
+    /** Dictionary of entity keys for related entities. Dictionary key is entity type. */
+    Lineage?: Record<string, EntityKey>;
+}
+interface GetGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group?: EntityKey;
+    /** The full name of the group */
+    GroupName?: string;
+}
+interface GetGroupResponse extends IPlayFabResultCommon {
+    /** The ID of the administrator role for the group. */
+    AdminRoleId?: string;
+    /** The server date and time the group was created. */
+    Created: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The name of the group. */
+    GroupName?: string;
+    /** The ID of the default member role for the group. */
+    MemberRoleId?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles and names that belong to the group. */
+    Roles?: Record<string, string | null>;
+}
+interface GroupApplication {
+    /** Type of entity that requested membership */
+    Entity?: EntityWithLineage;
+    /** When the application to join will expire and be deleted */
+    Expires: string;
+    /** ID of the group that the entity requesting membership to */
+    Group?: EntityKey;
+}
+interface GroupBlock {
+    /** The entity that is blocked */
+    Entity?: EntityWithLineage;
+    /** ID of the group that the entity is blocked from */
+    Group: EntityKey;
+}
+interface GroupInvitation {
+    /** When the invitation will expire and be deleted */
+    Expires: string;
+    /** The group that the entity invited to */
+    Group?: EntityKey;
+    /** The entity that created the invitation */
+    InvitedByEntity?: EntityWithLineage;
+    /** The entity that is invited */
+    InvitedEntity?: EntityWithLineage;
+    /** ID of the role in the group to assign the user to. */
+    RoleId?: string;
+}
+interface GroupRole {
+    /** ID for the role */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface GroupWithRoles {
+    /** ID for the group */
+    Group?: EntityKey;
+    /** The name of the group */
+    GroupName?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles within the group */
+    Roles?: GroupRole[];
+}
+interface InviteToGroupRequest extends IPlayFabRequestCommon {
+    /** Optional, default true. Automatically accept an application if one exists instead of creating an invitation */
+    AutoAcceptOutstandingApplication?: boolean;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
+     * is not specified. Role IDs must be between 1 and 64 characters long.
+     */
+    RoleId?: string;
+}
+interface InviteToGroupResponse extends IPlayFabResultCommon {
+    /** When the invitation will expire and be deleted */
+    Expires: string;
+    /** The group that the entity invited to */
+    Group?: EntityKey;
+    /** The entity that created the invitation */
+    InvitedByEntity?: EntityWithLineage;
+    /** The entity that is invited */
+    InvitedEntity?: EntityWithLineage;
+    /** ID of the role in the group to assign the user to. */
+    RoleId?: string;
+}
+interface IsMemberRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * Optional: ID of the role to check membership of. Defaults to any role (that is, check to see if the entity is a member
+     * of the group in any capacity) if not specified.
+     */
+    RoleId?: string;
+}
+interface IsMemberResponse extends IPlayFabResultCommon {
+    /** A value indicating whether or not the entity is a member. */
+    IsMember: boolean;
+}
+interface ListGroupApplicationsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupApplicationsResponse extends IPlayFabResultCommon {
+    /** The requested list of applications to the group. */
+    Applications?: GroupApplication[];
+}
+interface ListGroupBlocksRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupBlocksResponse extends IPlayFabResultCommon {
+    /** The requested list blocked entities. */
+    BlockedEntities?: GroupBlock[];
+}
+interface ListGroupInvitationsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupInvitationsResponse extends IPlayFabResultCommon {
+    /** The requested list of group invitations. */
+    Invitations?: GroupInvitation[];
+}
+interface ListGroupMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** ID of the group to list the members and roles for */
+    Group: EntityKey;
+}
+interface ListGroupMembersResponse extends IPlayFabResultCommon {
+    /** The requested list of roles and member entity IDs. */
+    Members?: EntityMemberRole[];
+}
+interface ListMembershipOpportunitiesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface ListMembershipOpportunitiesResponse extends IPlayFabResultCommon {
+    /** The requested list of group applications. */
+    Applications?: GroupApplication[];
+    /** The requested list of group invitations. */
+    Invitations?: GroupInvitation[];
+}
+interface ListMembershipRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface ListMembershipResponse extends IPlayFabResultCommon {
+    /** The list of groups */
+    Groups?: GroupWithRoles[];
+}
+interface RemoveGroupApplicationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface RemoveGroupInvitationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface RemoveMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** List of entities to remove */
+    Members: EntityKey[];
+    /** The ID of the role to remove the entities from. */
+    RoleId?: string;
+}
+interface UnblockEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface UpdateGroupRequest extends IPlayFabRequestCommon {
+    /** Optional: the ID of an existing role to set as the new administrator role for the group */
+    AdminRoleId?: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the
+     * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any
+     * other clients since the version you last loaded.
+     */
+    ExpectedProfileVersion?: number;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** Optional: the new name of the group */
+    GroupName?: string;
+    /** Optional: the ID of an existing role to set as the new member role for the group */
+    MemberRoleId?: string;
+}
+interface UpdateGroupResponse extends IPlayFabResultCommon {
+    /** Optional reason to explain why the operation was the result that it was. */
+    OperationReason?: string;
+    /** New version of the group data. */
+    ProfileVersion: number;
+    /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
+    SetResult?: string;
+}
+interface UpdateGroupRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the
+     * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any
+     * other clients since the version you last loaded.
+     */
+    ExpectedProfileVersion?: number;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** ID of the role to update. Role IDs must be between 1 and 64 characters long. */
+    RoleId?: string;
+    /** The new name of the role */
+    RoleName: string;
+}
+interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
+    /** Optional reason to explain why the operation was the result that it was. */
+    OperationReason?: string;
+    /** New version of the role data. */
+    ProfileVersion: number;
+    /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
+    SetResult?: string;
+}
+
+declare class PlayFabGroupsApi extends PlayFabCommon {
+    /**
+     * Accepts an outstanding invitation to to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupapplication
+     */
+    AcceptGroupApplication(request: AcceptGroupApplicationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Accepts an invitation to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupinvitation
+     */
+    AcceptGroupInvitation(request: AcceptGroupInvitationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Adds members to a group or role.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/addmembers
+     */
+    AddMembers(request: AddMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Applies to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/applytogroup
+     */
+    ApplyToGroup(request: ApplyToGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ApplyToGroupResponse>;
+    /**
+     * Blocks a list of entities from joining a group.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/blockentity
+     */
+    BlockEntity(request: BlockEntityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Changes the role membership of a list of entities from one role to another.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/changememberrole
+     */
+    ChangeMemberRole(request: ChangeMemberRoleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Creates a new group.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/creategroup
+     */
+    CreateGroup(request: CreateGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateGroupResponse>;
+    /**
+     * Creates a new group role.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/createrole
+     */
+    CreateRole(request: CreateGroupRoleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateGroupRoleResponse>;
+    /**
+     * Deletes a group and all roles, invitations, join requests, and blocks associated with it.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/deletegroup
+     */
+    DeleteGroup(request: DeleteGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Deletes an existing role in a group.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/deleterole
+     */
+    DeleteRole(request: DeleteRoleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Gets information about a group and its roles
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/getgroup
+     */
+    GetGroup(request: GetGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetGroupResponse>;
+    /**
+     * Invites a player to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/invitetogroup
+     */
+    InviteToGroup(request: InviteToGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<InviteToGroupResponse>;
+    /**
+     * Checks to see if an entity is a member of a group or role within the group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/ismember
+     */
+    IsMember(request: IsMemberRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IsMemberResponse>;
+    /**
+     * Lists all outstanding requests to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupapplications
+     */
+    ListGroupApplications(request: ListGroupApplicationsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListGroupApplicationsResponse>;
+    /**
+     * Lists all entities blocked from joining a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupblocks
+     */
+    ListGroupBlocks(request: ListGroupBlocksRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListGroupBlocksResponse>;
+    /**
+     * Lists all outstanding invitations for a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupinvitations
+     */
+    ListGroupInvitations(request: ListGroupInvitationsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListGroupInvitationsResponse>;
+    /**
+     * Lists all members for a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupmembers
+     */
+    ListGroupMembers(request: ListGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListGroupMembersResponse>;
+    /**
+     * Lists all groups and roles for an entity
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembership
+     */
+    ListMembership(request: ListMembershipRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMembershipResponse>;
+    /**
+     * Lists all outstanding invitations and group applications for an entity
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembershipopportunities
+     */
+    ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMembershipOpportunitiesResponse>;
+    /**
+     * Removes an application to join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupapplication
+     */
+    RemoveGroupApplication(request: RemoveGroupApplicationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Removes an invitation join a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupinvitation
+     */
+    RemoveGroupInvitation(request: RemoveGroupInvitationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Removes members from a group.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removemembers
+     */
+    RemoveMembers(request: RemoveMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Unblocks a list of entities from joining a group
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/unblockentity
+     */
+    UnblockEntity(request: UnblockEntityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Updates non-membership data about a group.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/updategroup
+     */
+    UpdateGroup(request: UpdateGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateGroupResponse>;
+    /**
+     * Updates metadata about a role.
+     * https://docs.microsoft.com/rest/api/playfab/groups/groups/updaterole
+     */
+    UpdateRole(request: UpdateGroupRoleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateGroupRoleResponse>;
+}
+
+export { PlayFabGroupsApi as default };