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] = field(default_factory=dict)

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

CommunicationChannelInput dataclass

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

Listen to Communication Channel

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Communication Channel Name.

config class-attribute instance-attribute

config: Optional[Dict[str, Any]] = None

Configuration of the Trigger

owner_id class-attribute instance-attribute

owner_id: Optional[int] = field(default=None, 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] = field(default_factory=dict)

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

CommunicationChannelRequestBody dataclass

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

Definition: CommunicationChannelRequestBody

Attributes

is_active class-attribute instance-attribute

is_active: Optional[bool] = field(default=None, metadata={'wire_name': 'isActive'})

If the State of the Trigger is active.

name class-attribute instance-attribute

name: Optional[str] = None

Communication Channel Name.

config class-attribute instance-attribute

config: Optional[Dict[str, Any]] = None

Configuration of the Trigger.

owner_id class-attribute instance-attribute

owner_id: Optional[int] = field(default=None, metadata={'wire_name': 'ownerId'})

Owner of the Orderful account.

OrderfulClient

OrderfulClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

list_transactions_async async

list_transactions_async() -> None

List Transactions

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

create_transaction_async async

create_transaction_async(input: CreateTransactionInput) -> None

Create Transaction

Create Transaction.

get_transaction_by_id_async async

get_transaction_by_id_async(transaction_id: int) -> None

Get Transaction by ID

Get transaction by ID.