net.accelbyte.sdk.api.legal.operations.agreement.RetrieveAllUsersByPolicyVersion 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.67.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.legal.operations.agreement;

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

/**
 * retrieveAllUsersByPolicyVersion
 *
 * This API will return all users who has accepted a specific policy version.Other detail info: *
 * Required permission : resource="ADMIN:NAMESPACE:*:LEGAL", action=2 (READ)
 */
@Getter
@Setter
public class RetrieveAllUsersByPolicyVersion extends Operation {
  /** generated field's value */
  private String path = "/agreement/admin/agreements/policy-versions/users";

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

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

  private Integer limit;
  private Integer offset;
  private String policyVersionId;

  /**
   * @param policyVersionId required
   */
  @Builder
  // @deprecated 2022-08-29 - All args constructor may cause problems. Use builder instead.
  @Deprecated
  public RetrieveAllUsersByPolicyVersion(
      String keyword, Integer limit, Integer offset, String policyVersionId) {
    this.keyword = keyword;
    this.limit = limit;
    this.offset = offset;
    this.policyVersionId = policyVersionId;

    securities.add("Bearer");
  }

  @Override
  public Map> getQueryParams() {
    Map> queryParams = new HashMap<>();
    queryParams.put("keyword", this.keyword == null ? null : Arrays.asList(this.keyword));
    queryParams.put("limit", this.limit == null ? null : Arrays.asList(String.valueOf(this.limit)));
    queryParams.put(
        "offset", this.offset == null ? null : Arrays.asList(String.valueOf(this.offset)));
    queryParams.put(
        "policyVersionId",
        this.policyVersionId == null ? null : Arrays.asList(this.policyVersionId));
    return queryParams;
  }

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

  public PagedRetrieveUserAcceptedAgreementResponse 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 PagedRetrieveUserAcceptedAgreementResponse().createFromJson(json);
  }

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