@connectedxm/admin-sdk 16.12.0 → 16.14.0

package/docs/BaseEventSponsorshipPurchase.md

@@ -0,0 +1,34 @@
+# BaseEventSponsorshipPurchase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**status** | [**PurchaseStatus**](PurchaseStatus.md) |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**levelId** | **string** |  | [default to undefined]
+**sponsorshipId** | **string** |  | [default to undefined]
+**level** | [**BasePassAttributeAttribute**](BasePassAttributeAttribute.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseEventSponsorshipPurchase } from '@connectedxm/admin-sdk';
+
+const instance: BaseEventSponsorshipPurchase = {
+    id,
+    status,
+    eventId,
+    levelId,
+    sponsorshipId,
+    level,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BasePaymentIntent.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **seriesId** | **string** |  | [default to undefined]
 **placeMembershipTypeId** | **string** |  | [default to undefined]
 **placeMembershipId** | **string** |  | [default to undefined]
+**sponsorshipPurchaseId** | **string** |  | [default to undefined]
 **address1** | **string** |  | [default to undefined]
 **address2** | **string** |  | [default to undefined]
 **city** | **string** |  | [default to undefined]
@@ -74,6 +75,7 @@ const instance: BasePaymentIntent = {
     seriesId,
     placeMembershipTypeId,
     placeMembershipId,
+    sponsorshipPurchaseId,
     address1,
     address2,
     city,

package/docs/BasePaymentIntentLineItem.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **couponId** | **string** |  | [default to undefined]
 **seriesRegistrationId** | **string** |  | [default to undefined]
 **placeMembershipId** | **string** |  | [default to undefined]
+**sponsorshipPurchaseId** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -57,6 +58,7 @@ const instance: BasePaymentIntentLineItem = {
     couponId,
     seriesRegistrationId,
     placeMembershipId,
+    sponsorshipPurchaseId,
     createdAt,
 };
 ```

package/docs/BasePaymentLineItem.md

@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **accessId** | **string** |  | [default to undefined]
 **bookingId** | **string** |  | [default to undefined]
 **placeMembershipId** | **string** |  | [default to undefined]
+**sponsorshipPurchaseId** | **string** |  | [default to undefined]
 
 ## Example
 
@@ -60,6 +61,7 @@ const instance: BasePaymentLineItem = {
     accessId,
     bookingId,
     placeMembershipId,
+    sponsorshipPurchaseId,
 };
 ```
 

package/docs/BaseReplay.md

@@ -0,0 +1,38 @@
+# BaseReplay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**session** | [**BaseReplaySession**](BaseReplaySession.md) |  | [default to undefined]
+**event** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**group** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseReplay } from '@connectedxm/admin-sdk';
+
+const instance: BaseReplay = {
+    id,
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+    session,
+    event,
+    group,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BaseReplaySession.md

@@ -0,0 +1,24 @@
+# BaseReplaySession
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseReplaySession } from '@connectedxm/admin-sdk';
+
+const instance: BaseReplaySession = {
+    id,
+    name,
+    eventId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BaseStreamInput.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **webRTC** | **boolean** |  | [default to undefined]
 **webRTCPlaybackUrl** | **string** |  | [default to undefined]
 **dvrEnabled** | **boolean** |  | [default to undefined]
+**allowReplays** | **boolean** |  | [default to undefined]
 **connected** | **boolean** |  | [default to undefined]
 
 ## Example
@@ -39,6 +40,7 @@ const instance: BaseStreamInput = {
     webRTC,
     webRTCPlaybackUrl,
     dvrEnabled,
+    allowReplays,
     connected,
 };
 ```

package/docs/BaseVideo.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **previewUrl** | **string** |  | [default to undefined]
 **readyToStream** | **boolean** |  | [default to undefined]
 **duration** | **number** |  | [default to undefined]
+**streamId** | **string** |  | [default to undefined]
+**streamSessionId** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -33,6 +35,8 @@ const instance: BaseVideo = {
     previewUrl,
     readyToStream,
     duration,
+    streamId,
+    streamSessionId,
     createdAt,
 };
 ```

package/docs/CreateReplay200Response.md

@@ -0,0 +1,24 @@
+# CreateReplay200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Replay**](Replay.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReplay200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreateReplay200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventSession.md

@@ -48,6 +48,8 @@ Name | Type | Description | Notes
 **allowedTiers** | [**Array<BaseTier>**](BaseTier.md) |  | [default to undefined]
 **continuousScanning** | **boolean** |  | [default to undefined]
 **scanType** | [**OnSiteScanType**](OnSiteScanType.md) |  | [default to undefined]
+**livestreamed** | **boolean** |  | [default to undefined]
+**_count** | [**EventSessionAllOfCount**](EventSessionAllOfCount.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -98,6 +100,8 @@ const instance: EventSession = {
     allowedTiers,
     continuousScanning,
     scanType,
+    livestreamed,
+    _count,
 };
 ```
 

package/docs/EventSessionAllOfCount.md

@@ -0,0 +1,20 @@
+# EventSessionAllOfCount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**replays** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventSessionAllOfCount } from '@connectedxm/admin-sdk';
+
+const instance: EventSessionAllOfCount = {
+    replays,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventSessionCreateInputs.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **featured** | **boolean** |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **registrationEnabled** | **boolean** |  | [optional] [default to undefined]
+**livestreamed** | **boolean** |  | [optional] [default to undefined]
 **onsiteRegistration** | **boolean** |  | [optional] [default to undefined]
 **skipOnsiteValidations** | **boolean** |  | [optional] [default to undefined]
 **allowQuickRegister** | **boolean** |  | [optional] [default to undefined]
@@ -55,6 +56,7 @@ const instance: EventSessionCreateInputs = {
     featured,
     sortOrder,
     registrationEnabled,
+    livestreamed,
     onsiteRegistration,
     skipOnsiteValidations,
     allowQuickRegister,

package/docs/EventSessionUpdateInputs.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **featured** | **boolean** |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **registrationEnabled** | **boolean** |  | [optional] [default to undefined]
+**livestreamed** | **boolean** |  | [optional] [default to undefined]
 **onsiteRegistration** | **boolean** |  | [optional] [default to undefined]
 **skipOnsiteValidations** | **boolean** |  | [optional] [default to undefined]
 **allowQuickRegister** | **boolean** |  | [optional] [default to undefined]
@@ -55,6 +56,7 @@ const instance: EventSessionUpdateInputs = {
     featured,
     sortOrder,
     registrationEnabled,
+    livestreamed,
     onsiteRegistration,
     skipOnsiteValidations,
     allowQuickRegister,

package/docs/GetReplays200Response.md

@@ -0,0 +1,26 @@
+# GetReplays200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<Replay>**](Replay.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetReplays200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetReplays200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PaymentIntent.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **seriesId** | **string** |  | [default to undefined]
 **placeMembershipTypeId** | **string** |  | [default to undefined]
 **placeMembershipId** | **string** |  | [default to undefined]
+**sponsorshipPurchaseId** | **string** |  | [default to undefined]
 **address1** | **string** |  | [default to undefined]
 **address2** | **string** |  | [default to undefined]
 **city** | **string** |  | [default to undefined]
@@ -84,6 +85,7 @@ const instance: PaymentIntent = {
     seriesId,
     placeMembershipTypeId,
     placeMembershipId,
+    sponsorshipPurchaseId,
     address1,
     address2,
     city,

package/docs/PaymentIntentSource.md

@@ -23,4 +23,10 @@
 
 * `PlaceMembership` (value: `'placeMembership'`)
 
+* `Sponsorship` (value: `'sponsorship'`)
+
+* `Pass` (value: `'pass'`)
+
+* `Exchange` (value: `'exchange'`)
+
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PaymentLineItem.md

@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **accessId** | **string** |  | [default to undefined]
 **bookingId** | **string** |  | [default to undefined]
 **placeMembershipId** | **string** |  | [default to undefined]
+**sponsorshipPurchaseId** | **string** |  | [default to undefined]
 **pass** | [**BaseEventPass**](BaseEventPass.md) |  | [default to undefined]
 **_package** | [**BaseEventPackage**](BaseEventPackage.md) |  | [default to undefined]
 **passAddOn** | [**BasePassAddOn**](BasePassAddOn.md) |  | [default to undefined]
@@ -36,6 +37,7 @@ Name | Type | Description | Notes
 **access** | [**BaseEventSessionAccess**](BaseEventSessionAccess.md) |  | [default to undefined]
 **booking** | [**BaseBooking**](BaseBooking.md) |  | [default to undefined]
 **placeMembership** | [**BasePlaceMembership**](BasePlaceMembership.md) |  | [default to undefined]
+**sponsorshipPurchase** | [**BaseEventSponsorshipPurchase**](BaseEventSponsorshipPurchase.md) |  | [default to undefined]
 **coupon** | [**BaseCoupon**](BaseCoupon.md) |  | [default to undefined]
 **seriesRegistration** | [**BaseSeriesRegistration**](BaseSeriesRegistration.md) |  | [default to undefined]
 **payment** | [**BasePayment**](BasePayment.md) |  | [default to undefined]
@@ -70,6 +72,7 @@ const instance: PaymentLineItem = {
     accessId,
     bookingId,
     placeMembershipId,
+    sponsorshipPurchaseId,
     pass,
     _package,
     passAddOn,
@@ -77,6 +80,7 @@ const instance: PaymentLineItem = {
     access,
     booking,
     placeMembership,
+    sponsorshipPurchase,
     coupon,
     seriesRegistration,
     payment,

package/docs/PaymentLineItemType.md

@@ -25,6 +25,8 @@
 
 * `PlaceMembership` (value: `'placeMembership'`)
 
+* `Sponsorship` (value: `'sponsorship'`)
+
 * `Refund` (value: `'refund'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Replay.md

@@ -0,0 +1,40 @@
+# Replay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**session** | [**BaseReplaySession**](BaseReplaySession.md) |  | [default to undefined]
+**event** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**group** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**video** | [**ReplayVideo**](ReplayVideo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Replay } from '@connectedxm/admin-sdk';
+
+const instance: Replay = {
+    id,
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+    session,
+    event,
+    group,
+    createdAt,
+    updatedAt,
+    video,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReplayCreateInputs.md

@@ -0,0 +1,26 @@
+# ReplayCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ReplayCreateInputs = {
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReplayUpdateInputs.md

@@ -0,0 +1,24 @@
+# ReplayUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sessionId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ReplayUpdateInputs = {
+    sessionId,
+    eventId,
+    groupId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReplayVideo.md

@@ -0,0 +1,50 @@
+# ReplayVideo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**source** | [**VideoSource**](VideoSource.md) |  | [default to undefined]
+**width** | **number** |  | [default to undefined]
+**height** | **number** |  | [default to undefined]
+**thumbnailUrl** | **string** |  | [default to undefined]
+**previewUrl** | **string** |  | [default to undefined]
+**readyToStream** | **boolean** |  | [default to undefined]
+**duration** | **number** |  | [default to undefined]
+**streamId** | **string** |  | [default to undefined]
+**streamSessionId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**hlsUrl** | **string** |  | [default to undefined]
+**stream** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**streamSession** | [**VideoAllOfStreamSession**](VideoAllOfStreamSession.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayVideo } from '@connectedxm/admin-sdk';
+
+const instance: ReplayVideo = {
+    id,
+    name,
+    status,
+    source,
+    width,
+    height,
+    thumbnailUrl,
+    previewUrl,
+    readyToStream,
+    duration,
+    streamId,
+    streamSessionId,
+    createdAt,
+    hlsUrl,
+    stream,
+    streamSession,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StreamInput.md

@@ -18,17 +18,21 @@ Name | Type | Description | Notes
 **webRTC** | **boolean** |  | [default to undefined]
 **webRTCPlaybackUrl** | **string** |  | [default to undefined]
 **dvrEnabled** | **boolean** |  | [default to undefined]
+**allowReplays** | **boolean** |  | [default to undefined]
 **connected** | **boolean** |  | [default to undefined]
 **event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
 **session** | [**BaseEventSession**](BaseEventSession.md) |  | [default to undefined]
 **group** | [**BaseGroup**](BaseGroup.md) |  | [default to undefined]
 **meetingId** | **string** |  | [default to undefined]
 **meeting** | [**BaseMeeting**](BaseMeeting.md) |  | [default to undefined]
+**activityId** | **string** |  | [default to undefined]
+**activity** | [**BaseActivity**](BaseActivity.md) |  | [default to undefined]
 **streamInputId** | **string** |  | [default to undefined]
 **streamInput** | [**BaseStreamInput**](BaseStreamInput.md) |  | [default to undefined]
 **details** | [**StreamInputDetails**](StreamInputDetails.md) |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
+**lastStreamSessionStartedAt** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -49,17 +53,21 @@ const instance: StreamInput = {
     webRTC,
     webRTCPlaybackUrl,
     dvrEnabled,
+    allowReplays,
     connected,
     event,
     session,
     group,
     meetingId,
     meeting,
+    activityId,
+    activity,
     streamInputId,
     streamInput,
     details,
     sortOrder,
     createdAt,
+    lastStreamSessionStartedAt,
 };
 ```
 

package/docs/StreamInputCreateInputs.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **locale** | **string** |  | [optional] [default to undefined]
 **webRTC** | **boolean** |  | [optional] [default to undefined]
 **dvrEnabled** | **boolean** |  | [optional] [default to undefined]
+**allowReplays** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: StreamInputCreateInputs = {
     locale,
     webRTC,
     dvrEnabled,
+    allowReplays,
 };
 ```
 

package/docs/StreamInputUpdateInputs.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **locale** | **string** |  | [optional] [default to undefined]
 **webRTC** | **boolean** |  | [optional] [default to undefined]
 **dvrEnabled** | **boolean** |  | [optional] [default to undefined]
+**allowReplays** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: StreamInputUpdateInputs = {
     locale,
     webRTC,
     dvrEnabled,
+    allowReplays,
 };
 ```
 

package/docs/StreamsApi.md

@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getStreamInput(
 # **getStreamInputs**
 > GetStreamInputs200Response getStreamInputs()
 
-Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
+Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
 
 ### Example
 
@@ -186,6 +186,8 @@ let eventId: string; //Filter by eventId (optional) (default to undefined)
 let sessionId: string; //Filter by sessionId (optional) (default to undefined)
 let groupId: string; //Filter by groupId (optional) (default to undefined)
 let meetingId: string; //Filter by meetingId (optional) (default to undefined)
+let connected: boolean; //Filter by connected (optional) (default to undefined)
+let attached: boolean; //Filter by attached (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
 let pageSize: number; //Number of items per page (optional) (default to 25)
 let orderBy: string; //Field to order by (optional) (default to undefined)
@@ -196,6 +198,8 @@ const { status, data } = await apiInstance.getStreamInputs(
     sessionId,
     groupId,
     meetingId,
+    connected,
+    attached,
     page,
     pageSize,
     orderBy,
@@ -211,6 +215,8 @@ const { status, data } = await apiInstance.getStreamInputs(
 | **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
 | **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
 | **meetingId** | [**string**] | Filter by meetingId | (optional) defaults to undefined|
+| **connected** | [**boolean**] | Filter by connected | (optional) defaults to undefined|
+| **attached** | [**boolean**] | Filter by attached | (optional) defaults to undefined|
 | **page** | [**number**] | Page number | (optional) defaults to 1|
 | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
 | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|