feat: add documentation to service actions

src/types/AccessControlAddAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlAddActionArgs  extends KalturaRequestArgs {
     accessControl : KalturaAccessControl;
 }
 
-/** 
-* Add new Access Control Profile
-**/
+/**
+ * Build request payload for service 'accessControl' action 'add'.
+ *
+ * Usage: Add new Access Control Profile
+ *
+ * Server response type:         KalturaAccessControl
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlAddAction extends KalturaRequest<KalturaAccessControl> {
 
     accessControl : KalturaAccessControl;

src/types/AccessControlDeleteAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlDeleteActionArgs  extends KalturaRequestArgs {
     id : number;
 }
 
-/** 
-* Delete Access Control Profile by id
-**/
+/**
+ * Build request payload for service 'accessControl' action 'delete'.
+ *
+ * Usage: Delete Access Control Profile by id
+ *
+ * Server response type:         void
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlDeleteAction extends KalturaRequest<void> {
 
     id : number;

src/types/AccessControlGetAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlGetActionArgs  extends KalturaRequestArgs {
     id : number;
 }
 
-/** 
-* Get Access Control Profile by id
-**/
+/**
+ * Build request payload for service 'accessControl' action 'get'.
+ *
+ * Usage: Get Access Control Profile by id
+ *
+ * Server response type:         KalturaAccessControl
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlGetAction extends KalturaRequest<KalturaAccessControl> {
 
     id : number;

src/types/AccessControlListAction.ts

@@ -11,9 +11,16 @@ export interface AccessControlListActionArgs  extends KalturaRequestArgs {
 	pager? : KalturaFilterPager;
 }
 
-/** 
-* List Access Control Profiles by filter and pager
-**/
+/**
+ * Build request payload for service 'accessControl' action 'list'.
+ *
+ * Usage: List Access Control Profiles by filter and pager
+ *
+ * Server response type:         KalturaAccessControlListResponse
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlListAction extends KalturaRequest<KalturaAccessControlListResponse> {
 
     filter : KalturaAccessControlFilter;

src/types/AccessControlProfileAddAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlProfileAddActionArgs  extends KalturaRequestArgs {
     accessControlProfile : KalturaAccessControlProfile;
 }
 
-/** 
-* Add new access control profile
-**/
+/**
+ * Build request payload for service 'accessControlProfile' action 'add'.
+ *
+ * Usage: Add new access control profile
+ *
+ * Server response type:         KalturaAccessControlProfile
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlProfileAddAction extends KalturaRequest<KalturaAccessControlProfile> {
 
     accessControlProfile : KalturaAccessControlProfile;

src/types/AccessControlProfileDeleteAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlProfileDeleteActionArgs  extends KalturaRequestArg
     id : number;
 }
 
-/** 
-* Delete access control profile by id
-**/
+/**
+ * Build request payload for service 'accessControlProfile' action 'delete'.
+ *
+ * Usage: Delete access control profile by id
+ *
+ * Server response type:         void
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlProfileDeleteAction extends KalturaRequest<void> {
 
     id : number;

src/types/AccessControlProfileGetAction.ts

@@ -8,9 +8,16 @@ export interface AccessControlProfileGetActionArgs  extends KalturaRequestArgs {
     id : number;
 }
 
-/** 
-* Get access control profile by id
-**/
+/**
+ * Build request payload for service 'accessControlProfile' action 'get'.
+ *
+ * Usage: Get access control profile by id
+ *
+ * Server response type:         KalturaAccessControlProfile
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlProfileGetAction extends KalturaRequest<KalturaAccessControlProfile> {
 
     id : number;

src/types/AccessControlProfileListAction.ts

@@ -11,9 +11,16 @@ export interface AccessControlProfileListActionArgs  extends KalturaRequestArgs
 	pager? : KalturaFilterPager;
 }
 
-/** 
-* List access control profiles by filter and pager
-**/
+/**
+ * Build request payload for service 'accessControlProfile' action 'list'.
+ *
+ * Usage: List access control profiles by filter and pager
+ *
+ * Server response type:         KalturaAccessControlProfileListResponse
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlProfileListAction extends KalturaRequest<KalturaAccessControlProfileListResponse> {
 
     filter : KalturaAccessControlProfileFilter;

src/types/AccessControlProfileUpdateAction.ts

@@ -9,9 +9,16 @@ export interface AccessControlProfileUpdateActionArgs  extends KalturaRequestArg
 	accessControlProfile : KalturaAccessControlProfile;
 }
 
-/** 
-* Update access control profile by id
-**/
+/**
+ * Build request payload for service 'accessControlProfile' action 'update'.
+ *
+ * Usage: Update access control profile by id
+ *
+ * Server response type:         KalturaAccessControlProfile
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlProfileUpdateAction extends KalturaRequest<KalturaAccessControlProfile> {
 
     id : number;

src/types/AccessControlUpdateAction.ts

@@ -9,9 +9,16 @@ export interface AccessControlUpdateActionArgs  extends KalturaRequestArgs {
 	accessControl : KalturaAccessControl;
 }
 
-/** 
-* Update Access Control Profile by id
-**/
+/**
+ * Build request payload for service 'accessControl' action 'update'.
+ *
+ * Usage: Update Access Control Profile by id
+ *
+ * Server response type:         KalturaAccessControl
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AccessControlUpdateAction extends KalturaRequest<KalturaAccessControl> {
 
     id : number;

src/types/AdminUserLoginAction.ts

@@ -10,10 +10,16 @@ export interface AdminUserLoginActionArgs  extends KalturaRequestArgs {
 	partnerId? : number;
 }
 
-/** 
-* Get an admin session using admin email and password (Used for login to the KMC
-* application)
-**/
+/**
+ * Build request payload for service 'adminUser' action 'login'.
+ *
+ * Usage: Get an admin session using admin email and password (Used for login to the KMC application)
+ *
+ * Server response type:         string
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AdminUserLoginAction extends KalturaRequest<string> {
 
     email : string;

src/types/AdminUserResetPasswordAction.ts

@@ -8,9 +8,16 @@ export interface AdminUserResetPasswordActionArgs  extends KalturaRequestArgs {
     email : string;
 }
 
-/** 
-* Reset admin user password and send it to the users email address
-**/
+/**
+ * Build request payload for service 'adminUser' action 'resetPassword'.
+ *
+ * Usage: Reset admin user password and send it to the users email address
+ *
+ * Server response type:         void
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AdminUserResetPasswordAction extends KalturaRequest<void> {
 
     email : string;

src/types/AdminUserSetInitialPasswordAction.ts

@@ -9,9 +9,16 @@ export interface AdminUserSetInitialPasswordActionArgs  extends KalturaRequestAr
 	newPassword : string;
 }
 
-/** 
-* Set initial users password
-**/
+/**
+ * Build request payload for service 'adminUser' action 'setInitialPassword'.
+ *
+ * Usage: Set initial users password
+ *
+ * Server response type:         void
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AdminUserSetInitialPasswordAction extends KalturaRequest<void> {
 
     hashKey : string;

src/types/AdminUserUpdatePasswordAction.ts

@@ -11,9 +11,16 @@ export interface AdminUserUpdatePasswordActionArgs  extends KalturaRequestArgs {
 	newPassword? : string;
 }
 
-/** 
-* Update admin user password and email
-**/
+/**
+ * Build request payload for service 'adminUser' action 'updatePassword'.
+ *
+ * Usage: Update admin user password and email
+ *
+ * Server response type:         KalturaAdminUser
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AdminUserUpdatePasswordAction extends KalturaRequest<KalturaAdminUser> {
 
     email : string;

src/types/AnalyticsQueryAction.ts

@@ -11,10 +11,16 @@ export interface AnalyticsQueryActionArgs  extends KalturaRequestArgs {
 	pager? : KalturaFilterPager;
 }
 
-/** 
-* report query action allows to get a analytics data for specific query
-* dimensions, metrics and filters.
-**/
+/**
+ * Build request payload for service 'analytics' action 'query'.
+ *
+ * Usage: report query action allows to get a analytics data for specific query dimensions, metrics and filters
+ *
+ * Server response type:         KalturaReportResponse
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AnalyticsQueryAction extends KalturaRequest<KalturaReportResponse> {
 
     filter : KalturaAnalyticsFilter;

src/types/AnnotationAddAction.ts

@@ -9,9 +9,16 @@ export interface AnnotationAddActionArgs  extends KalturaRequestArgs {
     annotation : KalturaCuePoint;
 }
 
-/** 
-* Allows you to add an annotation object associated with an entry
-**/
+/**
+ * Build request payload for service 'annotation' action 'add'.
+ *
+ * Usage: Allows you to add an annotation object associated with an entry
+ *
+ * Server response type:         KalturaAnnotation
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AnnotationAddAction extends KalturaRequest<KalturaAnnotation> {
 
     annotation : KalturaCuePoint;

src/types/AnnotationAddFromBulkAction.ts

@@ -8,10 +8,16 @@ export interface AnnotationAddFromBulkActionArgs  extends KalturaUploadRequestAr
     fileData : File;
 }
 
-/** 
-* Allows you to add multiple cue points objects by uploading XML that contains
-* multiple cue point definitions
-**/
+/**
+ * Build request payload for service 'annotation' action 'addFromBulk'.
+ *
+ * Usage: Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions
+ *
+ * Server response type:         KalturaCuePointListResponse
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaUploadRequest
+ */
 export class AnnotationAddFromBulkAction extends KalturaUploadRequest<KalturaCuePointListResponse> {
 
     fileData : File;

src/types/AnnotationCloneAction.ts

@@ -9,9 +9,16 @@ export interface AnnotationCloneActionArgs  extends KalturaRequestArgs {
 	entryId : string;
 }
 
-/** 
-* Clone cuePoint with id to given entry
-**/
+/**
+ * Build request payload for service 'annotation' action 'clone'.
+ *
+ * Usage: Clone cuePoint with id to given entry
+ *
+ * Server response type:         KalturaCuePoint
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AnnotationCloneAction extends KalturaRequest<KalturaCuePoint> {
 
     id : string;

src/types/AnnotationCountAction.ts

@@ -9,9 +9,16 @@ export interface AnnotationCountActionArgs  extends KalturaRequestArgs {
     filter? : KalturaCuePointFilter;
 }
 
-/** 
-* count cue point objects by filter
-**/
+/**
+ * Build request payload for service 'annotation' action 'count'.
+ *
+ * Usage: count cue point objects by filter
+ *
+ * Server response type:         number
+ * Server failure response type: KalturaAPIException
+ * @class
+ * @extends KalturaRequest
+ */
 export class AnnotationCountAction extends KalturaRequest<number> {
 
     filter : KalturaCuePointFilter;