OrderfulClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'Communication-Channel': {'operation_id': 'Communication-Channel', 'path': '/{connectionId}/v2/destinations', 'method': 'post', 'required_parameters': [], 'callback_payload_type': 'CommunicationChannelCreationResponse'}}

Classes

CreateTransactionInput dataclass

CreateTransactionInput(*, additional_properties: Dict[str, Any] = dict())

Create Transaction

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CommunicationChannelInput dataclass

CommunicationChannelInput(is_active: bool, name: str, config: Dict[str, Any], owner_id: int)

Listen to Communication Channel

Attributes

name instance-attribute

name: str

Communication Channel Name.

config instance-attribute

config: Dict[str, Any]

Configuration of the Trigger

owner_id class-attribute instance-attribute

owner_id: int = dataclass_field(metadata={'wire_name': 'ownerId'})

Owner of the Orderful account.

CommunicationChannelCreationResponse dataclass

CommunicationChannelCreationResponse(*, id: Optional[int] = None)

Response for Listen to Communication Channel

CommunicationChannelEventResponse dataclass

CommunicationChannelEventResponse(*, additional_properties: Dict[str, Any] = dict())

Definition: CommunicationChannelEventResponse

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CommunicationChannelRequestBody dataclass

CommunicationChannelRequestBody(is_active: bool, name: str, config: Dict[str, Any], owner_id: int)

Definition: CommunicationChannelRequestBody

Attributes

is_active class-attribute instance-attribute

is_active: bool = dataclass_field(metadata={'wire_name': 'isActive'})

If the State of the Trigger is active.

name instance-attribute

name: str

Communication Channel Name.

config instance-attribute

config: Dict[str, Any]

Configuration of the Trigger.

owner_id class-attribute instance-attribute

owner_id: int = dataclass_field(metadata={'wire_name': 'ownerId'})

Owner of the Orderful account.

OrderfulClient

OrderfulClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for orderful connector.

Initialize a OrderfulClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_transactions async

list_transactions(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

List Transactions

Fetches a list of transactions as specified by the filter/sort parameters supplied.

Swagger operation ID: ListTransactions.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_transaction async

create_transaction(input: CreateTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Create Transaction

Create Transaction.

Swagger operation ID: CreateTransaction.

Parameters:

Name	Type	Description	Default
input	CreateTransactionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_transaction_by_id async

get_transaction_by_id(transaction_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get Transaction by ID

Get transaction by ID.

Swagger operation ID: GetTransactionById.

Parameters:

Name	Type	Description	Default
transaction_id	int	The transaction Id used to retrieve transaction..	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.