#6297

Committed 27 Feb 2026 04:09PM UTC coverage: 34.822% (+0.08%) from 34.746%

Build # #6297

Build Type

push

github

Committed by

web-flow

Commit Message

docs: Update description for delete archives endpoint (box/box-openapi#585) (#1733)

Co-authored-by: box-sdk-build <box-sdk-build@box.com>

Run Details

18708 of 53725 relevant lines covered (34.82%)

0.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

58.62

/src/main/java/com/box/sdkgen/managers/folders/GetFolderByIdQueryParams.java

package com.box.sdkgen.managers.folders;

import com.box.sdkgen.serialization.json.EnumWrapper;
import java.util.List;

public class GetFolderByIdQueryParams {

  /**
   * A comma-separated list of attributes to include in the response. This can be used to request
   * fields that are not normally returned in a standard response.
   *
   * <p>Be aware that specifying this parameter will have the effect that none of the standard
   * fields are returned in the response unless explicitly specified, instead only fields for the
   * mini representation are returned, additional to the fields requested.
   *
   * <p>Additionally this field can be used to query any metadata applied to the file by specifying
   * the `metadata` field as well as the scope and key of the template to retrieve, for example
   * `?fields=metadata.enterprise_12345.contractTemplate`.
   */
  public List<String> fields;

  /**
   * Defines the **second** attribute by which items are sorted.
   *
   * <p>The folder type affects the way the items are sorted:
   *
   * <p>* **Standard folder**: Items are always sorted by their `type` first, with folders listed
   * before files, and files listed before web links.
   *
   * <p>* **Root folder**: This parameter is not supported for marker-based pagination on the root
   * folder
   *
   * <p>(the folder with an `id` of `0`).
   *
   * <p>* **Shared folder with parent path to the associated folder visible to the collaborator**:
   * Items are always sorted by their `type` first, with folders listed before files, and files
   * listed before web links.
   */
  public EnumWrapper<GetFolderByIdQueryParamsSortField> sort;

  /**
   * The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or
   * descending (`DESC`) order.
   */
  public EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction;

  /**
   * The offset of the item at which to begin the response.
   *
   * <p>Offset-based pagination is not guaranteed to work reliably for high offset values and may
   * fail for large datasets. In those cases, reduce the number of items in the folder (for example,
   * by restructuring the folder into smaller subfolders) before retrying the request.
   */
  public Long offset;

  /** The maximum number of items to return per page. */
  public Long limit;

  public GetFolderByIdQueryParams() {}

  protected GetFolderByIdQueryParams(Builder builder) {
    this.fields = builder.fields;
    this.sort = builder.sort;
    this.direction = builder.direction;
    this.offset = builder.offset;
    this.limit = builder.limit;
  }

  public List<String> getFields() {
    return fields;
  }

  public EnumWrapper<GetFolderByIdQueryParamsSortField> getSort() {
    return sort;
  }

  public EnumWrapper<GetFolderByIdQueryParamsDirectionField> getDirection() {
    return direction;
  }

  public Long getOffset() {
    return offset;
  }

  public Long getLimit() {
    return limit;
  }

  public static class Builder {

    protected List<String> fields;

    protected EnumWrapper<GetFolderByIdQueryParamsSortField> sort;

    protected EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction;

    protected Long offset;

    protected Long limit;

    public Builder fields(List<String> fields) {
      this.fields = fields;
      return this;
    }

    public Builder sort(GetFolderByIdQueryParamsSortField sort) {
      this.sort = new EnumWrapper<GetFolderByIdQueryParamsSortField>(sort);
      return this;
    }

    public Builder sort(EnumWrapper<GetFolderByIdQueryParamsSortField> sort) {
      this.sort = sort;
      return this;
    }

    public Builder direction(GetFolderByIdQueryParamsDirectionField direction) {
      this.direction = new EnumWrapper<GetFolderByIdQueryParamsDirectionField>(direction);
      return this;
    }

    public Builder direction(EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction) {
      this.direction = direction;
      return this;
    }

    public Builder offset(Long offset) {
      this.offset = offset;
      return this;
    }

    public Builder limit(Long limit) {
      this.limit = limit;
      return this;
    }

    public GetFolderByIdQueryParams build() {
      return new GetFolderByIdQueryParams(this);
    }
  }
}

1	package com.box.sdkgen.managers.folders;
2
3	import com.box.sdkgen.serialization.json.EnumWrapper;
4	import java.util.List;
5
6	public class GetFolderByIdQueryParams {
7
8	/**
9	* A comma-separated list of attributes to include in the response. This can be used to request
10	* fields that are not normally returned in a standard response.
11	*
12	* <p>Be aware that specifying this parameter will have the effect that none of the standard
13	* fields are returned in the response unless explicitly specified, instead only fields for the
14	* mini representation are returned, additional to the fields requested.
15	*
16	* <p>Additionally this field can be used to query any metadata applied to the file by specifying
17	* the `metadata` field as well as the scope and key of the template to retrieve, for example
18	* `?fields=metadata.enterprise_12345.contractTemplate`.
19	*/
20	public List<String> fields;
21
22	/**
23	* Defines the second attribute by which items are sorted.
24	*
25	* <p>The folder type affects the way the items are sorted:
26	*
27	* <p>* Standard folder: Items are always sorted by their `type` first, with folders listed
28	* before files, and files listed before web links.
29	*
30	* <p>* Root folder: This parameter is not supported for marker-based pagination on the root
31	* folder
32	*
33	* <p>(the folder with an `id` of `0`).
34	*
35	* <p>* Shared folder with parent path to the associated folder visible to the collaborator:
36	* Items are always sorted by their `type` first, with folders listed before files, and files
37	* listed before web links.
38	*/
39	public EnumWrapper<GetFolderByIdQueryParamsSortField> sort;
40
41	/**
42	* The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or
43	* descending (`DESC`) order.
44	*/
45	public EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction;
46
47	/**
48	* The offset of the item at which to begin the response.
49	*
50	* <p>Offset-based pagination is not guaranteed to work reliably for high offset values and may
51	* fail for large datasets. In those cases, reduce the number of items in the folder (for example,
52	* by restructuring the folder into smaller subfolders) before retrying the request.
53	*/
54	public Long offset;
55
56	/** The maximum number of items to return per page. */
57	public Long limit;
58
59	public GetFolderByIdQueryParams() {}	1✔
60
61	protected GetFolderByIdQueryParams(Builder builder) {	1✔
62	this.fields = builder.fields;	1✔
63	this.sort = builder.sort;	1✔
64	this.direction = builder.direction;	1✔
65	this.offset = builder.offset;	1✔
66	this.limit = builder.limit;	1✔
67	}	1✔
68
69	public List<String> getFields() {
70	return fields;	1✔
71	}
72
73	public EnumWrapper<GetFolderByIdQueryParamsSortField> getSort() {
74	return sort;	1✔
75	}
76
77	public EnumWrapper<GetFolderByIdQueryParamsDirectionField> getDirection() {
78	return direction;	1✔
79	}
80
81	public Long getOffset() {
82	return offset;	1✔
83	}
84
85	public Long getLimit() {
86	return limit;	1✔
87	}
88
89	public static class Builder {	1✔
90
91	protected List<String> fields;
92
93	protected EnumWrapper<GetFolderByIdQueryParamsSortField> sort;
94
95	protected EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction;
96
97	protected Long offset;
98
99	protected Long limit;
100
101	public Builder fields(List<String> fields) {
102	this.fields = fields;	1✔
103	return this;	1✔
104	}
105
106	public Builder sort(GetFolderByIdQueryParamsSortField sort) {
107	this.sort = new EnumWrapper<GetFolderByIdQueryParamsSortField>(sort);	×
108	return this;	×
109	}
110
111	public Builder sort(EnumWrapper<GetFolderByIdQueryParamsSortField> sort) {
112	this.sort = sort;	×
113	return this;	×
114	}
115
116	public Builder direction(GetFolderByIdQueryParamsDirectionField direction) {
117	this.direction = new EnumWrapper<GetFolderByIdQueryParamsDirectionField>(direction);	×
118	return this;	×
119	}
120
121	public Builder direction(EnumWrapper<GetFolderByIdQueryParamsDirectionField> direction) {
122	this.direction = direction;	×
123	return this;	×
124	}
125
126	public Builder offset(Long offset) {
127	this.offset = offset;	×
128	return this;	×
129	}
130
131	public Builder limit(Long limit) {
132	this.limit = limit;	×
133	return this;	×
134	}
135
136	public GetFolderByIdQueryParams build() {
137	return new GetFolderByIdQueryParams(this);	1✔
138	}
139	}
140	}

box / box-java-sdk / #6297

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous