net.accelbyte.sdk.api.social.operations.user_statistic.UpdateUserStatItemValue1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
AccelByte Gaming Services Java Extend SDK generated from OpenAPI specs
There is a newer version: 0.69.0
/*
 * Copyright (c) 2022 AccelByte Inc. All Rights Reserved
 * This is licensed software from AccelByte Inc, for limitations
 * and restrictions contact your company contract manager.
 *
 * Code generated. DO NOT EDIT.
 */

package net.accelbyte.sdk.api.social.operations.user_statistic;

import java.io.*;
import java.util.*;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import net.accelbyte.sdk.api.social.models.*;
import net.accelbyte.sdk.core.HttpResponseException;
import net.accelbyte.sdk.core.Operation;
import net.accelbyte.sdk.core.util.Helper;

/**
 * updateUserStatItemValue_1
 *
 * Public update user's statitem value for a given namespace and user with a certain update
 * strategy. There are four supported update strategies: + *OVERRIDE*: update user statitem with the
 * new value + *INCREMENT*: increment user statitem with the specified value + *MAX*: update user
 * statitem with the specified value if it's larger than the existing value + *MIN*: update user
 * statitem with the specified value if it's lower than the existing value
 *
 * 
The *additionalKey* parameter will be suffixed to *userId* and is used to support multi level
 * user's statitems, such as character's statitems. If provided, user's statitems will be saved with
 * key: *userId_additionalKey*
 *
 * Other detail info: + *Required permission*:
 * resource="NAMESPACE:{namespace}:USER:{userId}:STATITEM", action=4 (UPDATE) + *Returns*: updated
 * user's statItem
 */
@Getter
@Setter
public class UpdateUserStatItemValue1 extends Operation {
  /** generated field's value */
  private String path =
      "/social/v2/public/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value";

  private String method = "PUT";
  private List consumes = Arrays.asList("application/json");
  private List produces = Arrays.asList("application/json");
  private String locationQuery = null;

  /** fields as input parameter */
  private String namespace;

  private String statCode;
  private String userId;
  private String additionalKey;
  private StatItemUpdate body;

  /**
   * @param namespace required
   * @param statCode required
   * @param userId required
   */
  @Builder
  // @deprecated 2022-08-29 - All args constructor may cause problems. Use builder instead.
  @Deprecated
  public UpdateUserStatItemValue1(
      String namespace, String statCode, String userId, String additionalKey, StatItemUpdate body) {
    this.namespace = namespace;
    this.statCode = statCode;
    this.userId = userId;
    this.additionalKey = additionalKey;
    this.body = body;

    securities.add("Bearer");
  }

  @Override
  public Map getPathParams() {
    Map pathParams = new HashMap<>();
    if (this.namespace != null) {
      pathParams.put("namespace", this.namespace);
    }
    if (this.statCode != null) {
      pathParams.put("statCode", this.statCode);
    }
    if (this.userId != null) {
      pathParams.put("userId", this.userId);
    }
    return pathParams;
  }

  @Override
  public Map> getQueryParams() {
    Map> queryParams = new HashMap<>();
    queryParams.put(
        "additionalKey", this.additionalKey == null ? null : Arrays.asList(this.additionalKey));
    return queryParams;
  }

  @Override
  public StatItemUpdate getBodyParams() {
    return this.body;
  }

  @Override
  public boolean isValid() {
    if (this.namespace == null) {
      return false;
    }
    if (this.statCode == null) {
      return false;
    }
    if (this.userId == null) {
      return false;
    }
    return true;
  }

  public StatItemIncResult parseResponse(int code, String contentType, InputStream payload)
      throws HttpResponseException, IOException {
    if (code != 200) {
      final String json = Helper.convertInputStreamToString(payload);
      throw new HttpResponseException(code, json);
    }
    final String json = Helper.convertInputStreamToString(payload);
    return new StatItemIncResult().createFromJson(json);
  }

  @Override
  protected Map getCollectionFormatMap() {
    Map result = new HashMap<>();
    result.put("additionalKey", "None");
    return result;
  }
}