Skip to content

publish_status

publish_status

Publication status and history routes.

Read-only (GET) routes under /api/publish/v2/.

GET_PublishStatus_Error 

GET_PublishStatus_Error(
    res: ResponseGetData, message: str | None = None
)

Bases: RouteError

Raised when a publication status GET request returns a non-success response.

Build the error from the failed response.

Parameters:

Name Type Description Default
res ResponseGetData

The failed response.

 required
message str | None

Optional message overriding the default.

 None
Source code in src/crew_dcs/routes/publish_status.py 
38
39
40
41
42
43
44
45
def __init__(self, res: rgd.ResponseGetData, message: str | None = None) -> None:
    """Build the error from the failed response.

    Args:
        res: The failed response.
        message: Optional message overriding the default.
    """
    super().__init__(res=res, message=message)

get_all_publications_status async 

get_all_publications_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the status of all publications (Postman: Get All Publication Status).

GET /api/publish/v2/publications/status/all

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_all_publications_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the status of all publications (Postman: Get All Publication Status).

    ``GET /api/publish/v2/publications/status/all``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = (
        f"https://{auth.domo_instance}.domo.com/api/publish/v2/publications/status/all"
    )

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res

get_publication_history async 

get_publication_history(
    auth: DomoAuth,
    publication_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the history of one publication (Postman: Get Publication History).

GET /api/publish/v2/publications/{publication_id}/history

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
publication_id str

Publication ID.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_history(
    auth: DomoAuth,
    publication_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the history of one publication (Postman: Get Publication History).

    ``GET /api/publish/v2/publications/{publication_id}/history``

    Args:
        auth: Authenticated Domo session.
        publication_id: Publication ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/publications/{publication_id}/history"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res

get_publication_status async 

get_publication_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the status of the publications (Postman: Get Publication Status).

GET /api/publish/v2/publication/status

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the status of the publications (Postman: Get Publication Status).

    ``GET /api/publish/v2/publication/status``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/publication/status"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res

get_publication_status_by_id async 

get_publication_status_by_id(
    auth: DomoAuth,
    pub_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the status of one publication (Postman: Get Publication Status By Id).

GET /api/publish/v2/publications/status/{pub_id}

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
pub_id str

Publication ID.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
197
198
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_status_by_id(
    auth: DomoAuth,
    pub_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the status of one publication (Postman: Get Publication Status By Id).

    ``GET /api/publish/v2/publications/status/{pub_id}``

    Args:
        auth: Authenticated Domo session.
        pub_id: Publication ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/publications/status/{pub_id}"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res

get_publication_summary_counts async 

get_publication_summary_counts(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get publication summary counts (Postman: Get Publication Summary Counts).

GET /api/publish/v2/publications/summaries/counts

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
290
291
292
293
294
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_summary_counts(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get publication summary counts (Postman: Get Publication Summary Counts).

    ``GET /api/publish/v2/publications/summaries/counts``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/publications/summaries/counts"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res

get_publications_status async 

get_publications_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get publications status (Postman: Get Status).

GET /api/publish/v2/publications/status

Parameters:

Name Type Description Default
auth DomoAuth

Authenticated Domo session.

 required
return_raw bool

If True, return the response without raising on failure.

 False
context RouteContext | None

Optional pre-built route context.

 None
**context_kwargs Any

Extra context overrides consumed by route_function.

 {}

Returns:

Type Description
ResponseGetData

The API response.

Raises:

Type Description
GET_PublishStatus_Error

If the response is not successful and return_raw is False.
Source code in src/crew_dcs/routes/publish_status.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
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
136
137
138
139
140
141
142
143
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publications_status(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get publications status (Postman: Get Status).

    ``GET /api/publish/v2/publications/status``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishStatus_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/publications/status"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishStatus_Error(res)

    return res