feat: add GetRecordsByAppIdRequest model

2023-02-10 23:48:55 -06:00
parent 287289b83f
commit a874f8a6df
2 changed files with 96 additions and 0 deletions
@@ -0,0 +1,44 @@
+import { DataFormat } from '../enums/DataFormat';
+import { PagingRequest } from './PagingRequest';
+
+export class GetRecordsByAppIdRequest {
+  /**
+   * @property {number} appId - The id of the app that the records belong to.
+   */
+  public appId: number;
+
+  /**
+   * @property {number[]} fieldIds - The ids of the fields to include in the response.
+   */
+  public fieldIds: number[];
+
+  /**
+   * @property {DataFormat} dataFormat - The format of the data in the response.
+   */
+  public dataFormat: DataFormat;
+
+  /**
+   * @property {PagingRequest} pagingRequest - The paging request.
+   */
+  public pagingRequest: PagingRequest;
+
+  /**
+   *@constructor - Creates a new instance of GetRecordsByAppIdRequest.
+   * @param {number} appId - The id of the app that the records belong to.
+   * @param {number[]} fieldIds - The ids of the fields to include in the response.
+   * @param {DataFormat} dataFormat - The format of the data in the response.
+   * @param {PagingRequest} pagingRequest - The paging request.
+   * @returns {GetRecordsByAppIdRequest} - A new instance of GetRecordsByAppIdRequest.
+   */
+  constructor(
+    appId: number,
+    fieldIds: number[] = [],
+    dataFormat: DataFormat = DataFormat.Raw,
+    pagingRequest: PagingRequest = new PagingRequest(1, 50)
+  ) {
+    this.appId = appId;
+    this.fieldIds = fieldIds;
+    this.dataFormat = dataFormat;
+    this.pagingRequest = pagingRequest;
+  }
+}