-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathclient.py
More file actions
124 lines (93 loc) · 3.8 KB
/
client.py
File metadata and controls
124 lines (93 loc) · 3.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
95
96
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
# This file was auto-generated by Fern from our API Definition.
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ..types.workflow_export import WorkflowExport
from .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
class WorkflowsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawWorkflowsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawWorkflowsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawWorkflowsClient
"""
return self._raw_client
def export_workflow(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> WorkflowExport:
"""
Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.
{% admonition type="warning" name="Unstable API" %}
This API is currently in the Unstable version. Its behavior may change in future releases.
{% /admonition %}
Parameters
----------
id : str
The unique identifier for the workflow
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkflowExport
Workflow exported successfully
Examples
--------
from intercom import Intercom
client = Intercom(
token="YOUR_TOKEN",
)
client.unstable.workflows.export_workflow(
id="12345",
)
"""
_response = self._raw_client.export_workflow(id, request_options=request_options)
return _response.data
class AsyncWorkflowsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawWorkflowsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawWorkflowsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawWorkflowsClient
"""
return self._raw_client
async def export_workflow(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> WorkflowExport:
"""
Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.
{% admonition type="warning" name="Unstable API" %}
This API is currently in the Unstable version. Its behavior may change in future releases.
{% /admonition %}
Parameters
----------
id : str
The unique identifier for the workflow
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkflowExport
Workflow exported successfully
Examples
--------
import asyncio
from intercom import AsyncIntercom
client = AsyncIntercom(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.unstable.workflows.export_workflow(
id="12345",
)
asyncio.run(main())
"""
_response = await self._raw_client.export_workflow(id, request_options=request_options)
return _response.data