Skip to content

DomoFileShare

DomoFileShare

DomoFileShare dataclass 

DomoFileShare(
    auth: DomoAuth,
    id: str,
    raw: dict = dict(),
    name: str | None = None,
    description: str | None = None,
)

Bases: DomoEntity

Represents a single Domo FileShare entity.

add_permissions async 

add_permissions(
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoFileShare | ResponseGetData

Add permissions to this fileshare.

Source code in src/crew_dcs/classes/DomoFileShare.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
async def add_permissions(
    self,
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoFileShare | ResponseGetData:
    """Add permissions to this fileshare."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.add_share_permissions(
        share_id=self.id,
        auth=self.auth,
        body=body,
        context=context,
    )

    if return_raw:
        return res

    await self.refresh()
    return self

delete async 

delete(
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> bool | ResponseGetData

Delete this fileshare.

Source code in src/crew_dcs/classes/DomoFileShare.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
async def delete(
    self,
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> bool | ResponseGetData:
    """Delete this fileshare."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.delete_share(
        share_id=self.id,
        auth=self.auth,
        context=context,
    )

    if return_raw:
        return res

    return res.is_success

get_by_id async classmethod 

get_by_id(
    auth: DomoAuth,
    share_id: str,
    debug_num_stacks_to_drop: int = 2,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoFileShare | ResponseGetData

Retrieve a fileshare by filtering the full shares list.

Source code in src/crew_dcs/classes/DomoFileShare.py 
 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
@classmethod
async def get_by_id(
    cls,
    auth: DomoAuth,
    share_id: str,
    debug_num_stacks_to_drop: int = 2,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoFileShare | ResponseGetData:
    """Retrieve a fileshare by filtering the full shares list."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        **context_kwargs,
    )

    # No get-by-id endpoint exists; pull all shares and filter.
    res = await fileshare_routes.get_shares(
        auth=auth,
        context=context,
    )

    if return_raw:
        return res

    shares = res.response if isinstance(res.response, list) else []
    match = next((s for s in shares if str(s.get("id")) == str(share_id)), None)
    if match is None:
        return None
    return cls.from_dict(auth=auth, obj=match)

get_entity_by_id async classmethod 

get_entity_by_id(
    auth: DomoAuth,
    entity_id: str,
    debug_num_stacks_to_drop: int = 2,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    check_if_published: bool | None = None,
    parent_auth_retrieval_fn: Any | None = None,
    parent_auth: Any | None = None,
    **kwargs
) -> DomoFileShare

Internal wrapper used by base refresh() method.

Source code in src/crew_dcs/classes/DomoFileShare.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@classmethod
async def get_entity_by_id(
    cls,
    auth: DomoAuth,
    entity_id: str,
    debug_num_stacks_to_drop: int = 2,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    check_if_published: bool | None = None,
    parent_auth_retrieval_fn: Any | None = None,
    parent_auth: Any | None = None,
    **kwargs,
) -> DomoFileShare:
    """Internal wrapper used by base refresh() method."""
    return await cls.get_by_id(
        auth=auth,
        share_id=entity_id,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        debug_api=debug_api,
        session=session,
    )

get_permissions async 

get_permissions(
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[dict] | ResponseGetData

Return the permission list for this fileshare.

Source code in src/crew_dcs/classes/DomoFileShare.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
async def get_permissions(
    self,
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[dict] | ResponseGetData:
    """Return the permission list for this fileshare."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.get_share_permissions(
        share_id=self.id,
        auth=self.auth,
        context=context,
    )

    if return_raw:
        return res

    return res.response if isinstance(res.response, list) else res.response  # noqa: RUF034

update async 

update(
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoFileShare | ResponseGetData

Update this fileshare.

Source code in src/crew_dcs/classes/DomoFileShare.py 
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
async def update(
    self,
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoFileShare | ResponseGetData:
    """Update this fileshare."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.update_share(
        share_id=self.id,
        auth=self.auth,
        body=body,
        context=context,
    )

    if return_raw:
        return res

    await self.refresh()
    return self

DomoFileShares dataclass 

DomoFileShares(auth: DomoAuth)

Bases: DomoManager

Collection manager for DomoFileShare objects.

create async 

create(
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoFileShare | ResponseGetData

Create a new fileshare and return a DomoFileShare instance.

Source code in src/crew_dcs/classes/DomoFileShare.py 
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
async def create(
    self,
    body: dict[str, Any],
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoFileShare | ResponseGetData:
    """Create a new fileshare and return a DomoFileShare instance."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.create_share(
        auth=self.auth,
        body=body,
        context=context,
    )

    if return_raw:
        return res

    return DomoFileShare.from_dict(auth=self.auth, obj=res.response)

get async 

get(
    *args: Any,
    return_raw: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[DomoFileShare] | ResponseGetData

Return all fileshares as DomoFileShare instances.

Source code in src/crew_dcs/classes/DomoFileShare.py 
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
async def get(
    self,
    *args: Any,
    return_raw: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[DomoFileShare] | ResponseGetData:
    """Return all fileshares as DomoFileShare instances."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await fileshare_routes.get_shares(
        auth=self.auth,
        context=context,
    )

    if return_raw:
        return res

    shares = res.response if isinstance(res.response, list) else []
    return [DomoFileShare.from_dict(auth=self.auth, obj=s) for s in shares]