Class ProjectAPI

constructor

• new ProjectAPI(httpRequest): ProjectAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ProjectAPI

Readonly httpRequest

createProject

• createProject(__namedParameters): CancelablePromise<CreateProjectResponse>

• Create a project Add a new project to a company

  Parameters

  • __namedParameters: {
        companyId: string;
        requestBody: CreateProjectPayLoad;
    }

    • companyId: string

      Company ID for which to create a project

    • requestBody: CreateProjectPayLoad

  Returns CancelablePromise<CreateProjectResponse>

  CreateProjectResponse

  Throws

  ApiError

deleteProject

• deleteProject(__namedParameters): CancelablePromise<DeleteProjectResponse>

• Remove a project Remove a project from a company.

  Parameters

  • __namedParameters: {
        companyId: string;
        projectId: string;
    }

    • companyId: string

      Company ID for which to remove a project

    • projectId: string

      Project ID to delete

  Returns CancelablePromise<DeleteProjectResponse>

  DeleteProjectResponse

  Throws

  ApiError

getProject

• getProject(__namedParameters): CancelablePromise<GetProjectResponse>

• Get project by ID Fetch the details of a specific project by its ID

  Parameters

  • __namedParameters: {
        companyId: string;
        projectId: string;
    }

    • companyId: string

      Company ID the project belongs to

    • projectId: string

      ID of the project to retrieve

  Returns CancelablePromise<GetProjectResponse>

  GetProjectResponse

  Throws

  ApiError

listProjects

• listProjects(__namedParameters): CancelablePromise<ListProjectsResponse>

• List projects Get all projects for a company, optionally filtered by client

  Parameters

  • __namedParameters: {
        clientId?: string;
        companyId: string;
        limit?: number;
        page?: number;
        search?: string;
    }

    • Optional clientId?: string

      Client ID to filter projects

    • companyId: string

      Company ID for which to list projects

    • Optional limit?: number

      Items to limit per page

    • Optional page?: number

      Page being requested

    • Optional search?: string

  Returns CancelablePromise<ListProjectsResponse>

  ListProjectsResponse

  Throws

  ApiError

updateProject

• updateProject(__namedParameters): CancelablePromise<UpdateProjectResponse>

• Update a project Update an existing project for a company

  Parameters

  • __namedParameters: {
        companyId: string;
        projectId: string;
        requestBody: UpdateProjectPayload;
    }

    • companyId: string

      Company ID for which to update a project

    • projectId: string

      Project ID to update

    • requestBody: UpdateProjectPayload

  Returns CancelablePromise<UpdateProjectResponse>

  UpdateProjectResponse

  Throws

  ApiError