polarion_rest_api_client.open_api_client.api.license_ package¶

Contains endpoint functions for accessing the API

Submodules¶

polarion_rest_api_client.open_api_client.api.license_.delete_license_slots module¶

async polarion_rest_api_client.open_api_client.api.license_.delete_license_slots.asyncio(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListDeleteRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.license_.delete_license_slots.asyncio_detailed(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListDeleteRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.delete_license_slots.sync(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListDeleteRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.license_.delete_license_slots.sync_detailed(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListDeleteRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.get_license module¶

async polarion_rest_api_client.open_api_client.api.license_.get_license.asyncio(*, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSingleGetResponse | None¶

Returns information on the available License Limits.

Args:: fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSingleGetResponse

async polarion_rest_api_client.open_api_client.api.license_.get_license.asyncio_detailed(*, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSingleGetResponse]¶

Returns information on the available License Limits.

Args:: fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license.sync(*, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSingleGetResponse | None¶

Returns information on the available License Limits.

Args:: fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSingleGetResponse

polarion_rest_api_client.open_api_client.api.license_.get_license.sync_detailed(*, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSingleGetResponse]¶

Returns information on the available License Limits.

Args:: fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments module¶

async polarion_rest_api_client.open_api_client.api.license_.get_license_assignments.asyncio(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, active_only: bool | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseAssignmentsListGetResponse | None¶

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): active_only (bool | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseAssignmentsListGetResponse

async polarion_rest_api_client.open_api_client.api.license_.get_license_assignments.asyncio_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, active_only: bool | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseAssignmentsListGetResponse]¶

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): active_only (bool | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseAssignmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments.sync(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, active_only: bool | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseAssignmentsListGetResponse | None¶

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): active_only (bool | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseAssignmentsListGetResponse

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments.sync_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, active_only: bool | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseAssignmentsListGetResponse]¶

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): active_only (bool | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseAssignmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments_for_user module¶

async polarion_rest_api_client.open_api_client.api.license_.get_license_assignments_for_user.asyncio(user_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseAssignmentsSingleGetResponse | None¶

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseAssignmentsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.license_.get_license_assignments_for_user.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseAssignmentsSingleGetResponse]¶

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseAssignmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments_for_user.sync(user_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseAssignmentsSingleGetResponse | None¶

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseAssignmentsSingleGetResponse

polarion_rest_api_client.open_api_client.api.license_.get_license_assignments_for_user.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseAssignmentsSingleGetResponse]¶

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseAssignmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_slot module¶

async polarion_rest_api_client.open_api_client.api.license_.get_license_slot.asyncio(type_id: str, model: str, group: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSlotsSingleGetResponse | None¶

Returns the specified License Slot. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): model (str): group (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.license_.get_license_slot.asyncio_detailed(type_id: str, model: str, group: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSlotsSingleGetResponse]¶

Returns the specified License Slot. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): model (str): group (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_slot.sync(type_id: str, model: str, group: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSlotsSingleGetResponse | None¶

Returns the specified License Slot. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): model (str): group (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsSingleGetResponse

polarion_rest_api_client.open_api_client.api.license_.get_license_slot.sync_detailed(type_id: str, model: str, group: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSlotsSingleGetResponse]¶

Returns the specified License Slot. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): model (str): group (str): fields (SparseFields | Unset): include (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_slots module¶

async polarion_rest_api_client.open_api_client.api.license_.get_license_slots.asyncio(type_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSlotsListGetResponse | None¶

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsListGetResponse

async polarion_rest_api_client.open_api_client.api.license_.get_license_slots.asyncio_detailed(type_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSlotsListGetResponse]¶

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsListGetResponse]

polarion_rest_api_client.open_api_client.api.license_.get_license_slots.sync(type_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LicenseSlotsListGetResponse | None¶

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsListGetResponse

polarion_rest_api_client.open_api_client.api.license_.get_license_slots.sync_detailed(type_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LicenseSlotsListGetResponse]¶

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsListGetResponse]

polarion_rest_api_client.open_api_client.api.license_.patch_license module¶

async polarion_rest_api_client.open_api_client.api.license_.patch_license.asyncio(*, client: AuthenticatedClient | Client, body: LicenseSinglePatchRequest) → Any | Errors | None¶

Updates the product License. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.license_.patch_license.asyncio_detailed(*, client: AuthenticatedClient | Client, body: LicenseSinglePatchRequest) → Response[Any | Errors]¶

Updates the product License. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.patch_license.sync(*, client: AuthenticatedClient | Client, body: LicenseSinglePatchRequest) → Any | Errors | None¶

Updates the product License. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.license_.patch_license.sync_detailed(*, client: AuthenticatedClient | Client, body: LicenseSinglePatchRequest) → Response[Any | Errors]¶

Updates the product License. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignment module¶

async polarion_rest_api_client.open_api_client.api.license_.patch_license_assignment.asyncio(user_id: str, *, client: AuthenticatedClient | Client, body: LicenseAssignmentsSinglePatchRequest) → Any | Errors | None¶

Updates a user’s License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): body (LicenseAssignmentsSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.license_.patch_license_assignment.asyncio_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: LicenseAssignmentsSinglePatchRequest) → Response[Any | Errors]¶

Updates a user’s License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): body (LicenseAssignmentsSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignment.sync(user_id: str, *, client: AuthenticatedClient | Client, body: LicenseAssignmentsSinglePatchRequest) → Any | Errors | None¶

Updates a user’s License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): body (LicenseAssignmentsSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignment.sync_detailed(user_id: str, *, client: AuthenticatedClient | Client, body: LicenseAssignmentsSinglePatchRequest) → Response[Any | Errors]¶

Updates a user’s License Assignment. (Not supported by cloud-based Polarion X.)

Args:: user_id (str): body (LicenseAssignmentsSinglePatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignments module¶

async polarion_rest_api_client.open_api_client.api.license_.patch_license_assignments.asyncio(*, client: AuthenticatedClient | Client, body: LicenseAssignmentsListPatchRequest) → Any | Errors | None¶

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseAssignmentsListPatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.license_.patch_license_assignments.asyncio_detailed(*, client: AuthenticatedClient | Client, body: LicenseAssignmentsListPatchRequest) → Response[Any | Errors]¶

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseAssignmentsListPatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignments.sync(*, client: AuthenticatedClient | Client, body: LicenseAssignmentsListPatchRequest) → Any | Errors | None¶

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseAssignmentsListPatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.license_.patch_license_assignments.sync_detailed(*, client: AuthenticatedClient | Client, body: LicenseAssignmentsListPatchRequest) → Response[Any | Errors]¶

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)

Args:: body (LicenseAssignmentsListPatchRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.license_.post_license_slots module¶

async polarion_rest_api_client.open_api_client.api.license_.post_license_slots.asyncio(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListPostRequest) → Errors | LicenseSlotsListPostResponse | None¶

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListPostRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsListPostResponse

async polarion_rest_api_client.open_api_client.api.license_.post_license_slots.asyncio_detailed(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListPostRequest) → Response[Errors | LicenseSlotsListPostResponse]¶

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListPostRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsListPostResponse]

polarion_rest_api_client.open_api_client.api.license_.post_license_slots.sync(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListPostRequest) → Errors | LicenseSlotsListPostResponse | None¶

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListPostRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | LicenseSlotsListPostResponse

polarion_rest_api_client.open_api_client.api.license_.post_license_slots.sync_detailed(type_id: str, *, client: AuthenticatedClient | Client, body: LicenseSlotsListPostRequest) → Response[Errors | LicenseSlotsListPostResponse]¶

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)

Args:: type_id (str): body (LicenseSlotsListPostRequest):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | LicenseSlotsListPostResponse]