Variable ProjectMemberApiConst

ProjectMemberApi: {
    addMembership(requestParameters, options?): AxiosPromise<ProjectRoleDtoResponse>;
    apiV2ProjectsProjectIdMembersOptions(requestParameters, options?): AxiosPromise<void>;
    deleteMembership(requestParameters, options?): AxiosPromise<void>;
    getMembership(requestParameters, options?): AxiosPromise<ProjectRoleDtoResponse>;
    getMemberships(requestParameters, options?): AxiosPromise<ProjectRoleDtoPagedResponse>;
    updateMembership(requestParameters, options?): AxiosPromise<void>;
} = apis.ProjectMemberApi

Type declaration

  • addMembership:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectMemberApiAddMembershipRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectRoleDtoResponse>

      Summary

      Creates a project membership for a specified project.

      Throws

  • apiV2ProjectsProjectIdMembersOptions:function
    • Parameters

      • requestParameters: ProjectMemberApiApiV2ProjectsProjectIdMembersOptionsRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Responds with the HTTP methods allowed for the endpoint.

      Throws

  • deleteMembership:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectMemberApiDeleteMembershipRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Deletes a project membership for a specified project.

      Throws

  • getMembership:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectMemberApiGetMembershipRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectRoleDtoResponse>

      Summary

      Retrieves a project membership for a specified project.

      Throws

  • getMemberships:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectMemberApiGetMembershipsRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectRoleDtoPagedResponse>

      Summary

      Retrieves all project memberships for a specified project.

      Throws

  • updateMembership:function
    • Required JWT roles for access: .

      Parameters

      • requestParameters: ProjectMemberApiUpdateMembershipRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Updates a project membership for a specified project.

      Throws

Generated using TypeDoc