crud

crud

create_objective async

create_objective(
    auth: DomoAuth,
    name: str | None = None,
    period_id: int | None = None,
    payload: dict | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Create a new objective.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
name	str | None	Name for the new objective	None
period_id	int | None	Period ID the objective belongs to	None
payload	dict | None	Pre-built payload (overrides name/period_id, see generate_create_objective_body for the full set of supported fields)	None
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the created objective

Raises:

Type	Description
Objectives_CreateParams_Error	If required parameters are missing
Objectives_CRUD_Error	If objective creation fails

Source code in src/crew_dcs/routes/objectives/crud.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def create_objective(
    auth: DomoAuth,
    name: str | None = None,
    period_id: int | None = None,
    payload: dict | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Create a new objective.

    Args:
        auth: Authentication object for API requests
        name: Name for the new objective
        period_id: Period ID the objective belongs to
        payload: Pre-built payload (overrides name/period_id, see
            generate_create_objective_body for the full set of supported fields)
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the created objective

    Raises:
        Objectives_CreateParams_Error: If required parameters are missing
        Objectives_CRUD_Error: If objective creation fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    if not payload and not (name and period_id):
        raise Objectives_CreateParams_Error(
            "Either payload must be provided or both name and period_id are required"
        )

    payload = payload or generate_create_objective_body(name=name, period_id=period_id)
    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives"

    res = await gd.get_data(
        auth=auth, url=url, method="POST", body=payload, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_CRUD_Error(operation="create", objective_id=name, res=res)
    return res

delete_objective async

delete_objective(
    auth: DomoAuth,
    objective_id: int | str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Delete an objective.

Note: the Postman collection lists this endpoint without the {{baseUrl}} prefix (i.e. just /social/v1/objectives/:id), which appears to be a collection bug. This function uses the full {{baseUrl}}-prefixed URL, consistent with every other endpoint in the API.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
objective_id	int | str	ID of the objective to delete	required
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object confirming deletion

Raises:

Type	Description
Objectives_CRUD_Error	If objective deletion fails

Source code in src/crew_dcs/routes/objectives/crud.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def delete_objective(
    auth: DomoAuth,
    objective_id: int | str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Delete an objective.

    Note: the Postman collection lists this endpoint without the {{baseUrl}}
    prefix (i.e. just `/social/v1/objectives/:id`), which appears to be a
    collection bug. This function uses the full `{{baseUrl}}`-prefixed URL,
    consistent with every other endpoint in the API.

    Args:
        auth: Authentication object for API requests
        objective_id: ID of the objective to delete
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object confirming deletion

    Raises:
        Objectives_CRUD_Error: If objective deletion fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/{objective_id}"
    )

    res = await gd.get_data(auth=auth, url=url, method="DELETE", context=context)

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_CRUD_Error(
            operation="delete", objective_id=str(objective_id), res=res
        )
    return res

generate_create_objective_body

generate_create_objective_body(
    name: str,
    period_id: int,
    description: str | None = None,
    starts_at: str | None = None,
    expires_at: str | None = None,
    status: str = "NOT_STARTED",
    owner_id: int | None = None,
    owners: list[dict] | None = None,
    assignees: list[dict] | None = None,
    parent_id: int | None = None,
    key_results: list[dict] | None = None,
    tags: list | None = None,
    write_access: bool = True,
    type: str = "PERSONAL",
) -> dict

Generate payload for objective creation.

Source code in src/crew_dcs/routes/objectives/crud.py

def generate_create_objective_body(
    name: str,
    period_id: int,
    description: str | None = None,
    starts_at: str | None = None,
    expires_at: str | None = None,
    status: str = "NOT_STARTED",
    owner_id: int | None = None,
    owners: list[dict] | None = None,
    assignees: list[dict] | None = None,
    parent_id: int | None = None,
    key_results: list[dict] | None = None,
    tags: list | None = None,
    write_access: bool = True,
    type: str = "PERSONAL",
) -> dict:
    """Generate payload for objective creation."""
    return {
        "name": name,
        "description": description,
        "startsAt": starts_at,
        "expiresAt": expires_at,
        "status": status,
        "ownerId": owner_id,
        "owners": owners or [],
        "assignees": assignees or [],
        "periodId": period_id,
        "parentId": parent_id,
        "keyResults": key_results or [],
        "tags": tags or [],
        "writeAccess": write_access,
        "type": type,
    }

update_objective async

update_objective(
    auth: DomoAuth,
    objective_id: int | str,
    payload: dict,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Update an existing objective.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
objective_id	int | str	ID of the objective to update	required
payload	dict	Updated objective payload (see generate_create_objective_body for the full set of supported fields)	required
period_id	int | None	Optional period ID query parameter	None
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the updated objective

Raises:

Type	Description
Objectives_CRUD_Error	If objective update fails

Source code in src/crew_dcs/routes/objectives/crud.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def update_objective(
    auth: DomoAuth,
    objective_id: int | str,
    payload: dict,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Update an existing objective.

    Args:
        auth: Authentication object for API requests
        objective_id: ID of the objective to update
        payload: Updated objective payload (see generate_create_objective_body
            for the full set of supported fields)
        period_id: Optional period ID query parameter
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the updated objective

    Raises:
        Objectives_CRUD_Error: If objective update fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/{objective_id}"
    )
    params = {}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=payload,
        params=params,
        context=context,
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_CRUD_Error(
            operation="update", objective_id=str(objective_id), res=res
        )
    return res