Skip to content

group

group

generate_body_create_group 

generate_body_create_group(
    group_name: str,
    group_type: str = "open",
    description: str = "",
) -> dict

Generates the body to create group for content_v2_group API

Source code in src/crew_dcs/routes/group.py 
297
298
299
300
301
302
303
def generate_body_create_group(
    group_name: str, group_type: str = "open", description: str = ""
) -> dict:
    """Generates the body to create group for content_v2_group API"""
    body = {"name": group_name, "type": group_type, "description": description}

    return body  # noqa: RET504

generate_body_update_group_membership 

generate_body_update_group_membership(
    group_id: str,
    add_owner_arr: list[str] | None = None,
    remove_owner_arr: list[str] | None = None,
    remove_member_arr: list[str] | None = None,
    add_member_arr: list[str] | None = None,
) -> list[dict]

each member or owner obj should be an object of shape {"type", "id"}

Source code in src/crew_dcs/routes/group.py 
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
def generate_body_update_group_membership(
    group_id: str,
    add_owner_arr: list[str] | None = None,
    remove_owner_arr: list[str] | None = None,
    remove_member_arr: list[str] | None = None,
    add_member_arr: list[str] | None = None,
) -> list[dict]:
    """
    each member or owner obj should be an object of shape {"type", "id"}
    """
    body = {"groupId": int(group_id)}

    if add_owner_arr and len(add_owner_arr) > 0:
        body.update({"addOwners": add_owner_arr})

    if remove_owner_arr and len(remove_owner_arr) > 0:
        body.update({"removeOwners": remove_owner_arr})

    if remove_member_arr and len(remove_member_arr) > 0:
        body.update({"removeMembers": remove_member_arr})
    if add_member_arr and len(add_member_arr) > 0:
        body.update({"addMembers": add_member_arr})

    return [body]

get_all_groups async 

get_all_groups(
    auth: DomoAuth,
    *,
    context: RouteContext | None = None,
    debug_loop: bool = False,
    return_raw: bool = False,
    maximum=None,
    **context_kwargs
) -> ResponseGetData

uses /content/v2/groups/grouplist api -- includes user details

Source code in src/crew_dcs/routes/group.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_all_groups(
    auth: DomoAuth,
    *,
    context: RouteContext | None = None,
    debug_loop: bool = False,
    return_raw: bool = False,
    maximum=None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """uses /content/v2/groups/grouplist api -- includes user details"""

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/grouplist"

    def arr_fn(res):
        return res.response

    res = await gd.looper(
        offset_params={"offset": "offset", "limit": "limit"},
        arr_fn=arr_fn,
        loop_until_end=maximum is None,
        limit=30,
        url=url,
        method="GET",
        auth=auth,
        context=context,
        debug_loop=debug_loop,
        return_raw=return_raw,
        maximum=maximum,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise Group_GET_Error(res=res)

    return res

get_group_by_id async 

get_group_by_id(
    auth: DomoAuth,
    group_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

uses /content/v2/groups/ api -- does not return details

Source code in src/crew_dcs/routes/group.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_group_by_id(
    auth: DomoAuth,
    group_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """uses /content/v2/groups/ api -- does not return details"""

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/{group_id}"

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

    if res.status == 404 and res.response == "Not Found":
        raise SearchGroups_Error(
            res=res,
            message=f"group {group_id} not found",
        )

    if not res.is_success:
        raise Group_GET_Error(res=res)

    return res

search_groups_by_name async 

search_groups_by_name(
    auth: DomoAuth,
    search_name: str,
    is_exact_match: bool = True,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

uses /content/v2/groups/grouplist api -- includes user details

Source code in src/crew_dcs/routes/group.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def search_groups_by_name(
    auth: DomoAuth,
    search_name: str,
    is_exact_match: bool = True,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """uses /content/v2/groups/grouplist api -- includes user details"""

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/grouplist?ascending=true&search={search_name}&sort=name "

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )
    if not res.is_success:
        raise Group_GET_Error(res=res)

    if not is_exact_match:
        return res

    match_group = next(
        (group for group in res.response if group.get("name") == search_name), None
    )

    if not match_group:
        raise SearchGroups_Error(
            res=res,
            message=f"There is no exact match for {search_name}",
        )

    res.response = match_group

    return res

update_group_members async 

update_group_members(
    auth: DomoAuth,
    group_id: str,
    add_member_arr: list[dict] | None = None,
    remove_member_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

each member or owner obj should be an object of shape {"type", "id"}

Source code in src/crew_dcs/routes/group.py 
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def update_group_members(
    auth: DomoAuth,
    group_id: str,
    add_member_arr: list[dict] | None = None,
    remove_member_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    each member or owner obj should be an object of shape {"type", "id"}
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    body = generate_body_update_group_membership(
        group_id=group_id,
        add_member_arr=add_member_arr,
        remove_member_arr=remove_member_arr,
    )

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/access"

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

    if not res.is_success:
        raise Group_CRUD_Error(res=res)

    return res

update_group_membership async 

update_group_membership(
    auth: DomoAuth,
    group_id: str,
    update_payload: dict | None = None,
    add_member_arr: list[dict] | None = None,
    remove_member_arr: list[dict] | None = None,
    add_owner_arr: list[dict] | None = None,
    remove_owner_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

each member or owner obj should be an object of shape {"type", "id"}

Source code in src/crew_dcs/routes/group.py 
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def update_group_membership(
    auth: DomoAuth,
    group_id: str,
    update_payload: dict | None = None,
    add_member_arr: list[dict] | None = None,
    remove_member_arr: list[dict] | None = None,
    add_owner_arr: list[dict] | None = None,
    remove_owner_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    each member or owner obj should be an object of shape {"type", "id"}
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    update_payload = update_payload or generate_body_update_group_membership(
        group_id=group_id,
        add_member_arr=add_member_arr,
        remove_member_arr=remove_member_arr,
        add_owner_arr=add_owner_arr,
        remove_owner_arr=remove_owner_arr,
    )

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/access"

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

    if not res.is_success:
        raise Group_CRUD_Error(res=res)

    return res

update_group_owners async 

update_group_owners(
    auth: DomoAuth,
    group_id: str,
    add_owner_arr: list[dict] | None = None,
    remove_owner_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

each member or owner obj should be an object of shape {"type", "id"}

Source code in src/crew_dcs/routes/group.py 
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def update_group_owners(
    auth: DomoAuth,
    group_id: str,
    add_owner_arr: list[dict] | None = None,
    remove_owner_arr: list[dict] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    each member or owner obj should be an object of shape {"type", "id"}
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    body = generate_body_update_group_membership(
        group_id=group_id,
        add_owner_arr=add_owner_arr,
        remove_owner_arr=remove_owner_arr,
    )

    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/groups/access"

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

    if not res.is_success:
        raise Group_CRUD_Error(res=res)

    return res