ApprovalService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• approvalCreateApproval
• approvalGetApprovalCategoryInfo
• approvalGetApprovalCategoryList
• approvalGetApprovalListReceived
• approvalGetApprovalListSent
• approvalGetApprovalListTemp

Constructors

constructor

• new ApprovalService(httpRequest: BaseHttpRequest): ApprovalService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ApprovalService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicapprovalCreateApproval

• approvalCreateApproval(__namedParameters: { requestBody: CreateApprovalParam }): CancelablePromise<{ data?: CreateApprovalResponse }>

• Draft a request Creates a request draft for approval.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateApprovalParam }

  Returns CancelablePromise<{ data?: CreateApprovalResponse }>

  any Successfully created the request.

publicapprovalGetApprovalCategoryInfo

• approvalGetApprovalCategoryInfo(__namedParameters: { approvalCategoryId?: string }): CancelablePromise<{ data?: GetApprovalCategoryInfoResponse }>

• Get a template's info Retrieves information about a request template.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { approvalCategoryId?: string }

  Returns CancelablePromise<{ data?: GetApprovalCategoryInfoResponse }>

  any Successfully retrieved information about the template.

publicapprovalGetApprovalCategoryList

• approvalGetApprovalCategoryList(__namedParameters: { limit?: number; offset?: string }): CancelablePromise<{ data?: ApprovalCategoryListResponse }>

• List out templates Lists out a given number of request templates. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: ApprovalCategoryListResponse }>

  any Successfully retrieved the templates.

publicapprovalGetApprovalListReceived

• approvalGetApprovalListReceived(__namedParameters: { filterApprovalCategoryIds?: string; filterApprovalStatus?: string; filterEndDate?: string; filterIsBookmarked?: string; filterKeyword?: string; filterStartDate?: string; limit?: number; offset?: string; type?: me | me_pending | me_completed | team | referrer_team | referrer }): CancelablePromise<{ data?: ApprovalListResponse }>

• List out received requests Lists out a given number of requests from the user's inbox. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { filterApprovalCategoryIds?: string; filterApprovalStatus?: string; filterEndDate?: string; filterIsBookmarked?: string; filterKeyword?: string; filterStartDate?: string; limit?: number; offset?: string; type?: me | me_pending | me_completed | team | referrer_team | referrer }

  Returns CancelablePromise<{ data?: ApprovalListResponse }>

  any Successfully retrieved the requests received.

publicapprovalGetApprovalListSent

• approvalGetApprovalListSent(__namedParameters: { filterApprovalCategoryIds?: string; filterApprovalStatus?: string; filterEndDate?: string; filterIsBookmarked?: 0 | 1; filterKeyword?: string; filterStartDate?: string; limit?: number; offset?: string; type?: string }): CancelablePromise<{ data?: ApprovalListResponse }>

• List out submitted requests Lists out a given number of requests from the user's submissions. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { filterApprovalCategoryIds?: string; filterApprovalStatus?: string; filterEndDate?: string; filterIsBookmarked?: 0 | 1; filterKeyword?: string; filterStartDate?: string; limit?: number; offset?: string; type?: string }

  Returns CancelablePromise<{ data?: ApprovalListResponse }>

  any Successfully retrieved the requests submitted.

publicapprovalGetApprovalListTemp

• approvalGetApprovalListTemp(__namedParameters: { limit?: number; offset?: string }): CancelablePromise<{ data?: ApprovalListResponse }>

• List out drafts Lists out a given number of request drafts. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: ApprovalListResponse }>

  any Successfully retrieved the drafts.