solvimon-python-sdk 0.0.4b0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1196) hide show
  1. solvimon_python_sdk/__init__.py +2413 -0
  2. solvimon_python_sdk/api/__init__.py +74 -0
  3. solvimon_python_sdk/api/alert_rules_api.py +1700 -0
  4. solvimon_python_sdk/api/alerts_api.py +1038 -0
  5. solvimon_python_sdk/api/api_keys_api.py +1973 -0
  6. solvimon_python_sdk/api/approval_policy_api.py +2573 -0
  7. solvimon_python_sdk/api/approval_request_api.py +2673 -0
  8. solvimon_python_sdk/api/attachments_api.py +1329 -0
  9. solvimon_python_sdk/api/audit_records_api.py +786 -0
  10. solvimon_python_sdk/api/authentication_api.py +2714 -0
  11. solvimon_python_sdk/api/authentication_providers_api.py +1638 -0
  12. solvimon_python_sdk/api/billing_entities_api.py +1698 -0
  13. solvimon_python_sdk/api/bulk_actions_api.py +2150 -0
  14. solvimon_python_sdk/api/contacts_api.py +2036 -0
  15. solvimon_python_sdk/api/coupons_api.py +3059 -0
  16. solvimon_python_sdk/api/credit_types_api.py +2597 -0
  17. solvimon_python_sdk/api/custom_fields_api.py +1724 -0
  18. solvimon_python_sdk/api/customers_api.py +4667 -0
  19. solvimon_python_sdk/api/documents_api.py +1274 -0
  20. solvimon_python_sdk/api/features_api.py +2003 -0
  21. solvimon_python_sdk/api/file_processing_settings_api.py +991 -0
  22. solvimon_python_sdk/api/files_api.py +1716 -0
  23. solvimon_python_sdk/api/ingest_api.py +5989 -0
  24. solvimon_python_sdk/api/integrations_api.py +3297 -0
  25. solvimon_python_sdk/api/invoices_api.py +9743 -0
  26. solvimon_python_sdk/api/meter_properties_api.py +1648 -0
  27. solvimon_python_sdk/api/meter_property_variables_api.py +2473 -0
  28. solvimon_python_sdk/api/meter_value_calculations_api.py +1688 -0
  29. solvimon_python_sdk/api/meter_values_api.py +1648 -0
  30. solvimon_python_sdk/api/meters_api.py +1990 -0
  31. solvimon_python_sdk/api/payment_acceptors_api.py +1971 -0
  32. solvimon_python_sdk/api/payment_methods_api.py +2370 -0
  33. solvimon_python_sdk/api/payment_schedules_api.py +2641 -0
  34. solvimon_python_sdk/api/payments_api.py +3133 -0
  35. solvimon_python_sdk/api/platforms_api.py +1584 -0
  36. solvimon_python_sdk/api/portal_urls_api.py +1703 -0
  37. solvimon_python_sdk/api/pricing_groups_api.py +1290 -0
  38. solvimon_python_sdk/api/pricing_plan_groups_api.py +2579 -0
  39. solvimon_python_sdk/api/pricing_plan_schedules_api.py +3507 -0
  40. solvimon_python_sdk/api/pricing_plan_subscription_groups_api.py +1736 -0
  41. solvimon_python_sdk/api/pricing_plan_subscriptions_api.py +4918 -0
  42. solvimon_python_sdk/api/pricing_plan_versions_api.py +1629 -0
  43. solvimon_python_sdk/api/pricing_plans_api.py +2475 -0
  44. solvimon_python_sdk/api/pricings_api.py +1008 -0
  45. solvimon_python_sdk/api/product_categories_api.py +2339 -0
  46. solvimon_python_sdk/api/product_items_api.py +3443 -0
  47. solvimon_python_sdk/api/products_api.py +3478 -0
  48. solvimon_python_sdk/api/promotion_codes_api.py +2727 -0
  49. solvimon_python_sdk/api/quote_templates_api.py +1987 -0
  50. solvimon_python_sdk/api/quote_versions_api.py +3908 -0
  51. solvimon_python_sdk/api/quotes_api.py +2743 -0
  52. solvimon_python_sdk/api/report_configurations_api.py +1356 -0
  53. solvimon_python_sdk/api/report_definitions_api.py +391 -0
  54. solvimon_python_sdk/api/report_subscriptions_api.py +1996 -0
  55. solvimon_python_sdk/api/reports_api.py +4754 -0
  56. solvimon_python_sdk/api/reprocess_api.py +1092 -0
  57. solvimon_python_sdk/api/roles_api.py +1701 -0
  58. solvimon_python_sdk/api/seat_assignments_api.py +1732 -0
  59. solvimon_python_sdk/api/signature_requests_api.py +992 -0
  60. solvimon_python_sdk/api/tax_id_types_api.py +343 -0
  61. solvimon_python_sdk/api/teams_api.py +1322 -0
  62. solvimon_python_sdk/api/usage_limits_api.py +2306 -0
  63. solvimon_python_sdk/api/users_api.py +3961 -0
  64. solvimon_python_sdk/api/wallet_grants_api.py +1076 -0
  65. solvimon_python_sdk/api/wallet_types_api.py +2576 -0
  66. solvimon_python_sdk/api/wallets_api.py +4168 -0
  67. solvimon_python_sdk/api/webhook_events_api.py +1042 -0
  68. solvimon_python_sdk/api/webhooks_api.py +3557 -0
  69. solvimon_python_sdk/api/workflow_action_executions_api.py +1409 -0
  70. solvimon_python_sdk/api/workflow_actions_api.py +1630 -0
  71. solvimon_python_sdk/api/workflow_triggers_api.py +1451 -0
  72. solvimon_python_sdk/api/workflows_api.py +3259 -0
  73. solvimon_python_sdk/api_client.py +843 -0
  74. solvimon_python_sdk/api_response.py +21 -0
  75. solvimon_python_sdk/configuration.py +688 -0
  76. solvimon_python_sdk/exceptions.py +219 -0
  77. solvimon_python_sdk/models/__init__.py +1130 -0
  78. solvimon_python_sdk/models/account_membership_representation.py +132 -0
  79. solvimon_python_sdk/models/account_membership_representation_create_request.py +132 -0
  80. solvimon_python_sdk/models/account_membership_representation_update_request.py +132 -0
  81. solvimon_python_sdk/models/account_number_and_bic.py +124 -0
  82. solvimon_python_sdk/models/account_representation.py +101 -0
  83. solvimon_python_sdk/models/address.py +109 -0
  84. solvimon_python_sdk/models/address_create_request.py +109 -0
  85. solvimon_python_sdk/models/address_update_request.py +109 -0
  86. solvimon_python_sdk/models/adyen_auto_rescue.py +95 -0
  87. solvimon_python_sdk/models/adyen_direct_payment_context.py +95 -0
  88. solvimon_python_sdk/models/adyen_integration_details.py +89 -0
  89. solvimon_python_sdk/models/adyen_issuer.py +91 -0
  90. solvimon_python_sdk/models/adyen_payment_action.py +91 -0
  91. solvimon_python_sdk/models/adyen_payment_gateway_integration.py +152 -0
  92. solvimon_python_sdk/models/adyen_payment_method_option.py +110 -0
  93. solvimon_python_sdk/models/adyen_required_action.py +97 -0
  94. solvimon_python_sdk/models/adyen_tokenization_request.py +97 -0
  95. solvimon_python_sdk/models/adyen_tokenization_request_create_request.py +97 -0
  96. solvimon_python_sdk/models/adyen_verify_details.py +95 -0
  97. solvimon_python_sdk/models/adyen_verify_details_create_request.py +95 -0
  98. solvimon_python_sdk/models/agent_context.py +100 -0
  99. solvimon_python_sdk/models/agent_context_create_request.py +100 -0
  100. solvimon_python_sdk/models/agent_context_update_request.py +100 -0
  101. solvimon_python_sdk/models/alert.py +141 -0
  102. solvimon_python_sdk/models/alert_create_request.py +138 -0
  103. solvimon_python_sdk/models/alert_data.py +99 -0
  104. solvimon_python_sdk/models/alert_data_create_request.py +99 -0
  105. solvimon_python_sdk/models/alert_data_entitlement.py +105 -0
  106. solvimon_python_sdk/models/alert_data_invoice.py +95 -0
  107. solvimon_python_sdk/models/alert_data_invoice_overdue.py +96 -0
  108. solvimon_python_sdk/models/alert_data_value.py +95 -0
  109. solvimon_python_sdk/models/alert_response_wrapper.py +108 -0
  110. solvimon_python_sdk/models/alert_rule.py +193 -0
  111. solvimon_python_sdk/models/alert_rule_create_request.py +187 -0
  112. solvimon_python_sdk/models/alert_rule_create_request_event.py +193 -0
  113. solvimon_python_sdk/models/alert_rule_entitlement.py +115 -0
  114. solvimon_python_sdk/models/alert_rule_entitlement_create_request.py +115 -0
  115. solvimon_python_sdk/models/alert_rule_entitlement_update_request.py +115 -0
  116. solvimon_python_sdk/models/alert_rule_invoice.py +105 -0
  117. solvimon_python_sdk/models/alert_rule_invoice_create_request.py +105 -0
  118. solvimon_python_sdk/models/alert_rule_invoice_overdue.py +105 -0
  119. solvimon_python_sdk/models/alert_rule_invoice_update_request.py +105 -0
  120. solvimon_python_sdk/models/alert_rule_response_wrapper.py +108 -0
  121. solvimon_python_sdk/models/alert_rule_update_request.py +193 -0
  122. solvimon_python_sdk/models/amount.py +112 -0
  123. solvimon_python_sdk/models/amount_create_request.py +112 -0
  124. solvimon_python_sdk/models/amount_update_request.py +112 -0
  125. solvimon_python_sdk/models/api_error.py +123 -0
  126. solvimon_python_sdk/models/api_key.py +157 -0
  127. solvimon_python_sdk/models/api_key_create_request.py +157 -0
  128. solvimon_python_sdk/models/api_key_paginated_response_wrapper.py +108 -0
  129. solvimon_python_sdk/models/api_key_update_request.py +157 -0
  130. solvimon_python_sdk/models/applied_coupon.py +109 -0
  131. solvimon_python_sdk/models/applied_coupon_update_request.py +109 -0
  132. solvimon_python_sdk/models/approval_group.py +98 -0
  133. solvimon_python_sdk/models/approval_policy.py +169 -0
  134. solvimon_python_sdk/models/approval_policy_approver.py +105 -0
  135. solvimon_python_sdk/models/approval_policy_billing_entity.py +89 -0
  136. solvimon_python_sdk/models/approval_policy_billing_period.py +89 -0
  137. solvimon_python_sdk/models/approval_policy_commitment.py +93 -0
  138. solvimon_python_sdk/models/approval_policy_create_request.py +160 -0
  139. solvimon_python_sdk/models/approval_policy_custom_field.py +91 -0
  140. solvimon_python_sdk/models/approval_policy_discount.py +95 -0
  141. solvimon_python_sdk/models/approval_policy_due_date.py +89 -0
  142. solvimon_python_sdk/models/approval_policy_payment_acceptor.py +89 -0
  143. solvimon_python_sdk/models/approval_policy_pricing.py +89 -0
  144. solvimon_python_sdk/models/approval_policy_rule.py +159 -0
  145. solvimon_python_sdk/models/approval_policy_rule_group.py +96 -0
  146. solvimon_python_sdk/models/approval_policy_rule_group_create_request.py +96 -0
  147. solvimon_python_sdk/models/approval_policy_rule_group_update_request.py +96 -0
  148. solvimon_python_sdk/models/approval_policy_update_request.py +169 -0
  149. solvimon_python_sdk/models/approval_policy_user.py +89 -0
  150. solvimon_python_sdk/models/approval_request.py +183 -0
  151. solvimon_python_sdk/models/approval_request_action_result.py +121 -0
  152. solvimon_python_sdk/models/approval_request_response_wrapper.py +108 -0
  153. solvimon_python_sdk/models/approvers.py +109 -0
  154. solvimon_python_sdk/models/approvers_create_request.py +109 -0
  155. solvimon_python_sdk/models/approvers_update_request.py +109 -0
  156. solvimon_python_sdk/models/ar_local.py +124 -0
  157. solvimon_python_sdk/models/attachment.py +115 -0
  158. solvimon_python_sdk/models/attachment_create_request.py +115 -0
  159. solvimon_python_sdk/models/attachment_response_wrapper.py +96 -0
  160. solvimon_python_sdk/models/audit_record.py +154 -0
  161. solvimon_python_sdk/models/audit_record_diff_entry.py +103 -0
  162. solvimon_python_sdk/models/audit_record_response_wrapper.py +108 -0
  163. solvimon_python_sdk/models/authentication_provider.py +138 -0
  164. solvimon_python_sdk/models/authentication_provider_create_request.py +135 -0
  165. solvimon_python_sdk/models/authentication_provider_request.py +91 -0
  166. solvimon_python_sdk/models/authentication_provider_request_create_request.py +91 -0
  167. solvimon_python_sdk/models/authentication_provider_response_wrapper.py +108 -0
  168. solvimon_python_sdk/models/authentication_provider_update_request.py +138 -0
  169. solvimon_python_sdk/models/authentication_settings.py +105 -0
  170. solvimon_python_sdk/models/authentication_settings_api_key.py +91 -0
  171. solvimon_python_sdk/models/authentication_settings_api_key_create_request.py +91 -0
  172. solvimon_python_sdk/models/authentication_settings_create_request.py +105 -0
  173. solvimon_python_sdk/models/authentication_settings_update_request.py +105 -0
  174. solvimon_python_sdk/models/authorize_payment_request.py +133 -0
  175. solvimon_python_sdk/models/authorize_payment_request_create_request.py +133 -0
  176. solvimon_python_sdk/models/auto_topup_config.py +135 -0
  177. solvimon_python_sdk/models/auto_topup_config_create_request.py +135 -0
  178. solvimon_python_sdk/models/auto_topup_config_response_wrapper.py +108 -0
  179. solvimon_python_sdk/models/auto_topup_threshold.py +99 -0
  180. solvimon_python_sdk/models/ava_tax_calculation_integration.py +89 -0
  181. solvimon_python_sdk/models/available_custom_field_column.py +95 -0
  182. solvimon_python_sdk/models/available_custom_field_column_create_request.py +95 -0
  183. solvimon_python_sdk/models/available_custom_field_column_update_request.py +95 -0
  184. solvimon_python_sdk/models/balance_platform_details.py +95 -0
  185. solvimon_python_sdk/models/bank_account.py +228 -0
  186. solvimon_python_sdk/models/bank_account_create_request.py +228 -0
  187. solvimon_python_sdk/models/big_query.py +99 -0
  188. solvimon_python_sdk/models/billing_entity.py +218 -0
  189. solvimon_python_sdk/models/billing_entity_create_request.py +215 -0
  190. solvimon_python_sdk/models/billing_entity_create_request_transaction.py +218 -0
  191. solvimon_python_sdk/models/billing_entity_response_wrapper.py +96 -0
  192. solvimon_python_sdk/models/billing_entity_update_request.py +218 -0
  193. solvimon_python_sdk/models/billing_period_option.py +95 -0
  194. solvimon_python_sdk/models/billing_period_settings.py +96 -0
  195. solvimon_python_sdk/models/billing_period_settings_create_request.py +96 -0
  196. solvimon_python_sdk/models/billing_period_settings_update_request.py +96 -0
  197. solvimon_python_sdk/models/br_local.py +124 -0
  198. solvimon_python_sdk/models/branding.py +108 -0
  199. solvimon_python_sdk/models/branding_update_request.py +108 -0
  200. solvimon_python_sdk/models/bulk_action_check.py +110 -0
  201. solvimon_python_sdk/models/bulk_action_item.py +109 -0
  202. solvimon_python_sdk/models/bulk_action_item_generated_resource.py +101 -0
  203. solvimon_python_sdk/models/bulk_action_item_resource.py +101 -0
  204. solvimon_python_sdk/models/bulk_action_item_response_wrapper.py +108 -0
  205. solvimon_python_sdk/models/bulk_action_request.py +111 -0
  206. solvimon_python_sdk/models/bulk_action_request_create_request.py +108 -0
  207. solvimon_python_sdk/models/bulk_action_response.py +115 -0
  208. solvimon_python_sdk/models/bulk_action_response_wrapper.py +108 -0
  209. solvimon_python_sdk/models/bulk_approval_request_action.py +89 -0
  210. solvimon_python_sdk/models/bulk_approval_request_action_create_request.py +89 -0
  211. solvimon_python_sdk/models/bulk_approval_request_action_response_wrapper.py +96 -0
  212. solvimon_python_sdk/models/captcha_request.py +91 -0
  213. solvimon_python_sdk/models/captcha_request_create_request.py +91 -0
  214. solvimon_python_sdk/models/charge.py +96 -0
  215. solvimon_python_sdk/models/charge_data_period.py +94 -0
  216. solvimon_python_sdk/models/charge_data_period_create_request.py +94 -0
  217. solvimon_python_sdk/models/charge_on_demand_payment_context.py +101 -0
  218. solvimon_python_sdk/models/charge_on_demand_payment_context_pricing_item.py +101 -0
  219. solvimon_python_sdk/models/charge_on_demand_pricing_item.py +103 -0
  220. solvimon_python_sdk/models/charge_on_demand_pricing_items.py +107 -0
  221. solvimon_python_sdk/models/charge_on_demand_pricing_items_create_request.py +107 -0
  222. solvimon_python_sdk/models/charge_on_demand_pricing_items_pricing_item_config.py +101 -0
  223. solvimon_python_sdk/models/charge_on_demand_pricing_items_pricing_item_config_create_request.py +101 -0
  224. solvimon_python_sdk/models/client_credentials.py +91 -0
  225. solvimon_python_sdk/models/client_credentials_create_request.py +91 -0
  226. solvimon_python_sdk/models/colors.py +112 -0
  227. solvimon_python_sdk/models/column_mapping.py +91 -0
  228. solvimon_python_sdk/models/commitment.py +123 -0
  229. solvimon_python_sdk/models/commitment_update_request.py +123 -0
  230. solvimon_python_sdk/models/configured_meter_value.py +104 -0
  231. solvimon_python_sdk/models/configured_meter_value_included_volume.py +104 -0
  232. solvimon_python_sdk/models/configured_meter_value_included_volume_update_request.py +104 -0
  233. solvimon_python_sdk/models/configured_meter_value_update_request.py +104 -0
  234. solvimon_python_sdk/models/contact.py +155 -0
  235. solvimon_python_sdk/models/contact_create_request.py +152 -0
  236. solvimon_python_sdk/models/contact_response_wrapper.py +108 -0
  237. solvimon_python_sdk/models/contact_update_request.py +155 -0
  238. solvimon_python_sdk/models/cost_prediction.py +129 -0
  239. solvimon_python_sdk/models/cost_prediction_create_request.py +129 -0
  240. solvimon_python_sdk/models/cost_prediction_details.py +128 -0
  241. solvimon_python_sdk/models/coupon.py +180 -0
  242. solvimon_python_sdk/models/coupon_create_request.py +174 -0
  243. solvimon_python_sdk/models/coupon_discount.py +119 -0
  244. solvimon_python_sdk/models/coupon_discount_create_request.py +119 -0
  245. solvimon_python_sdk/models/coupon_discount_update_request.py +119 -0
  246. solvimon_python_sdk/models/coupon_discount_usage.py +97 -0
  247. solvimon_python_sdk/models/coupon_duration.py +105 -0
  248. solvimon_python_sdk/models/coupon_duration_create_request.py +105 -0
  249. solvimon_python_sdk/models/coupon_duration_update_request.py +105 -0
  250. solvimon_python_sdk/models/coupon_limited_to.py +126 -0
  251. solvimon_python_sdk/models/coupon_limited_to_create_request.py +126 -0
  252. solvimon_python_sdk/models/coupon_limited_to_update_request.py +126 -0
  253. solvimon_python_sdk/models/coupon_redemption.py +127 -0
  254. solvimon_python_sdk/models/coupon_redemption_response_wrapper.py +108 -0
  255. solvimon_python_sdk/models/coupon_response_wrapper.py +108 -0
  256. solvimon_python_sdk/models/coupon_update_request.py +180 -0
  257. solvimon_python_sdk/models/create_payment_method_payment_context.py +89 -0
  258. solvimon_python_sdk/models/create_pricing_plan_schedule_payment_context.py +96 -0
  259. solvimon_python_sdk/models/credit_and_copy_invoice_request.py +103 -0
  260. solvimon_python_sdk/models/credit_and_copy_invoice_request_create_request.py +103 -0
  261. solvimon_python_sdk/models/credit_and_copy_invoice_response.py +93 -0
  262. solvimon_python_sdk/models/credit_invoice_group.py +104 -0
  263. solvimon_python_sdk/models/credit_invoice_group_create_request.py +104 -0
  264. solvimon_python_sdk/models/credit_invoice_line.py +95 -0
  265. solvimon_python_sdk/models/credit_invoice_period.py +104 -0
  266. solvimon_python_sdk/models/credit_invoice_period_create_request.py +104 -0
  267. solvimon_python_sdk/models/credit_type.py +158 -0
  268. solvimon_python_sdk/models/credit_type_create_request.py +158 -0
  269. solvimon_python_sdk/models/credit_type_response_wrapper.py +108 -0
  270. solvimon_python_sdk/models/credit_type_update_request.py +158 -0
  271. solvimon_python_sdk/models/credits.py +110 -0
  272. solvimon_python_sdk/models/credits_create_request.py +110 -0
  273. solvimon_python_sdk/models/crm_integrations.py +93 -0
  274. solvimon_python_sdk/models/crm_integrations_update_request.py +93 -0
  275. solvimon_python_sdk/models/currency.py +107 -0
  276. solvimon_python_sdk/models/custom_field.py +154 -0
  277. solvimon_python_sdk/models/custom_field_create_request.py +148 -0
  278. solvimon_python_sdk/models/custom_field_response_wrapper.py +108 -0
  279. solvimon_python_sdk/models/custom_field_update_request.py +154 -0
  280. solvimon_python_sdk/models/custom_field_value.py +116 -0
  281. solvimon_python_sdk/models/custom_field_value_create_request.py +116 -0
  282. solvimon_python_sdk/models/custom_field_value_update_request.py +116 -0
  283. solvimon_python_sdk/models/custom_tax_code.py +101 -0
  284. solvimon_python_sdk/models/customer.py +222 -0
  285. solvimon_python_sdk/models/customer_action_options.py +95 -0
  286. solvimon_python_sdk/models/customer_create_request.py +219 -0
  287. solvimon_python_sdk/models/customer_create_request_event.py +222 -0
  288. solvimon_python_sdk/models/customer_create_request_transaction.py +222 -0
  289. solvimon_python_sdk/models/customer_portal_url.py +99 -0
  290. solvimon_python_sdk/models/customer_portal_url_create_request.py +99 -0
  291. solvimon_python_sdk/models/customer_portal_url_update_request.py +99 -0
  292. solvimon_python_sdk/models/customer_references.py +93 -0
  293. solvimon_python_sdk/models/customer_references_create_request.py +93 -0
  294. solvimon_python_sdk/models/customer_references_update_request.py +93 -0
  295. solvimon_python_sdk/models/customer_response_wrapper.py +108 -0
  296. solvimon_python_sdk/models/customer_seller_details.py +89 -0
  297. solvimon_python_sdk/models/customer_seller_details_create_request.py +89 -0
  298. solvimon_python_sdk/models/customer_seller_details_update_request.py +89 -0
  299. solvimon_python_sdk/models/customer_update_request.py +222 -0
  300. solvimon_python_sdk/models/customer_update_request_transaction.py +222 -0
  301. solvimon_python_sdk/models/customer_wallet_balance_status.py +118 -0
  302. solvimon_python_sdk/models/customer_wallet_balances_status.py +102 -0
  303. solvimon_python_sdk/models/data_export_integration.py +125 -0
  304. solvimon_python_sdk/models/data_export_integration_create_request.py +125 -0
  305. solvimon_python_sdk/models/data_export_integration_update_request.py +125 -0
  306. solvimon_python_sdk/models/default_portal_url_settings.py +93 -0
  307. solvimon_python_sdk/models/default_portal_url_settings_update_request.py +93 -0
  308. solvimon_python_sdk/models/default_value.py +91 -0
  309. solvimon_python_sdk/models/delete_invoice_group.py +98 -0
  310. solvimon_python_sdk/models/delete_invoice_line.py +89 -0
  311. solvimon_python_sdk/models/delete_invoice_period.py +98 -0
  312. solvimon_python_sdk/models/delete_invoice_period_create_request.py +98 -0
  313. solvimon_python_sdk/models/direct_auto_rescue.py +95 -0
  314. solvimon_python_sdk/models/direct_payment_context.py +93 -0
  315. solvimon_python_sdk/models/discount.py +159 -0
  316. solvimon_python_sdk/models/discount_condition.py +105 -0
  317. solvimon_python_sdk/models/discount_condition_value.py +93 -0
  318. solvimon_python_sdk/models/discount_update_request.py +159 -0
  319. solvimon_python_sdk/models/display_config.py +95 -0
  320. solvimon_python_sdk/models/document.py +126 -0
  321. solvimon_python_sdk/models/document_action_settings.py +99 -0
  322. solvimon_python_sdk/models/document_create_request.py +126 -0
  323. solvimon_python_sdk/models/document_number_configuration.py +106 -0
  324. solvimon_python_sdk/models/document_number_configuration_reset_period.py +101 -0
  325. solvimon_python_sdk/models/download_settings.py +93 -0
  326. solvimon_python_sdk/models/download_settings_create_request.py +93 -0
  327. solvimon_python_sdk/models/download_settings_update_request.py +93 -0
  328. solvimon_python_sdk/models/download_url.py +103 -0
  329. solvimon_python_sdk/models/due_date.py +105 -0
  330. solvimon_python_sdk/models/due_date_update_request.py +105 -0
  331. solvimon_python_sdk/models/duplicate.py +91 -0
  332. solvimon_python_sdk/models/e_invoice.py +116 -0
  333. solvimon_python_sdk/models/e_invoice_create_request.py +116 -0
  334. solvimon_python_sdk/models/e_invoice_file_format.py +95 -0
  335. solvimon_python_sdk/models/e_invoice_status.py +99 -0
  336. solvimon_python_sdk/models/e_invoice_update_request.py +116 -0
  337. solvimon_python_sdk/models/e_invoicing_condition.py +103 -0
  338. solvimon_python_sdk/models/e_invoicing_condition_group.py +96 -0
  339. solvimon_python_sdk/models/e_invoicing_integration.py +108 -0
  340. solvimon_python_sdk/models/e_invoicing_integration_create_request.py +108 -0
  341. solvimon_python_sdk/models/e_invoicing_integration_update_request.py +108 -0
  342. solvimon_python_sdk/models/e_invoicing_mandate.py +124 -0
  343. solvimon_python_sdk/models/e_invoicing_mapping.py +93 -0
  344. solvimon_python_sdk/models/email_identifier.py +91 -0
  345. solvimon_python_sdk/models/email_provider_integration.py +111 -0
  346. solvimon_python_sdk/models/email_provider_integration_create_request.py +111 -0
  347. solvimon_python_sdk/models/email_provider_integration_update_request.py +111 -0
  348. solvimon_python_sdk/models/enabled_pricing.py +94 -0
  349. solvimon_python_sdk/models/enabled_pricing_create_request.py +94 -0
  350. solvimon_python_sdk/models/enabled_pricing_update_request.py +94 -0
  351. solvimon_python_sdk/models/entitlement.py +128 -0
  352. solvimon_python_sdk/models/entitlement_create_request.py +128 -0
  353. solvimon_python_sdk/models/entitlement_summary.py +98 -0
  354. solvimon_python_sdk/models/entitlement_summary_item.py +109 -0
  355. solvimon_python_sdk/models/entitlement_update_request.py +128 -0
  356. solvimon_python_sdk/models/entitlements.py +105 -0
  357. solvimon_python_sdk/models/entitlements_create_request.py +105 -0
  358. solvimon_python_sdk/models/erp_integration.py +99 -0
  359. solvimon_python_sdk/models/erp_integration_create_request.py +99 -0
  360. solvimon_python_sdk/models/erp_integration_update_request.py +99 -0
  361. solvimon_python_sdk/models/event_trace.py +130 -0
  362. solvimon_python_sdk/models/event_trace_link.py +143 -0
  363. solvimon_python_sdk/models/expiry_date.py +92 -0
  364. solvimon_python_sdk/models/export_report_location.py +121 -0
  365. solvimon_python_sdk/models/export_report_location_big_query_details.py +89 -0
  366. solvimon_python_sdk/models/export_report_location_create_request.py +121 -0
  367. solvimon_python_sdk/models/export_report_location_gcs_details.py +103 -0
  368. solvimon_python_sdk/models/export_report_location_s3_details.py +103 -0
  369. solvimon_python_sdk/models/export_report_location_update_request.py +121 -0
  370. solvimon_python_sdk/models/export_to_erp_action.py +101 -0
  371. solvimon_python_sdk/models/export_to_erp_action_update_request.py +101 -0
  372. solvimon_python_sdk/models/feature.py +156 -0
  373. solvimon_python_sdk/models/feature_create_request.py +150 -0
  374. solvimon_python_sdk/models/feature_resource_reference.py +102 -0
  375. solvimon_python_sdk/models/feature_response_wrapper.py +96 -0
  376. solvimon_python_sdk/models/feature_update_request.py +156 -0
  377. solvimon_python_sdk/models/file.py +214 -0
  378. solvimon_python_sdk/models/file_create_request.py +202 -0
  379. solvimon_python_sdk/models/file_download_settings.py +89 -0
  380. solvimon_python_sdk/models/file_download_settings_create_request.py +89 -0
  381. solvimon_python_sdk/models/file_download_settings_update_request.py +89 -0
  382. solvimon_python_sdk/models/file_line.py +107 -0
  383. solvimon_python_sdk/models/file_line_response_wrapper.py +108 -0
  384. solvimon_python_sdk/models/file_meter_data.py +92 -0
  385. solvimon_python_sdk/models/file_meter_data_create_request.py +92 -0
  386. solvimon_python_sdk/models/file_meter_data_update_request.py +92 -0
  387. solvimon_python_sdk/models/file_processing_settings.py +151 -0
  388. solvimon_python_sdk/models/file_processing_settings_create_request.py +145 -0
  389. solvimon_python_sdk/models/file_processing_settings_update_request.py +151 -0
  390. solvimon_python_sdk/models/file_response_wrapper.py +108 -0
  391. solvimon_python_sdk/models/file_update_request.py +214 -0
  392. solvimon_python_sdk/models/filter_field.py +95 -0
  393. solvimon_python_sdk/models/filter_field_create_request.py +95 -0
  394. solvimon_python_sdk/models/finalize_invoices_parameters.py +100 -0
  395. solvimon_python_sdk/models/finalize_invoices_parameters_create_request.py +100 -0
  396. solvimon_python_sdk/models/fixed_installment.py +96 -0
  397. solvimon_python_sdk/models/gcs.py +95 -0
  398. solvimon_python_sdk/models/get_all_approval_policies_response.py +96 -0
  399. solvimon_python_sdk/models/get_quotes_list.py +96 -0
  400. solvimon_python_sdk/models/hubspot_integration.py +89 -0
  401. solvimon_python_sdk/models/image.py +108 -0
  402. solvimon_python_sdk/models/inactive_period.py +106 -0
  403. solvimon_python_sdk/models/inactive_period_update_request.py +106 -0
  404. solvimon_python_sdk/models/indexing_settings.py +103 -0
  405. solvimon_python_sdk/models/indexing_settings_create_request.py +103 -0
  406. solvimon_python_sdk/models/indexing_target.py +95 -0
  407. solvimon_python_sdk/models/indexing_target_create_request.py +95 -0
  408. solvimon_python_sdk/models/individual.py +99 -0
  409. solvimon_python_sdk/models/individual_create_request.py +99 -0
  410. solvimon_python_sdk/models/individual_update_request.py +99 -0
  411. solvimon_python_sdk/models/ingest_data_response_wrapper.py +108 -0
  412. solvimon_python_sdk/models/ingest_data_summary.py +104 -0
  413. solvimon_python_sdk/models/ingest_reference_mapping.py +95 -0
  414. solvimon_python_sdk/models/init_pricing_plan_subscription_payment_context.py +119 -0
  415. solvimon_python_sdk/models/init_pricing_plan_subscription_portal_url.py +91 -0
  416. solvimon_python_sdk/models/init_pricing_plan_subscription_portal_url_create_request.py +91 -0
  417. solvimon_python_sdk/models/init_pricing_plan_subscription_portal_url_update_request.py +91 -0
  418. solvimon_python_sdk/models/integration.py +229 -0
  419. solvimon_python_sdk/models/integration_create_request.py +223 -0
  420. solvimon_python_sdk/models/integration_details.py +119 -0
  421. solvimon_python_sdk/models/integration_details_update_request.py +119 -0
  422. solvimon_python_sdk/models/integration_link_detail.py +91 -0
  423. solvimon_python_sdk/models/integration_linked_resource_configuration.py +98 -0
  424. solvimon_python_sdk/models/integration_linked_resource_configuration_create_request.py +98 -0
  425. solvimon_python_sdk/models/integration_linked_resource_configuration_update_request.py +98 -0
  426. solvimon_python_sdk/models/integration_response_wrapper.py +108 -0
  427. solvimon_python_sdk/models/integration_update_request.py +229 -0
  428. solvimon_python_sdk/models/interval_installment.py +105 -0
  429. solvimon_python_sdk/models/invoice.py +566 -0
  430. solvimon_python_sdk/models/invoice_action_credit.py +124 -0
  431. solvimon_python_sdk/models/invoice_action_credit_create_request.py +124 -0
  432. solvimon_python_sdk/models/invoice_action_delete_line.py +96 -0
  433. solvimon_python_sdk/models/invoice_action_delete_line_create_request.py +96 -0
  434. solvimon_python_sdk/models/invoice_action_options.py +91 -0
  435. solvimon_python_sdk/models/invoice_commitment.py +98 -0
  436. solvimon_python_sdk/models/invoice_coupon.py +95 -0
  437. solvimon_python_sdk/models/invoice_coupon_create_request.py +95 -0
  438. solvimon_python_sdk/models/invoice_coupon_update_request.py +95 -0
  439. solvimon_python_sdk/models/invoice_create_request.py +566 -0
  440. solvimon_python_sdk/models/invoice_create_request_transaction.py +563 -0
  441. solvimon_python_sdk/models/invoice_credit_detail.py +111 -0
  442. solvimon_python_sdk/models/invoice_credit_detail_create_request.py +111 -0
  443. solvimon_python_sdk/models/invoice_credit_detail_update_request.py +111 -0
  444. solvimon_python_sdk/models/invoice_dunning_action.py +107 -0
  445. solvimon_python_sdk/models/invoice_dunning_action_create_request.py +107 -0
  446. solvimon_python_sdk/models/invoice_dunning_action_update_request.py +107 -0
  447. solvimon_python_sdk/models/invoice_extra_open_period.py +91 -0
  448. solvimon_python_sdk/models/invoice_grace_period.py +95 -0
  449. solvimon_python_sdk/models/invoice_grace_period_configuration.py +91 -0
  450. solvimon_python_sdk/models/invoice_group.py +187 -0
  451. solvimon_python_sdk/models/invoice_line.py +207 -0
  452. solvimon_python_sdk/models/invoice_line_coupon_data.py +91 -0
  453. solvimon_python_sdk/models/invoice_line_meter_value.py +99 -0
  454. solvimon_python_sdk/models/invoice_meter_property_variable.py +113 -0
  455. solvimon_python_sdk/models/invoice_meter_property_variable_create_request.py +113 -0
  456. solvimon_python_sdk/models/invoice_meter_property_variable_update_request.py +113 -0
  457. solvimon_python_sdk/models/invoice_overdue.py +96 -0
  458. solvimon_python_sdk/models/invoice_payment_action.py +117 -0
  459. solvimon_python_sdk/models/invoice_payment_action_bank_account_details.py +123 -0
  460. solvimon_python_sdk/models/invoice_payment_action_create_request.py +117 -0
  461. solvimon_python_sdk/models/invoice_payment_action_custom_redirect_details.py +89 -0
  462. solvimon_python_sdk/models/invoice_payment_action_payment_gateway_details.py +103 -0
  463. solvimon_python_sdk/models/invoice_payment_action_update_request.py +117 -0
  464. solvimon_python_sdk/models/invoice_period.py +128 -0
  465. solvimon_python_sdk/models/invoice_period_create_request.py +128 -0
  466. solvimon_python_sdk/models/invoice_period_update_request.py +128 -0
  467. solvimon_python_sdk/models/invoice_portal_url.py +95 -0
  468. solvimon_python_sdk/models/invoice_portal_url_create_request.py +95 -0
  469. solvimon_python_sdk/models/invoice_portal_url_update_request.py +95 -0
  470. solvimon_python_sdk/models/invoice_preview_action.py +120 -0
  471. solvimon_python_sdk/models/invoice_preview_action_create_request.py +120 -0
  472. solvimon_python_sdk/models/invoice_preview_action_response.py +107 -0
  473. solvimon_python_sdk/models/invoice_preview_invoices_info.py +98 -0
  474. solvimon_python_sdk/models/invoice_pricing.py +91 -0
  475. solvimon_python_sdk/models/invoice_promotion_code.py +99 -0
  476. solvimon_python_sdk/models/invoice_promotion_code_create_request.py +99 -0
  477. solvimon_python_sdk/models/invoice_promotion_code_update_request.py +99 -0
  478. solvimon_python_sdk/models/invoice_reprocess.py +95 -0
  479. solvimon_python_sdk/models/invoice_reprocess_create_request.py +95 -0
  480. solvimon_python_sdk/models/invoice_reprocess_update_request.py +95 -0
  481. solvimon_python_sdk/models/invoice_response_wrapper.py +108 -0
  482. solvimon_python_sdk/models/invoice_settings.py +151 -0
  483. solvimon_python_sdk/models/invoice_settings_update_request.py +151 -0
  484. solvimon_python_sdk/models/invoice_sub_line.py +119 -0
  485. solvimon_python_sdk/models/invoice_sub_line_usage_based_conversion.py +93 -0
  486. solvimon_python_sdk/models/invoice_tax_amounts.py +111 -0
  487. solvimon_python_sdk/models/invoice_tax_category_summary.py +126 -0
  488. solvimon_python_sdk/models/invoice_tax_category_summary_create_request.py +126 -0
  489. solvimon_python_sdk/models/invoice_tax_category_summary_rate.py +97 -0
  490. solvimon_python_sdk/models/invoice_tax_category_summary_update_request.py +126 -0
  491. solvimon_python_sdk/models/invoice_tax_total_summary.py +113 -0
  492. solvimon_python_sdk/models/invoice_tax_total_summary_create_request.py +113 -0
  493. solvimon_python_sdk/models/invoice_tax_total_summary_update_request.py +113 -0
  494. solvimon_python_sdk/models/invoice_trigger.py +103 -0
  495. solvimon_python_sdk/models/invoice_trigger_create_request.py +103 -0
  496. solvimon_python_sdk/models/invoice_trigger_event.py +107 -0
  497. solvimon_python_sdk/models/invoice_trigger_manual.py +109 -0
  498. solvimon_python_sdk/models/invoice_trigger_overdue.py +93 -0
  499. solvimon_python_sdk/models/invoice_upcoming_payment.py +96 -0
  500. solvimon_python_sdk/models/invoice_update_request.py +566 -0
  501. solvimon_python_sdk/models/invoice_validation_result.py +91 -0
  502. solvimon_python_sdk/models/invoice_validation_result_create_request.py +91 -0
  503. solvimon_python_sdk/models/invoice_validation_result_update_request.py +91 -0
  504. solvimon_python_sdk/models/invoice_workflow.py +111 -0
  505. solvimon_python_sdk/models/invoice_workflow_create_request.py +111 -0
  506. solvimon_python_sdk/models/invoice_workflow_update_request.py +111 -0
  507. solvimon_python_sdk/models/jwt_token.py +116 -0
  508. solvimon_python_sdk/models/legal_entity_manager_details.py +93 -0
  509. solvimon_python_sdk/models/link_detail.py +91 -0
  510. solvimon_python_sdk/models/linked_integration.py +98 -0
  511. solvimon_python_sdk/models/linked_integration_create_request.py +98 -0
  512. solvimon_python_sdk/models/linked_integration_update_request.py +98 -0
  513. solvimon_python_sdk/models/linked_invoice_detail.py +103 -0
  514. solvimon_python_sdk/models/linked_invoice_detail_create_request.py +103 -0
  515. solvimon_python_sdk/models/linked_invoice_detail_update_request.py +103 -0
  516. solvimon_python_sdk/models/mailgun_email_provider.py +114 -0
  517. solvimon_python_sdk/models/markup.py +96 -0
  518. solvimon_python_sdk/models/markup_update_request.py +96 -0
  519. solvimon_python_sdk/models/meter.py +162 -0
  520. solvimon_python_sdk/models/meter_condition_expression.py +108 -0
  521. solvimon_python_sdk/models/meter_condition_operand.py +95 -0
  522. solvimon_python_sdk/models/meter_conditions.py +104 -0
  523. solvimon_python_sdk/models/meter_create_request.py +159 -0
  524. solvimon_python_sdk/models/meter_data.py +193 -0
  525. solvimon_python_sdk/models/meter_data_create_request.py +190 -0
  526. solvimon_python_sdk/models/meter_data_file_processing_settings.py +104 -0
  527. solvimon_python_sdk/models/meter_data_file_processing_settings_create_request.py +104 -0
  528. solvimon_python_sdk/models/meter_data_file_processing_settings_update_request.py +104 -0
  529. solvimon_python_sdk/models/meter_data_mapping_settings.py +119 -0
  530. solvimon_python_sdk/models/meter_data_meter_property.py +99 -0
  531. solvimon_python_sdk/models/meter_data_meter_property_create_request.py +99 -0
  532. solvimon_python_sdk/models/meter_data_meter_value.py +107 -0
  533. solvimon_python_sdk/models/meter_data_meter_value_create_request.py +107 -0
  534. solvimon_python_sdk/models/meter_data_processed_details.py +121 -0
  535. solvimon_python_sdk/models/meter_data_processed_details_create_request.py +121 -0
  536. solvimon_python_sdk/models/meter_datas.py +97 -0
  537. solvimon_python_sdk/models/meter_datas_create_request.py +97 -0
  538. solvimon_python_sdk/models/meter_meter_property.py +112 -0
  539. solvimon_python_sdk/models/meter_meter_property_create_request.py +112 -0
  540. solvimon_python_sdk/models/meter_meter_property_update_request.py +112 -0
  541. solvimon_python_sdk/models/meter_meter_value.py +112 -0
  542. solvimon_python_sdk/models/meter_meter_value_create_request.py +112 -0
  543. solvimon_python_sdk/models/meter_meter_value_update_request.py +112 -0
  544. solvimon_python_sdk/models/meter_property.py +158 -0
  545. solvimon_python_sdk/models/meter_property_condition.py +125 -0
  546. solvimon_python_sdk/models/meter_property_create_request.py +149 -0
  547. solvimon_python_sdk/models/meter_property_dynamic_validation_settings.py +101 -0
  548. solvimon_python_sdk/models/meter_property_mapping.py +99 -0
  549. solvimon_python_sdk/models/meter_property_response_wrapper.py +96 -0
  550. solvimon_python_sdk/models/meter_property_split_pricing.py +101 -0
  551. solvimon_python_sdk/models/meter_property_update_request.py +158 -0
  552. solvimon_python_sdk/models/meter_property_variable.py +174 -0
  553. solvimon_python_sdk/models/meter_property_variable_create_request.py +168 -0
  554. solvimon_python_sdk/models/meter_property_variable_response_wrapper.py +108 -0
  555. solvimon_python_sdk/models/meter_property_variable_update_request.py +174 -0
  556. solvimon_python_sdk/models/meter_property_variable_value.py +95 -0
  557. solvimon_python_sdk/models/meter_property_variable_value_response_wrapper.py +108 -0
  558. solvimon_python_sdk/models/meter_property_variable_values_update.py +91 -0
  559. solvimon_python_sdk/models/meter_property_variable_values_update_result.py +103 -0
  560. solvimon_python_sdk/models/meter_property_variable_values_update_update_request.py +91 -0
  561. solvimon_python_sdk/models/meter_response_wrapper.py +96 -0
  562. solvimon_python_sdk/models/meter_update_request.py +162 -0
  563. solvimon_python_sdk/models/meter_value.py +156 -0
  564. solvimon_python_sdk/models/meter_value_calculation.py +176 -0
  565. solvimon_python_sdk/models/meter_value_calculation_commitment.py +95 -0
  566. solvimon_python_sdk/models/meter_value_calculation_create_request.py +170 -0
  567. solvimon_python_sdk/models/meter_value_calculation_response_wrapper.py +96 -0
  568. solvimon_python_sdk/models/meter_value_calculation_update_request.py +176 -0
  569. solvimon_python_sdk/models/meter_value_create_request.py +147 -0
  570. solvimon_python_sdk/models/meter_value_create_request_transaction.py +156 -0
  571. solvimon_python_sdk/models/meter_value_dynamic_validation_settings.py +101 -0
  572. solvimon_python_sdk/models/meter_value_mapping.py +103 -0
  573. solvimon_python_sdk/models/meter_value_mapping_amount_default_value.py +98 -0
  574. solvimon_python_sdk/models/meter_value_mapping_column.py +95 -0
  575. solvimon_python_sdk/models/meter_value_mapping_column_amount.py +91 -0
  576. solvimon_python_sdk/models/meter_value_mapping_default_value.py +99 -0
  577. solvimon_python_sdk/models/meter_value_response_wrapper.py +96 -0
  578. solvimon_python_sdk/models/meter_value_update_request.py +156 -0
  579. solvimon_python_sdk/models/mx_local.py +124 -0
  580. solvimon_python_sdk/models/name.py +93 -0
  581. solvimon_python_sdk/models/name_create_request.py +93 -0
  582. solvimon_python_sdk/models/name_update_request.py +93 -0
  583. solvimon_python_sdk/models/next_action.py +95 -0
  584. solvimon_python_sdk/models/next_action_redirect_to_url.py +91 -0
  585. solvimon_python_sdk/models/next_invoice.py +96 -0
  586. solvimon_python_sdk/models/next_invoice_update_request.py +96 -0
  587. solvimon_python_sdk/models/not_matched.py +91 -0
  588. solvimon_python_sdk/models/notification_channel.py +101 -0
  589. solvimon_python_sdk/models/notification_preference.py +108 -0
  590. solvimon_python_sdk/models/notification_preference_create_request.py +108 -0
  591. solvimon_python_sdk/models/notification_preference_update_request.py +108 -0
  592. solvimon_python_sdk/models/o_auth_callback.py +124 -0
  593. solvimon_python_sdk/models/o_auth_callback_create_request.py +115 -0
  594. solvimon_python_sdk/models/o_auth_credential_request.py +93 -0
  595. solvimon_python_sdk/models/o_auth_credential_request_create_request.py +93 -0
  596. solvimon_python_sdk/models/on_demand_pricing_items_response.py +110 -0
  597. solvimon_python_sdk/models/one_off_invoice_line.py +149 -0
  598. solvimon_python_sdk/models/one_off_invoice_line_create_request.py +146 -0
  599. solvimon_python_sdk/models/organization.py +132 -0
  600. solvimon_python_sdk/models/organization_create_request.py +132 -0
  601. solvimon_python_sdk/models/organization_update_request.py +132 -0
  602. solvimon_python_sdk/models/original_invoice_info.py +91 -0
  603. solvimon_python_sdk/models/other_custom_field_value.py +103 -0
  604. solvimon_python_sdk/models/other_custom_field_value_create_request.py +103 -0
  605. solvimon_python_sdk/models/other_custom_field_value_update_request.py +103 -0
  606. solvimon_python_sdk/models/pagination_links.py +95 -0
  607. solvimon_python_sdk/models/paragon_settings.py +89 -0
  608. solvimon_python_sdk/models/paragon_settings_create_request.py +89 -0
  609. solvimon_python_sdk/models/paragon_settings_update_request.py +89 -0
  610. solvimon_python_sdk/models/password_reset_request.py +89 -0
  611. solvimon_python_sdk/models/password_reset_request_create_request.py +89 -0
  612. solvimon_python_sdk/models/patch_e_invoice.py +93 -0
  613. solvimon_python_sdk/models/patch_e_invoice_update_request.py +93 -0
  614. solvimon_python_sdk/models/pay_invoice_payment_context.py +89 -0
  615. solvimon_python_sdk/models/payment.py +172 -0
  616. solvimon_python_sdk/models/payment_acceptor.py +178 -0
  617. solvimon_python_sdk/models/payment_acceptor_create_request.py +172 -0
  618. solvimon_python_sdk/models/payment_acceptor_custom_redirect.py +100 -0
  619. solvimon_python_sdk/models/payment_acceptor_custom_redirect_create_request.py +100 -0
  620. solvimon_python_sdk/models/payment_acceptor_payment_method_options.py +108 -0
  621. solvimon_python_sdk/models/payment_acceptor_payment_method_options_request.py +123 -0
  622. solvimon_python_sdk/models/payment_acceptor_payment_method_options_request_create_request.py +123 -0
  623. solvimon_python_sdk/models/payment_acceptor_response_wrapper.py +96 -0
  624. solvimon_python_sdk/models/payment_acceptor_update_request.py +178 -0
  625. solvimon_python_sdk/models/payment_context.py +152 -0
  626. solvimon_python_sdk/models/payment_context_create_request.py +152 -0
  627. solvimon_python_sdk/models/payment_create_request.py +172 -0
  628. solvimon_python_sdk/models/payment_create_request_transaction.py +169 -0
  629. solvimon_python_sdk/models/payment_dunning_action_details.py +93 -0
  630. solvimon_python_sdk/models/payment_dunning_action_details_create_request.py +93 -0
  631. solvimon_python_sdk/models/payment_gateway_integration.py +111 -0
  632. solvimon_python_sdk/models/payment_gateway_integration_create_request.py +111 -0
  633. solvimon_python_sdk/models/payment_gateway_integration_update_request.py +111 -0
  634. solvimon_python_sdk/models/payment_gateway_payment_acceptor.py +125 -0
  635. solvimon_python_sdk/models/payment_gateway_payment_acceptor_adyen.py +97 -0
  636. solvimon_python_sdk/models/payment_gateway_payment_acceptor_create_request.py +125 -0
  637. solvimon_python_sdk/models/payment_gateway_payment_acceptor_link.py +93 -0
  638. solvimon_python_sdk/models/payment_method.py +192 -0
  639. solvimon_python_sdk/models/payment_method_action_refresh.py +95 -0
  640. solvimon_python_sdk/models/payment_method_action_refresh_create_request.py +95 -0
  641. solvimon_python_sdk/models/payment_method_buy_now_pay_later.py +89 -0
  642. solvimon_python_sdk/models/payment_method_buy_now_pay_later_update_request.py +89 -0
  643. solvimon_python_sdk/models/payment_method_card.py +111 -0
  644. solvimon_python_sdk/models/payment_method_card_update_request.py +111 -0
  645. solvimon_python_sdk/models/payment_method_create_request.py +192 -0
  646. solvimon_python_sdk/models/payment_method_details.py +135 -0
  647. solvimon_python_sdk/models/payment_method_details_buy_now_pay_later.py +89 -0
  648. solvimon_python_sdk/models/payment_method_details_card.py +101 -0
  649. solvimon_python_sdk/models/payment_method_details_create_request.py +135 -0
  650. solvimon_python_sdk/models/payment_method_details_digital_wallet.py +89 -0
  651. solvimon_python_sdk/models/payment_method_details_direct_debit.py +107 -0
  652. solvimon_python_sdk/models/payment_method_details_online_banking.py +107 -0
  653. solvimon_python_sdk/models/payment_method_details_unknown.py +89 -0
  654. solvimon_python_sdk/models/payment_method_digital_wallet.py +89 -0
  655. solvimon_python_sdk/models/payment_method_digital_wallet_update_request.py +89 -0
  656. solvimon_python_sdk/models/payment_method_direct_debit.py +107 -0
  657. solvimon_python_sdk/models/payment_method_direct_debit_update_request.py +107 -0
  658. solvimon_python_sdk/models/payment_method_fallback.py +91 -0
  659. solvimon_python_sdk/models/payment_method_fallback_create_request.py +91 -0
  660. solvimon_python_sdk/models/payment_method_fallback_update_request.py +91 -0
  661. solvimon_python_sdk/models/payment_method_online_banking.py +107 -0
  662. solvimon_python_sdk/models/payment_method_online_banking_update_request.py +107 -0
  663. solvimon_python_sdk/models/payment_method_option.py +105 -0
  664. solvimon_python_sdk/models/payment_method_payment_response.py +117 -0
  665. solvimon_python_sdk/models/payment_method_response_wrapper.py +108 -0
  666. solvimon_python_sdk/models/payment_method_tokenization_request.py +137 -0
  667. solvimon_python_sdk/models/payment_method_tokenization_request_create_request.py +134 -0
  668. solvimon_python_sdk/models/payment_method_update_request.py +192 -0
  669. solvimon_python_sdk/models/payment_method_update_request_transaction.py +192 -0
  670. solvimon_python_sdk/models/payment_modification_response.py +105 -0
  671. solvimon_python_sdk/models/payment_request.py +145 -0
  672. solvimon_python_sdk/models/payment_request_create_request.py +145 -0
  673. solvimon_python_sdk/models/payment_request_payment_context.py +89 -0
  674. solvimon_python_sdk/models/payment_request_response_wrapper.py +108 -0
  675. solvimon_python_sdk/models/payment_response_wrapper.py +108 -0
  676. solvimon_python_sdk/models/payment_result_details.py +95 -0
  677. solvimon_python_sdk/models/payment_result_details_create_request.py +95 -0
  678. solvimon_python_sdk/models/payment_schedule.py +204 -0
  679. solvimon_python_sdk/models/payment_schedule_create_request.py +198 -0
  680. solvimon_python_sdk/models/payment_schedule_dunning.py +89 -0
  681. solvimon_python_sdk/models/payment_schedule_dunning_create_request.py +89 -0
  682. solvimon_python_sdk/models/payment_schedule_dunning_update_request.py +89 -0
  683. solvimon_python_sdk/models/payment_schedule_init.py +116 -0
  684. solvimon_python_sdk/models/payment_schedule_init_create_request.py +116 -0
  685. solvimon_python_sdk/models/payment_schedule_installments.py +120 -0
  686. solvimon_python_sdk/models/payment_schedule_installments_create_request.py +120 -0
  687. solvimon_python_sdk/models/payment_schedule_installments_update_request.py +120 -0
  688. solvimon_python_sdk/models/payment_schedule_one_off.py +93 -0
  689. solvimon_python_sdk/models/payment_schedule_one_off_create_request.py +93 -0
  690. solvimon_python_sdk/models/payment_schedule_one_off_update_request.py +93 -0
  691. solvimon_python_sdk/models/payment_schedule_recurring.py +104 -0
  692. solvimon_python_sdk/models/payment_schedule_recurring_create_request.py +104 -0
  693. solvimon_python_sdk/models/payment_schedule_recurring_update_request.py +104 -0
  694. solvimon_python_sdk/models/payment_schedule_response_wrapper.py +108 -0
  695. solvimon_python_sdk/models/payment_schedule_update_request.py +204 -0
  696. solvimon_python_sdk/models/payment_trigger.py +111 -0
  697. solvimon_python_sdk/models/payment_trigger_create_request.py +111 -0
  698. solvimon_python_sdk/models/payment_trigger_event.py +99 -0
  699. solvimon_python_sdk/models/payment_trigger_manual.py +103 -0
  700. solvimon_python_sdk/models/payment_verify_detail.py +97 -0
  701. solvimon_python_sdk/models/payment_verify_detail_create_request.py +97 -0
  702. solvimon_python_sdk/models/payment_verify_detail_response.py +89 -0
  703. solvimon_python_sdk/models/payment_workflow.py +99 -0
  704. solvimon_python_sdk/models/payment_workflow_create_request.py +99 -0
  705. solvimon_python_sdk/models/payment_workflow_update_request.py +99 -0
  706. solvimon_python_sdk/models/penalty_box_data.py +95 -0
  707. solvimon_python_sdk/models/penalty_box_data_create_request.py +95 -0
  708. solvimon_python_sdk/models/penalty_box_data_update_request.py +95 -0
  709. solvimon_python_sdk/models/period.py +101 -0
  710. solvimon_python_sdk/models/period_create_request.py +101 -0
  711. solvimon_python_sdk/models/period_update_request.py +101 -0
  712. solvimon_python_sdk/models/persist_data.py +157 -0
  713. solvimon_python_sdk/models/persist_data_create_request.py +157 -0
  714. solvimon_python_sdk/models/platform.py +227 -0
  715. solvimon_python_sdk/models/platform_pricing_plan_subscription_settings.py +149 -0
  716. solvimon_python_sdk/models/platform_pricing_plan_subscription_settings_update_request.py +149 -0
  717. solvimon_python_sdk/models/platform_up_to_date.py +111 -0
  718. solvimon_python_sdk/models/platform_up_to_date_reprocess.py +99 -0
  719. solvimon_python_sdk/models/platform_update_request.py +227 -0
  720. solvimon_python_sdk/models/portal_url.py +183 -0
  721. solvimon_python_sdk/models/portal_url_create_request.py +180 -0
  722. solvimon_python_sdk/models/portal_url_link.py +101 -0
  723. solvimon_python_sdk/models/portal_url_link_create_request.py +101 -0
  724. solvimon_python_sdk/models/portal_url_link_update_request.py +101 -0
  725. solvimon_python_sdk/models/portal_url_response_wrapper.py +108 -0
  726. solvimon_python_sdk/models/portal_url_settings.py +93 -0
  727. solvimon_python_sdk/models/portal_url_update_request.py +183 -0
  728. solvimon_python_sdk/models/portal_url_widgets.py +93 -0
  729. solvimon_python_sdk/models/portal_url_widgets_create_request.py +93 -0
  730. solvimon_python_sdk/models/portal_url_widgets_update_request.py +93 -0
  731. solvimon_python_sdk/models/pricing.py +167 -0
  732. solvimon_python_sdk/models/pricing_category.py +126 -0
  733. solvimon_python_sdk/models/pricing_category_create_request.py +126 -0
  734. solvimon_python_sdk/models/pricing_category_update_request.py +126 -0
  735. solvimon_python_sdk/models/pricing_commitment.py +100 -0
  736. solvimon_python_sdk/models/pricing_create_request.py +167 -0
  737. solvimon_python_sdk/models/pricing_currency_settings.py +91 -0
  738. solvimon_python_sdk/models/pricing_currency_settings_create_request.py +91 -0
  739. solvimon_python_sdk/models/pricing_currency_settings_update_request.py +91 -0
  740. solvimon_python_sdk/models/pricing_discount.py +108 -0
  741. solvimon_python_sdk/models/pricing_group.py +137 -0
  742. solvimon_python_sdk/models/pricing_group_create_request.py +137 -0
  743. solvimon_python_sdk/models/pricing_group_update_request.py +137 -0
  744. solvimon_python_sdk/models/pricing_item.py +156 -0
  745. solvimon_python_sdk/models/pricing_item_billing_period_config.py +102 -0
  746. solvimon_python_sdk/models/pricing_item_commitment.py +100 -0
  747. solvimon_python_sdk/models/pricing_item_config.py +209 -0
  748. solvimon_python_sdk/models/pricing_item_config_band.py +131 -0
  749. solvimon_python_sdk/models/pricing_item_config_band_create_request.py +131 -0
  750. solvimon_python_sdk/models/pricing_item_config_commitment.py +107 -0
  751. solvimon_python_sdk/models/pricing_item_config_conditions.py +100 -0
  752. solvimon_python_sdk/models/pricing_item_config_details.py +119 -0
  753. solvimon_python_sdk/models/pricing_item_config_discount.py +108 -0
  754. solvimon_python_sdk/models/pricing_item_config_markup.py +102 -0
  755. solvimon_python_sdk/models/pricing_item_config_meter_value.py +97 -0
  756. solvimon_python_sdk/models/pricing_item_config_meter_value_included_volume.py +99 -0
  757. solvimon_python_sdk/models/pricing_item_config_split_pricing.py +96 -0
  758. solvimon_python_sdk/models/pricing_item_config_top_up.py +89 -0
  759. solvimon_python_sdk/models/pricing_item_config_wallet_grant.py +127 -0
  760. solvimon_python_sdk/models/pricing_item_config_wallet_grant_amount_grant.py +95 -0
  761. solvimon_python_sdk/models/pricing_item_config_wallet_grant_credits_grant.py +99 -0
  762. solvimon_python_sdk/models/pricing_item_config_wallet_grant_credits_grant_conversion.py +91 -0
  763. solvimon_python_sdk/models/pricing_item_config_wallet_grant_expiry_policy.py +93 -0
  764. solvimon_python_sdk/models/pricing_item_create_request.py +156 -0
  765. solvimon_python_sdk/models/pricing_item_discount.py +108 -0
  766. solvimon_python_sdk/models/pricing_item_pricing_currency_config.py +129 -0
  767. solvimon_python_sdk/models/pricing_item_summary_included_volume_details.py +103 -0
  768. solvimon_python_sdk/models/pricing_item_summary_meter_value.py +115 -0
  769. solvimon_python_sdk/models/pricing_item_summary_price_details.py +204 -0
  770. solvimon_python_sdk/models/pricing_item_summary_price_details_band.py +138 -0
  771. solvimon_python_sdk/models/pricing_item_summary_price_details_conversion.py +95 -0
  772. solvimon_python_sdk/models/pricing_item_summary_wallet_balance.py +113 -0
  773. solvimon_python_sdk/models/pricing_item_summary_wallet_balance_details.py +103 -0
  774. solvimon_python_sdk/models/pricing_item_update_request.py +156 -0
  775. solvimon_python_sdk/models/pricing_plan.py +220 -0
  776. solvimon_python_sdk/models/pricing_plan_create_request.py +217 -0
  777. solvimon_python_sdk/models/pricing_plan_group.py +175 -0
  778. solvimon_python_sdk/models/pricing_plan_group_create_request.py +163 -0
  779. solvimon_python_sdk/models/pricing_plan_group_member.py +91 -0
  780. solvimon_python_sdk/models/pricing_plan_group_member_create_request.py +91 -0
  781. solvimon_python_sdk/models/pricing_plan_group_member_update_request.py +91 -0
  782. solvimon_python_sdk/models/pricing_plan_group_response_wrapper.py +108 -0
  783. solvimon_python_sdk/models/pricing_plan_group_update_request.py +175 -0
  784. solvimon_python_sdk/models/pricing_plan_response_wrapper.py +108 -0
  785. solvimon_python_sdk/models/pricing_plan_schedule.py +290 -0
  786. solvimon_python_sdk/models/pricing_plan_schedule_copy.py +149 -0
  787. solvimon_python_sdk/models/pricing_plan_schedule_copy_create_request.py +149 -0
  788. solvimon_python_sdk/models/pricing_plan_schedule_create_request.py +290 -0
  789. solvimon_python_sdk/models/pricing_plan_schedule_customization.py +135 -0
  790. solvimon_python_sdk/models/pricing_plan_schedule_customization_create_request.py +135 -0
  791. solvimon_python_sdk/models/pricing_plan_schedule_info.py +139 -0
  792. solvimon_python_sdk/models/pricing_plan_schedule_info_update_request.py +139 -0
  793. solvimon_python_sdk/models/pricing_plan_schedule_migrate.py +126 -0
  794. solvimon_python_sdk/models/pricing_plan_schedule_migrate_create_request.py +126 -0
  795. solvimon_python_sdk/models/pricing_plan_schedule_response_wrapper.py +96 -0
  796. solvimon_python_sdk/models/pricing_plan_schedule_template.py +89 -0
  797. solvimon_python_sdk/models/pricing_plan_schedule_template_create_request.py +89 -0
  798. solvimon_python_sdk/models/pricing_plan_schedule_template_update_request.py +89 -0
  799. solvimon_python_sdk/models/pricing_plan_schedule_update_request.py +290 -0
  800. solvimon_python_sdk/models/pricing_plan_subscription.py +396 -0
  801. solvimon_python_sdk/models/pricing_plan_subscription_cancel.py +117 -0
  802. solvimon_python_sdk/models/pricing_plan_subscription_cancel_create_request.py +114 -0
  803. solvimon_python_sdk/models/pricing_plan_subscription_change_plan.py +98 -0
  804. solvimon_python_sdk/models/pricing_plan_subscription_change_plan_create_request.py +98 -0
  805. solvimon_python_sdk/models/pricing_plan_subscription_copy.py +100 -0
  806. solvimon_python_sdk/models/pricing_plan_subscription_copy_create_request.py +100 -0
  807. solvimon_python_sdk/models/pricing_plan_subscription_create_request.py +396 -0
  808. solvimon_python_sdk/models/pricing_plan_subscription_group.py +126 -0
  809. solvimon_python_sdk/models/pricing_plan_subscription_group_create_request.py +123 -0
  810. solvimon_python_sdk/models/pricing_plan_subscription_group_response_wrapper.py +108 -0
  811. solvimon_python_sdk/models/pricing_plan_subscription_group_update_request.py +126 -0
  812. solvimon_python_sdk/models/pricing_plan_subscription_info.py +95 -0
  813. solvimon_python_sdk/models/pricing_plan_subscription_info_create_request.py +95 -0
  814. solvimon_python_sdk/models/pricing_plan_subscription_info_update_request.py +95 -0
  815. solvimon_python_sdk/models/pricing_plan_subscription_init.py +148 -0
  816. solvimon_python_sdk/models/pricing_plan_subscription_init_create_request.py +148 -0
  817. solvimon_python_sdk/models/pricing_plan_subscription_payment_method_update.py +91 -0
  818. solvimon_python_sdk/models/pricing_plan_subscription_payment_method_update_create_request.py +91 -0
  819. solvimon_python_sdk/models/pricing_plan_subscription_response_wrapper.py +108 -0
  820. solvimon_python_sdk/models/pricing_plan_subscription_selector.py +126 -0
  821. solvimon_python_sdk/models/pricing_plan_subscription_selector_create_request.py +126 -0
  822. solvimon_python_sdk/models/pricing_plan_subscription_selector_data.py +101 -0
  823. solvimon_python_sdk/models/pricing_plan_subscription_selector_filter.py +113 -0
  824. solvimon_python_sdk/models/pricing_plan_subscription_selector_rule.py +111 -0
  825. solvimon_python_sdk/models/pricing_plan_subscription_selector_update_request.py +126 -0
  826. solvimon_python_sdk/models/pricing_plan_subscription_template.py +112 -0
  827. solvimon_python_sdk/models/pricing_plan_subscription_template_create_request.py +112 -0
  828. solvimon_python_sdk/models/pricing_plan_subscription_template_update_request.py +112 -0
  829. solvimon_python_sdk/models/pricing_plan_subscription_trigger.py +124 -0
  830. solvimon_python_sdk/models/pricing_plan_subscription_trigger_create_request.py +124 -0
  831. solvimon_python_sdk/models/pricing_plan_subscription_trigger_event.py +99 -0
  832. solvimon_python_sdk/models/pricing_plan_subscription_trigger_manual.py +103 -0
  833. solvimon_python_sdk/models/pricing_plan_subscription_update_request.py +396 -0
  834. solvimon_python_sdk/models/pricing_plan_subscription_workflow.py +108 -0
  835. solvimon_python_sdk/models/pricing_plan_subscription_workflow_create_request.py +108 -0
  836. solvimon_python_sdk/models/pricing_plan_subscription_workflow_update_request.py +108 -0
  837. solvimon_python_sdk/models/pricing_plan_update_request.py +220 -0
  838. solvimon_python_sdk/models/pricing_plan_version.py +159 -0
  839. solvimon_python_sdk/models/pricing_plan_version_create_request.py +159 -0
  840. solvimon_python_sdk/models/pricing_plan_version_info.py +99 -0
  841. solvimon_python_sdk/models/pricing_plan_version_info_create_request.py +99 -0
  842. solvimon_python_sdk/models/pricing_plan_version_info_update_request.py +99 -0
  843. solvimon_python_sdk/models/pricing_plan_version_selector.py +105 -0
  844. solvimon_python_sdk/models/pricing_plan_version_selector_create_request.py +105 -0
  845. solvimon_python_sdk/models/pricing_plan_version_selector_update_request.py +105 -0
  846. solvimon_python_sdk/models/pricing_plan_version_update_request.py +159 -0
  847. solvimon_python_sdk/models/pricing_update_request.py +167 -0
  848. solvimon_python_sdk/models/processing_settings.py +89 -0
  849. solvimon_python_sdk/models/processing_settings_update_request.py +89 -0
  850. solvimon_python_sdk/models/product.py +221 -0
  851. solvimon_python_sdk/models/product_category.py +148 -0
  852. solvimon_python_sdk/models/product_category_create_request.py +142 -0
  853. solvimon_python_sdk/models/product_category_discount.py +119 -0
  854. solvimon_python_sdk/models/product_category_response_wrapper.py +108 -0
  855. solvimon_python_sdk/models/product_category_update_request.py +148 -0
  856. solvimon_python_sdk/models/product_create_request.py +221 -0
  857. solvimon_python_sdk/models/product_discount.py +119 -0
  858. solvimon_python_sdk/models/product_item.py +243 -0
  859. solvimon_python_sdk/models/product_item_create_request.py +234 -0
  860. solvimon_python_sdk/models/product_item_credits.py +97 -0
  861. solvimon_python_sdk/models/product_item_credits_create_request.py +97 -0
  862. solvimon_python_sdk/models/product_item_credits_update_request.py +97 -0
  863. solvimon_python_sdk/models/product_item_discount.py +119 -0
  864. solvimon_python_sdk/models/product_item_meter_property_condition_discount.py +126 -0
  865. solvimon_python_sdk/models/product_item_response_wrapper.py +108 -0
  866. solvimon_python_sdk/models/product_item_update_request.py +243 -0
  867. solvimon_python_sdk/models/product_item_usage_based.py +114 -0
  868. solvimon_python_sdk/models/product_item_usage_based_create_request.py +114 -0
  869. solvimon_python_sdk/models/product_item_usage_based_update_request.py +114 -0
  870. solvimon_python_sdk/models/product_response_wrapper.py +108 -0
  871. solvimon_python_sdk/models/product_update_request.py +221 -0
  872. solvimon_python_sdk/models/promotion_code.py +137 -0
  873. solvimon_python_sdk/models/promotion_code_create_request.py +137 -0
  874. solvimon_python_sdk/models/promotion_code_details.py +95 -0
  875. solvimon_python_sdk/models/promotion_code_limited_to.py +100 -0
  876. solvimon_python_sdk/models/promotion_code_limited_to_create_request.py +100 -0
  877. solvimon_python_sdk/models/promotion_code_response_wrapper.py +108 -0
  878. solvimon_python_sdk/models/quote.py +166 -0
  879. solvimon_python_sdk/models/quote_create_request.py +166 -0
  880. solvimon_python_sdk/models/quote_init_action.py +113 -0
  881. solvimon_python_sdk/models/quote_init_action_create_request.py +113 -0
  882. solvimon_python_sdk/models/quote_init_action_pricing_plan_subscription.py +138 -0
  883. solvimon_python_sdk/models/quote_init_action_pricing_plan_subscription_create_request.py +138 -0
  884. solvimon_python_sdk/models/quote_init_action_quote.py +117 -0
  885. solvimon_python_sdk/models/quote_init_action_quote_create_request.py +117 -0
  886. solvimon_python_sdk/models/quote_init_action_quote_pricing_plan_schedule.py +125 -0
  887. solvimon_python_sdk/models/quote_init_action_quote_pricing_plan_schedule_create_request.py +125 -0
  888. solvimon_python_sdk/models/quote_init_action_quote_version.py +91 -0
  889. solvimon_python_sdk/models/quote_init_action_quote_version_create_request.py +91 -0
  890. solvimon_python_sdk/models/quote_pdf_configuration.py +91 -0
  891. solvimon_python_sdk/models/quote_settings.py +93 -0
  892. solvimon_python_sdk/models/quote_settings_update_request.py +93 -0
  893. solvimon_python_sdk/models/quote_template.py +176 -0
  894. solvimon_python_sdk/models/quote_template_create_request.py +170 -0
  895. solvimon_python_sdk/models/quote_template_response_wrapper.py +108 -0
  896. solvimon_python_sdk/models/quote_template_update_request.py +176 -0
  897. solvimon_python_sdk/models/quote_update_request.py +166 -0
  898. solvimon_python_sdk/models/quote_upgrade_action_request.py +105 -0
  899. solvimon_python_sdk/models/quote_upgrade_action_request_create_request.py +105 -0
  900. solvimon_python_sdk/models/quote_upgrade_action_request_pricing_plan_schedule.py +94 -0
  901. solvimon_python_sdk/models/quote_upgrade_action_request_pricing_plan_schedule_create_request.py +94 -0
  902. solvimon_python_sdk/models/quote_upgrade_action_request_pricing_plan_subscription.py +124 -0
  903. solvimon_python_sdk/models/quote_upgrade_action_request_pricing_plan_subscription_create_request.py +124 -0
  904. solvimon_python_sdk/models/quote_upgrade_action_request_quote.py +114 -0
  905. solvimon_python_sdk/models/quote_upgrade_action_request_quote_create_request.py +114 -0
  906. solvimon_python_sdk/models/quote_upgrade_action_response.py +111 -0
  907. solvimon_python_sdk/models/quote_version.py +180 -0
  908. solvimon_python_sdk/models/quote_version_action.py +147 -0
  909. solvimon_python_sdk/models/quote_version_action_accept.py +95 -0
  910. solvimon_python_sdk/models/quote_version_action_accept_create_request.py +95 -0
  911. solvimon_python_sdk/models/quote_version_action_create_request.py +147 -0
  912. solvimon_python_sdk/models/quote_version_action_create_subscription.py +91 -0
  913. solvimon_python_sdk/models/quote_version_action_create_subscription_create_request.py +91 -0
  914. solvimon_python_sdk/models/quote_version_action_reject.py +97 -0
  915. solvimon_python_sdk/models/quote_version_action_reject_create_request.py +97 -0
  916. solvimon_python_sdk/models/quote_version_action_request_signature.py +99 -0
  917. solvimon_python_sdk/models/quote_version_action_send.py +95 -0
  918. solvimon_python_sdk/models/quote_version_action_send_create_request.py +95 -0
  919. solvimon_python_sdk/models/quote_version_action_sign.py +91 -0
  920. solvimon_python_sdk/models/quote_version_action_update_request.py +147 -0
  921. solvimon_python_sdk/models/quote_version_content.py +107 -0
  922. solvimon_python_sdk/models/quote_version_content_create_request.py +107 -0
  923. solvimon_python_sdk/models/quote_version_content_update_request.py +107 -0
  924. solvimon_python_sdk/models/quote_version_create_request.py +180 -0
  925. solvimon_python_sdk/models/quote_version_default_content.py +91 -0
  926. solvimon_python_sdk/models/quote_version_info.py +103 -0
  927. solvimon_python_sdk/models/quote_version_info_create_request.py +103 -0
  928. solvimon_python_sdk/models/quote_version_info_update_request.py +103 -0
  929. solvimon_python_sdk/models/quote_version_invoices_info.py +95 -0
  930. solvimon_python_sdk/models/quote_version_invoices_info_create_request.py +95 -0
  931. solvimon_python_sdk/models/quote_version_invoices_info_update_request.py +95 -0
  932. solvimon_python_sdk/models/quote_version_portal_url.py +89 -0
  933. solvimon_python_sdk/models/quote_version_portal_url_create_request.py +89 -0
  934. solvimon_python_sdk/models/quote_version_portal_url_update_request.py +89 -0
  935. solvimon_python_sdk/models/quote_version_recipient_data.py +125 -0
  936. solvimon_python_sdk/models/quote_version_recipient_data_create_request.py +125 -0
  937. solvimon_python_sdk/models/quote_version_recipient_data_update_request.py +125 -0
  938. solvimon_python_sdk/models/quote_version_response_wrapper.py +108 -0
  939. solvimon_python_sdk/models/quote_version_template.py +95 -0
  940. solvimon_python_sdk/models/quote_version_template_create_request.py +95 -0
  941. solvimon_python_sdk/models/quote_version_template_update_request.py +95 -0
  942. solvimon_python_sdk/models/quote_version_update_request.py +180 -0
  943. solvimon_python_sdk/models/quotes_response_wrapper.py +108 -0
  944. solvimon_python_sdk/models/rate_card.py +90 -0
  945. solvimon_python_sdk/models/rate_card_create_request.py +90 -0
  946. solvimon_python_sdk/models/rate_card_update_request.py +90 -0
  947. solvimon_python_sdk/models/recipient_contact_data.py +97 -0
  948. solvimon_python_sdk/models/recipient_details_data.py +95 -0
  949. solvimon_python_sdk/models/reference_mapping_interface.py +95 -0
  950. solvimon_python_sdk/models/refresh_invoice.py +112 -0
  951. solvimon_python_sdk/models/refresh_invoice_create_request.py +112 -0
  952. solvimon_python_sdk/models/refund_payment_request.py +93 -0
  953. solvimon_python_sdk/models/refund_payment_request_create_request.py +93 -0
  954. solvimon_python_sdk/models/report.py +164 -0
  955. solvimon_python_sdk/models/report_column.py +103 -0
  956. solvimon_python_sdk/models/report_configuration.py +128 -0
  957. solvimon_python_sdk/models/report_configuration_create_request.py +125 -0
  958. solvimon_python_sdk/models/report_configuration_response_wrapper.py +108 -0
  959. solvimon_python_sdk/models/report_configuration_update_request.py +128 -0
  960. solvimon_python_sdk/models/report_definition.py +179 -0
  961. solvimon_python_sdk/models/report_definition_create_request.py +179 -0
  962. solvimon_python_sdk/models/report_definition_response_wrapper.py +108 -0
  963. solvimon_python_sdk/models/report_definition_update_request.py +179 -0
  964. solvimon_python_sdk/models/report_generate_request.py +141 -0
  965. solvimon_python_sdk/models/report_generate_request_create_request.py +141 -0
  966. solvimon_python_sdk/models/report_generate_request_response_wrapper.py +108 -0
  967. solvimon_python_sdk/models/report_ingest_data_summary.py +106 -0
  968. solvimon_python_sdk/models/report_parameter.py +113 -0
  969. solvimon_python_sdk/models/report_parameter_value.py +101 -0
  970. solvimon_python_sdk/models/report_parameter_value_create_request.py +101 -0
  971. solvimon_python_sdk/models/report_parameter_value_update_request.py +101 -0
  972. solvimon_python_sdk/models/report_response_wrapper.py +108 -0
  973. solvimon_python_sdk/models/report_subscription.py +148 -0
  974. solvimon_python_sdk/models/report_subscription_create_request.py +148 -0
  975. solvimon_python_sdk/models/report_subscription_response_wrapper.py +108 -0
  976. solvimon_python_sdk/models/report_subscription_schedule.py +104 -0
  977. solvimon_python_sdk/models/report_subscription_schedule_create_request.py +104 -0
  978. solvimon_python_sdk/models/report_subscription_schedule_update_request.py +104 -0
  979. solvimon_python_sdk/models/report_subscription_update_request.py +148 -0
  980. solvimon_python_sdk/models/reprocess.py +137 -0
  981. solvimon_python_sdk/models/reprocess_create_request.py +134 -0
  982. solvimon_python_sdk/models/reprocess_customer.py +104 -0
  983. solvimon_python_sdk/models/reprocess_customer_create_request.py +104 -0
  984. solvimon_python_sdk/models/reprocess_invoice.py +91 -0
  985. solvimon_python_sdk/models/reprocess_invoice_create_request.py +91 -0
  986. solvimon_python_sdk/models/reprocess_not_matched.py +94 -0
  987. solvimon_python_sdk/models/reprocess_not_matched_create_request.py +94 -0
  988. solvimon_python_sdk/models/reprocess_response_wrapper.py +108 -0
  989. solvimon_python_sdk/models/reprocessing_delay.py +102 -0
  990. solvimon_python_sdk/models/reprocessing_settings.py +93 -0
  991. solvimon_python_sdk/models/reprocessing_settings_update_request.py +93 -0
  992. solvimon_python_sdk/models/request_usage_reports_parameters.py +100 -0
  993. solvimon_python_sdk/models/request_usage_reports_parameters_create_request.py +100 -0
  994. solvimon_python_sdk/models/required_action.py +107 -0
  995. solvimon_python_sdk/models/reset_password.py +91 -0
  996. solvimon_python_sdk/models/reset_password_create_request.py +91 -0
  997. solvimon_python_sdk/models/resource_identifier.py +101 -0
  998. solvimon_python_sdk/models/resource_identifier_create_request.py +101 -0
  999. solvimon_python_sdk/models/resubmit_e_invoice.py +91 -0
  1000. solvimon_python_sdk/models/resubmit_e_invoice_create_request.py +91 -0
  1001. solvimon_python_sdk/models/reviewer.py +101 -0
  1002. solvimon_python_sdk/models/role.py +109 -0
  1003. solvimon_python_sdk/models/role_create_request.py +109 -0
  1004. solvimon_python_sdk/models/role_paginated_response_wrapper.py +108 -0
  1005. solvimon_python_sdk/models/role_update_request.py +109 -0
  1006. solvimon_python_sdk/models/rounding_setting.py +111 -0
  1007. solvimon_python_sdk/models/rounding_setting_update_request.py +111 -0
  1008. solvimon_python_sdk/models/s3.py +109 -0
  1009. solvimon_python_sdk/models/search.py +114 -0
  1010. solvimon_python_sdk/models/search_create_request.py +114 -0
  1011. solvimon_python_sdk/models/search_field.py +97 -0
  1012. solvimon_python_sdk/models/search_field_create_request.py +97 -0
  1013. solvimon_python_sdk/models/seat_assignment.py +128 -0
  1014. solvimon_python_sdk/models/seat_assignment_create_request.py +128 -0
  1015. solvimon_python_sdk/models/seat_assignment_response_wrapper.py +108 -0
  1016. solvimon_python_sdk/models/seat_assignment_update_request.py +128 -0
  1017. solvimon_python_sdk/models/selection_rule.py +105 -0
  1018. solvimon_python_sdk/models/selection_rule_create_request.py +105 -0
  1019. solvimon_python_sdk/models/selection_rule_field.py +91 -0
  1020. solvimon_python_sdk/models/selection_rule_field_create_request.py +91 -0
  1021. solvimon_python_sdk/models/selection_rule_resource.py +127 -0
  1022. solvimon_python_sdk/models/selection_rule_update_request.py +105 -0
  1023. solvimon_python_sdk/models/seller_details.py +89 -0
  1024. solvimon_python_sdk/models/seller_details_create_request.py +89 -0
  1025. solvimon_python_sdk/models/seller_details_update_request.py +89 -0
  1026. solvimon_python_sdk/models/send_email_invoice_configuration.py +105 -0
  1027. solvimon_python_sdk/models/send_email_payment_configuration.py +89 -0
  1028. solvimon_python_sdk/models/send_email_pricing_plan_subscription_configuration.py +89 -0
  1029. solvimon_python_sdk/models/send_email_to_customer.py +175 -0
  1030. solvimon_python_sdk/models/send_email_to_customer_update_request.py +175 -0
  1031. solvimon_python_sdk/models/send_email_wallet_configuration.py +89 -0
  1032. solvimon_python_sdk/models/send_webhook_action.py +89 -0
  1033. solvimon_python_sdk/models/send_webhook_action_update_request.py +89 -0
  1034. solvimon_python_sdk/models/signature_request.py +148 -0
  1035. solvimon_python_sdk/models/signature_request_quote_version.py +91 -0
  1036. solvimon_python_sdk/models/signature_request_recipient_action.py +101 -0
  1037. solvimon_python_sdk/models/signature_request_recipient_action_create_request.py +98 -0
  1038. solvimon_python_sdk/models/signature_request_recipient_data.py +135 -0
  1039. solvimon_python_sdk/models/snowflake.py +97 -0
  1040. solvimon_python_sdk/models/sso_authentication_provider_variant_settings.py +89 -0
  1041. solvimon_python_sdk/models/sso_variant.py +113 -0
  1042. solvimon_python_sdk/models/sso_variant_create_request.py +113 -0
  1043. solvimon_python_sdk/models/sso_variant_update_request.py +113 -0
  1044. solvimon_python_sdk/models/stripe_integration_details.py +89 -0
  1045. solvimon_python_sdk/models/stripe_payment_action.py +91 -0
  1046. solvimon_python_sdk/models/stripe_payment_gateway_integration.py +91 -0
  1047. solvimon_python_sdk/models/stripe_payment_method_option.py +89 -0
  1048. solvimon_python_sdk/models/stripe_required_action.py +95 -0
  1049. solvimon_python_sdk/models/stripe_tokenization_request.py +89 -0
  1050. solvimon_python_sdk/models/stripe_tokenization_request_create_request.py +89 -0
  1051. solvimon_python_sdk/models/system_ownership_details.py +95 -0
  1052. solvimon_python_sdk/models/tax_calculation_integration.py +118 -0
  1053. solvimon_python_sdk/models/tax_calculation_integration_create_request.py +118 -0
  1054. solvimon_python_sdk/models/tax_calculation_integration_update_request.py +118 -0
  1055. solvimon_python_sdk/models/tax_id.py +111 -0
  1056. solvimon_python_sdk/models/tax_id_create_request.py +111 -0
  1057. solvimon_python_sdk/models/tax_id_type_response.py +97 -0
  1058. solvimon_python_sdk/models/tax_id_validation.py +107 -0
  1059. solvimon_python_sdk/models/tax_id_validation_wrapper.py +96 -0
  1060. solvimon_python_sdk/models/tax_registration.py +112 -0
  1061. solvimon_python_sdk/models/tax_registration_create_request.py +112 -0
  1062. solvimon_python_sdk/models/tax_registration_update_request.py +112 -0
  1063. solvimon_python_sdk/models/tax_settings.py +89 -0
  1064. solvimon_python_sdk/models/tax_settings_create_request.py +89 -0
  1065. solvimon_python_sdk/models/team_member_paginated_response_wrapper.py +96 -0
  1066. solvimon_python_sdk/models/team_member_representation.py +109 -0
  1067. solvimon_python_sdk/models/team_member_representation_create_request.py +109 -0
  1068. solvimon_python_sdk/models/team_member_representation_update_request.py +109 -0
  1069. solvimon_python_sdk/models/team_representation.py +106 -0
  1070. solvimon_python_sdk/models/team_representation_create_request.py +106 -0
  1071. solvimon_python_sdk/models/template_pricing_plan_subscription.py +101 -0
  1072. solvimon_python_sdk/models/template_pricing_plan_subscription_update_request.py +101 -0
  1073. solvimon_python_sdk/models/test_connection_response.py +109 -0
  1074. solvimon_python_sdk/models/threshold.py +97 -0
  1075. solvimon_python_sdk/models/total_discount.py +117 -0
  1076. solvimon_python_sdk/models/trigger_report_request.py +96 -0
  1077. solvimon_python_sdk/models/trigger_report_request_create_request.py +96 -0
  1078. solvimon_python_sdk/models/uk_local.py +112 -0
  1079. solvimon_python_sdk/models/unit_name.py +112 -0
  1080. solvimon_python_sdk/models/unit_name_create_request.py +112 -0
  1081. solvimon_python_sdk/models/unit_name_update_request.py +112 -0
  1082. solvimon_python_sdk/models/us_local.py +136 -0
  1083. solvimon_python_sdk/models/usage_limit.py +139 -0
  1084. solvimon_python_sdk/models/usage_limit_create_request.py +136 -0
  1085. solvimon_python_sdk/models/usage_limit_response_wrapper.py +108 -0
  1086. solvimon_python_sdk/models/usage_limit_status.py +118 -0
  1087. solvimon_python_sdk/models/usage_limit_status_response.py +106 -0
  1088. solvimon_python_sdk/models/usage_limit_status_update.py +99 -0
  1089. solvimon_python_sdk/models/usage_limit_status_update_create_request.py +96 -0
  1090. solvimon_python_sdk/models/usage_limit_update_request.py +139 -0
  1091. solvimon_python_sdk/models/usage_limit_value.py +112 -0
  1092. solvimon_python_sdk/models/usage_limit_value_create_request.py +112 -0
  1093. solvimon_python_sdk/models/usage_limit_value_update_request.py +112 -0
  1094. solvimon_python_sdk/models/usage_threshold.py +124 -0
  1095. solvimon_python_sdk/models/usage_trigger.py +97 -0
  1096. solvimon_python_sdk/models/usage_trigger_create_request.py +97 -0
  1097. solvimon_python_sdk/models/usage_trigger_event.py +131 -0
  1098. solvimon_python_sdk/models/usage_workflow.py +110 -0
  1099. solvimon_python_sdk/models/usage_workflow_create_request.py +110 -0
  1100. solvimon_python_sdk/models/usage_workflow_update_request.py +110 -0
  1101. solvimon_python_sdk/models/used_exchange_rate.py +97 -0
  1102. solvimon_python_sdk/models/used_exchange_rate_create_request.py +97 -0
  1103. solvimon_python_sdk/models/used_exchange_rate_update_request.py +97 -0
  1104. solvimon_python_sdk/models/used_wallet_grant_detail.py +111 -0
  1105. solvimon_python_sdk/models/user.py +158 -0
  1106. solvimon_python_sdk/models/user_create_request.py +158 -0
  1107. solvimon_python_sdk/models/user_create_request_identity.py +158 -0
  1108. solvimon_python_sdk/models/user_invite.py +109 -0
  1109. solvimon_python_sdk/models/user_invite_create_request.py +109 -0
  1110. solvimon_python_sdk/models/user_paginated_response_wrapper.py +108 -0
  1111. solvimon_python_sdk/models/user_search_filter.py +95 -0
  1112. solvimon_python_sdk/models/user_search_filter_create_request.py +95 -0
  1113. solvimon_python_sdk/models/user_update_request.py +158 -0
  1114. solvimon_python_sdk/models/user_update_request_identity.py +158 -0
  1115. solvimon_python_sdk/models/username_password.py +91 -0
  1116. solvimon_python_sdk/models/username_password_create_request.py +91 -0
  1117. solvimon_python_sdk/models/volume.py +95 -0
  1118. solvimon_python_sdk/models/volume_create_request.py +95 -0
  1119. solvimon_python_sdk/models/wallet.py +151 -0
  1120. solvimon_python_sdk/models/wallet_balance_status.py +131 -0
  1121. solvimon_python_sdk/models/wallet_balance_status_request.py +92 -0
  1122. solvimon_python_sdk/models/wallet_balance_status_request_create_request.py +92 -0
  1123. solvimon_python_sdk/models/wallet_balance_value.py +103 -0
  1124. solvimon_python_sdk/models/wallet_balance_value_create_request.py +103 -0
  1125. solvimon_python_sdk/models/wallet_create_request.py +148 -0
  1126. solvimon_python_sdk/models/wallet_customer_balance_detail.py +113 -0
  1127. solvimon_python_sdk/models/wallet_grant.py +200 -0
  1128. solvimon_python_sdk/models/wallet_grant_create_request.py +200 -0
  1129. solvimon_python_sdk/models/wallet_grant_response_wrapper.py +108 -0
  1130. solvimon_python_sdk/models/wallet_grant_seat.py +95 -0
  1131. solvimon_python_sdk/models/wallet_grant_seat_create_request.py +95 -0
  1132. solvimon_python_sdk/models/wallet_response_wrapper.py +108 -0
  1133. solvimon_python_sdk/models/wallet_threshold.py +112 -0
  1134. solvimon_python_sdk/models/wallet_trigger.py +127 -0
  1135. solvimon_python_sdk/models/wallet_trigger_create_request.py +127 -0
  1136. solvimon_python_sdk/models/wallet_trigger_event.py +99 -0
  1137. solvimon_python_sdk/models/wallet_trigger_wallet_balance.py +102 -0
  1138. solvimon_python_sdk/models/wallet_type.py +164 -0
  1139. solvimon_python_sdk/models/wallet_type_balance.py +89 -0
  1140. solvimon_python_sdk/models/wallet_type_balance_update_request.py +89 -0
  1141. solvimon_python_sdk/models/wallet_type_create_request.py +164 -0
  1142. solvimon_python_sdk/models/wallet_type_credit.py +111 -0
  1143. solvimon_python_sdk/models/wallet_type_credit_amount_grant.py +111 -0
  1144. solvimon_python_sdk/models/wallet_type_credit_credits_grant.py +89 -0
  1145. solvimon_python_sdk/models/wallet_type_credit_update_request.py +111 -0
  1146. solvimon_python_sdk/models/wallet_type_response_wrapper.py +108 -0
  1147. solvimon_python_sdk/models/wallet_type_update_request.py +164 -0
  1148. solvimon_python_sdk/models/wallet_wallet_balance.py +107 -0
  1149. solvimon_python_sdk/models/wallet_workflow.py +105 -0
  1150. solvimon_python_sdk/models/wallet_workflow_create_request.py +105 -0
  1151. solvimon_python_sdk/models/wallet_workflow_update_request.py +105 -0
  1152. solvimon_python_sdk/models/webhook.py +200 -0
  1153. solvimon_python_sdk/models/webhook_action.py +91 -0
  1154. solvimon_python_sdk/models/webhook_action_response_wrapper.py +98 -0
  1155. solvimon_python_sdk/models/webhook_connection_response.py +95 -0
  1156. solvimon_python_sdk/models/webhook_create_request.py +200 -0
  1157. solvimon_python_sdk/models/webhook_event.py +131 -0
  1158. solvimon_python_sdk/models/webhook_event_failure_data.py +95 -0
  1159. solvimon_python_sdk/models/webhook_event_response_wrapper.py +108 -0
  1160. solvimon_python_sdk/models/webhook_response_wrapper.py +108 -0
  1161. solvimon_python_sdk/models/webhook_update_request.py +200 -0
  1162. solvimon_python_sdk/models/workflow.py +202 -0
  1163. solvimon_python_sdk/models/workflow_action.py +160 -0
  1164. solvimon_python_sdk/models/workflow_action_create_request.py +160 -0
  1165. solvimon_python_sdk/models/workflow_action_execution.py +149 -0
  1166. solvimon_python_sdk/models/workflow_action_execution_create_request.py +146 -0
  1167. solvimon_python_sdk/models/workflow_action_execution_update_request.py +149 -0
  1168. solvimon_python_sdk/models/workflow_action_executions_paginated_response.py +108 -0
  1169. solvimon_python_sdk/models/workflow_action_update_request.py +160 -0
  1170. solvimon_python_sdk/models/workflow_action_update_request_transaction.py +160 -0
  1171. solvimon_python_sdk/models/workflow_conditions.py +111 -0
  1172. solvimon_python_sdk/models/workflow_conditions_comparison.py +103 -0
  1173. solvimon_python_sdk/models/workflow_conditions_create_request.py +111 -0
  1174. solvimon_python_sdk/models/workflow_conditions_group.py +101 -0
  1175. solvimon_python_sdk/models/workflow_conditions_result_comparison.py +105 -0
  1176. solvimon_python_sdk/models/workflow_conditions_result_group.py +101 -0
  1177. solvimon_python_sdk/models/workflow_conditions_result_tree.py +123 -0
  1178. solvimon_python_sdk/models/workflow_conditions_result_tree_create_request.py +123 -0
  1179. solvimon_python_sdk/models/workflow_conditions_result_tree_update_request.py +123 -0
  1180. solvimon_python_sdk/models/workflow_conditions_update_request.py +111 -0
  1181. solvimon_python_sdk/models/workflow_create_request.py +190 -0
  1182. solvimon_python_sdk/models/workflow_create_request_transaction.py +202 -0
  1183. solvimon_python_sdk/models/workflow_init.py +102 -0
  1184. solvimon_python_sdk/models/workflow_init_create_request.py +102 -0
  1185. solvimon_python_sdk/models/workflow_paginated_response.py +108 -0
  1186. solvimon_python_sdk/models/workflow_trigger.py +157 -0
  1187. solvimon_python_sdk/models/workflow_trigger_create_request.py +154 -0
  1188. solvimon_python_sdk/models/workflow_trigger_paginated_response.py +108 -0
  1189. solvimon_python_sdk/models/workflow_trigger_update_request.py +157 -0
  1190. solvimon_python_sdk/models/workflow_update_request.py +202 -0
  1191. solvimon_python_sdk/py.typed +0 -0
  1192. solvimon_python_sdk/rest.py +335 -0
  1193. solvimon_python_sdk-0.0.4b0.dist-info/METADATA +1725 -0
  1194. solvimon_python_sdk-0.0.4b0.dist-info/RECORD +1196 -0
  1195. solvimon_python_sdk-0.0.4b0.dist-info/WHEEL +5 -0
  1196. solvimon_python_sdk-0.0.4b0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,3259 @@
1
+ """
2
+ Solvimon API
3
+
4
+ Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
5
+
6
+ The version of the OpenAPI document: 0.0.4-beta
7
+ Contact: contact@solvimon.com
8
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
9
+
10
+ Do not edit the class manually.
11
+ """ # noqa: E501
12
+
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictInt, StrictStr
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from solvimon_python_sdk.models.search_create_request import SearchCreateRequest
23
+ from solvimon_python_sdk.models.workflow import Workflow
24
+ from solvimon_python_sdk.models.workflow_create_request import WorkflowCreateRequest
25
+ from solvimon_python_sdk.models.workflow_init import WorkflowInit
26
+ from solvimon_python_sdk.models.workflow_init_create_request import WorkflowInitCreateRequest
27
+ from solvimon_python_sdk.models.workflow_paginated_response import WorkflowPaginatedResponse
28
+ from solvimon_python_sdk.models.workflow_update_request import WorkflowUpdateRequest
29
+
30
+ from solvimon_python_sdk.api_client import ApiClient, RequestSerialized
31
+ from solvimon_python_sdk.api_response import ApiResponse
32
+ from solvimon_python_sdk.rest import RESTResponseType
33
+
34
+
35
+ class WorkflowsApi:
36
+ """NOTE: This class is auto generated by OpenAPI Generator
37
+ Ref: https://openapi-generator.tech
38
+
39
+ Do not edit the class manually.
40
+ """
41
+
42
+ def __init__(self, api_client=None) -> None:
43
+ if api_client is None:
44
+ api_client = ApiClient.get_default()
45
+ self.api_client = api_client
46
+
47
+
48
+ @validate_call
49
+ def delete_workflows_by_resource_id_or_reference(
50
+ self,
51
+ version: Annotated[StrictStr, Field(description="version")],
52
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
53
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> Workflow:
67
+ """Delete a draft workflow by ID or reference
68
+
69
+ Deletes a workflow and its actions only when it is still in DRAFT status. Use archive for active or inactive workflows. Requires the WORKFLOW.DELETE permission.
70
+
71
+ :param version: version (required)
72
+ :type version: str
73
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
74
+ :type resource_id_or_reference: str
75
+ :param x_platform_id: Platform ID.
76
+ :type x_platform_id: str
77
+ :param _request_timeout: timeout setting for this request. If one
78
+ number provided, it will be total request
79
+ timeout. It can also be a pair (tuple) of
80
+ (connection, read) timeouts.
81
+ :type _request_timeout: int, tuple(int, int), optional
82
+ :param _request_auth: set to override the auth_settings for an a single
83
+ request; this effectively ignores the
84
+ authentication in the spec for a single request.
85
+ :type _request_auth: dict, optional
86
+ :param _content_type: force content-type for the request.
87
+ :type _content_type: str, Optional
88
+ :param _headers: set to override the headers for a single
89
+ request; this effectively ignores the headers
90
+ in the spec for a single request.
91
+ :type _headers: dict, optional
92
+ :param _host_index: set to override the host_index for a single
93
+ request; this effectively ignores the host_index
94
+ in the spec for a single request.
95
+ :type _host_index: int, optional
96
+ :return: Returns the result object.
97
+ """ # noqa: E501
98
+
99
+ _param = self._delete_workflows_by_resource_id_or_reference_serialize(
100
+ version=version,
101
+ resource_id_or_reference=resource_id_or_reference,
102
+ x_platform_id=x_platform_id,
103
+ _request_auth=_request_auth,
104
+ _content_type=_content_type,
105
+ _headers=_headers,
106
+ _host_index=_host_index
107
+ )
108
+
109
+ _response_types_map: Dict[str, Optional[str]] = {
110
+ '200': "Workflow",
111
+ '401': "ApiError",
112
+ '403': "ApiError",
113
+ }
114
+ response_data = self.api_client.call_api(
115
+ *_param,
116
+ _request_timeout=_request_timeout
117
+ )
118
+ response_data.read()
119
+ return self.api_client.response_deserialize(
120
+ response_data=response_data,
121
+ response_types_map=_response_types_map,
122
+ ).data
123
+
124
+
125
+ @validate_call
126
+ def delete_workflows_by_resource_id_or_reference_with_http_info(
127
+ self,
128
+ version: Annotated[StrictStr, Field(description="version")],
129
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
130
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
131
+ _request_timeout: Union[
132
+ None,
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Tuple[
135
+ Annotated[StrictFloat, Field(gt=0)],
136
+ Annotated[StrictFloat, Field(gt=0)]
137
+ ]
138
+ ] = None,
139
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
140
+ _content_type: Optional[StrictStr] = None,
141
+ _headers: Optional[Dict[StrictStr, Any]] = None,
142
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
143
+ ) -> ApiResponse[Workflow]:
144
+ """Delete a draft workflow by ID or reference
145
+
146
+ Deletes a workflow and its actions only when it is still in DRAFT status. Use archive for active or inactive workflows. Requires the WORKFLOW.DELETE permission.
147
+
148
+ :param version: version (required)
149
+ :type version: str
150
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
151
+ :type resource_id_or_reference: str
152
+ :param x_platform_id: Platform ID.
153
+ :type x_platform_id: str
154
+ :param _request_timeout: timeout setting for this request. If one
155
+ number provided, it will be total request
156
+ timeout. It can also be a pair (tuple) of
157
+ (connection, read) timeouts.
158
+ :type _request_timeout: int, tuple(int, int), optional
159
+ :param _request_auth: set to override the auth_settings for an a single
160
+ request; this effectively ignores the
161
+ authentication in the spec for a single request.
162
+ :type _request_auth: dict, optional
163
+ :param _content_type: force content-type for the request.
164
+ :type _content_type: str, Optional
165
+ :param _headers: set to override the headers for a single
166
+ request; this effectively ignores the headers
167
+ in the spec for a single request.
168
+ :type _headers: dict, optional
169
+ :param _host_index: set to override the host_index for a single
170
+ request; this effectively ignores the host_index
171
+ in the spec for a single request.
172
+ :type _host_index: int, optional
173
+ :return: Returns the result object.
174
+ """ # noqa: E501
175
+
176
+ _param = self._delete_workflows_by_resource_id_or_reference_serialize(
177
+ version=version,
178
+ resource_id_or_reference=resource_id_or_reference,
179
+ x_platform_id=x_platform_id,
180
+ _request_auth=_request_auth,
181
+ _content_type=_content_type,
182
+ _headers=_headers,
183
+ _host_index=_host_index
184
+ )
185
+
186
+ _response_types_map: Dict[str, Optional[str]] = {
187
+ '200': "Workflow",
188
+ '401': "ApiError",
189
+ '403': "ApiError",
190
+ }
191
+ response_data = self.api_client.call_api(
192
+ *_param,
193
+ _request_timeout=_request_timeout
194
+ )
195
+ response_data.read()
196
+ return self.api_client.response_deserialize(
197
+ response_data=response_data,
198
+ response_types_map=_response_types_map,
199
+ )
200
+
201
+
202
+ @validate_call
203
+ def delete_workflows_by_resource_id_or_reference_without_preload_content(
204
+ self,
205
+ version: Annotated[StrictStr, Field(description="version")],
206
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
207
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
208
+ _request_timeout: Union[
209
+ None,
210
+ Annotated[StrictFloat, Field(gt=0)],
211
+ Tuple[
212
+ Annotated[StrictFloat, Field(gt=0)],
213
+ Annotated[StrictFloat, Field(gt=0)]
214
+ ]
215
+ ] = None,
216
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
217
+ _content_type: Optional[StrictStr] = None,
218
+ _headers: Optional[Dict[StrictStr, Any]] = None,
219
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
220
+ ) -> RESTResponseType:
221
+ """Delete a draft workflow by ID or reference
222
+
223
+ Deletes a workflow and its actions only when it is still in DRAFT status. Use archive for active or inactive workflows. Requires the WORKFLOW.DELETE permission.
224
+
225
+ :param version: version (required)
226
+ :type version: str
227
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
228
+ :type resource_id_or_reference: str
229
+ :param x_platform_id: Platform ID.
230
+ :type x_platform_id: str
231
+ :param _request_timeout: timeout setting for this request. If one
232
+ number provided, it will be total request
233
+ timeout. It can also be a pair (tuple) of
234
+ (connection, read) timeouts.
235
+ :type _request_timeout: int, tuple(int, int), optional
236
+ :param _request_auth: set to override the auth_settings for an a single
237
+ request; this effectively ignores the
238
+ authentication in the spec for a single request.
239
+ :type _request_auth: dict, optional
240
+ :param _content_type: force content-type for the request.
241
+ :type _content_type: str, Optional
242
+ :param _headers: set to override the headers for a single
243
+ request; this effectively ignores the headers
244
+ in the spec for a single request.
245
+ :type _headers: dict, optional
246
+ :param _host_index: set to override the host_index for a single
247
+ request; this effectively ignores the host_index
248
+ in the spec for a single request.
249
+ :type _host_index: int, optional
250
+ :return: Returns the result object.
251
+ """ # noqa: E501
252
+
253
+ _param = self._delete_workflows_by_resource_id_or_reference_serialize(
254
+ version=version,
255
+ resource_id_or_reference=resource_id_or_reference,
256
+ x_platform_id=x_platform_id,
257
+ _request_auth=_request_auth,
258
+ _content_type=_content_type,
259
+ _headers=_headers,
260
+ _host_index=_host_index
261
+ )
262
+
263
+ _response_types_map: Dict[str, Optional[str]] = {
264
+ '200': "Workflow",
265
+ '401': "ApiError",
266
+ '403': "ApiError",
267
+ }
268
+ response_data = self.api_client.call_api(
269
+ *_param,
270
+ _request_timeout=_request_timeout
271
+ )
272
+ return response_data.response
273
+
274
+
275
+ def _delete_workflows_by_resource_id_or_reference_serialize(
276
+ self,
277
+ version,
278
+ resource_id_or_reference,
279
+ x_platform_id,
280
+ _request_auth,
281
+ _content_type,
282
+ _headers,
283
+ _host_index,
284
+ ) -> RequestSerialized:
285
+
286
+ _host = None
287
+
288
+ _collection_formats: Dict[str, str] = {
289
+ }
290
+
291
+ _path_params: Dict[str, str] = {}
292
+ _query_params: List[Tuple[str, str]] = []
293
+ _header_params: Dict[str, Optional[str]] = _headers or {}
294
+ _form_params: List[Tuple[str, str]] = []
295
+ _files: Dict[
296
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
297
+ ] = {}
298
+ _body_params: Optional[bytes] = None
299
+
300
+ # process the path parameters
301
+ if version is not None:
302
+ _path_params['version'] = version
303
+ if resource_id_or_reference is not None:
304
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
305
+ # process the query parameters
306
+ # process the header parameters
307
+ if x_platform_id is not None:
308
+ _header_params['x-platform-id'] = x_platform_id
309
+ # process the form parameters
310
+ # process the body parameter
311
+
312
+
313
+ # set the HTTP header `Accept`
314
+ if 'Accept' not in _header_params:
315
+ _header_params['Accept'] = self.api_client.select_header_accept(
316
+ [
317
+ 'application/json',
318
+ '*/*'
319
+ ]
320
+ )
321
+
322
+
323
+ # authentication setting
324
+ _auth_settings: List[str] = [
325
+ 'JWT-Authentication',
326
+ 'API-Key'
327
+ ]
328
+
329
+ return self.api_client.param_serialize(
330
+ method='DELETE',
331
+ resource_path='/v{version}/workflows/{resourceIdOrReference}',
332
+ path_params=_path_params,
333
+ query_params=_query_params,
334
+ header_params=_header_params,
335
+ body=_body_params,
336
+ post_params=_form_params,
337
+ files=_files,
338
+ auth_settings=_auth_settings,
339
+ collection_formats=_collection_formats,
340
+ _host=_host,
341
+ _request_auth=_request_auth
342
+ )
343
+
344
+
345
+
346
+
347
+ @validate_call
348
+ def get_workflows(
349
+ self,
350
+ version: Annotated[StrictStr, Field(description="version")],
351
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
352
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
353
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
354
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
355
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
356
+ _request_timeout: Union[
357
+ None,
358
+ Annotated[StrictFloat, Field(gt=0)],
359
+ Tuple[
360
+ Annotated[StrictFloat, Field(gt=0)],
361
+ Annotated[StrictFloat, Field(gt=0)]
362
+ ]
363
+ ] = None,
364
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
365
+ _content_type: Optional[StrictStr] = None,
366
+ _headers: Optional[Dict[StrictStr, Any]] = None,
367
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
368
+ ) -> WorkflowPaginatedResponse:
369
+ """Get all workflows
370
+
371
+ Returns paginated workflow definitions for the authenticated platform. Use this to inspect workflow definitions, their target use cases, and their current status. Requires the WORKFLOW.VIEW permission.
372
+
373
+ :param version: version (required)
374
+ :type version: str
375
+ :param x_platform_id: Platform ID.
376
+ :type x_platform_id: str
377
+ :param limit: The amount of records shown in the list
378
+ :type limit: int
379
+ :param page: The page which is going to be shown
380
+ :type page: int
381
+ :param order_by: The parameter by which the response is ordered.
382
+ :type order_by: str
383
+ :param order_direction: The order direction by which the response is ordered.
384
+ :type order_direction: str
385
+ :param _request_timeout: timeout setting for this request. If one
386
+ number provided, it will be total request
387
+ timeout. It can also be a pair (tuple) of
388
+ (connection, read) timeouts.
389
+ :type _request_timeout: int, tuple(int, int), optional
390
+ :param _request_auth: set to override the auth_settings for an a single
391
+ request; this effectively ignores the
392
+ authentication in the spec for a single request.
393
+ :type _request_auth: dict, optional
394
+ :param _content_type: force content-type for the request.
395
+ :type _content_type: str, Optional
396
+ :param _headers: set to override the headers for a single
397
+ request; this effectively ignores the headers
398
+ in the spec for a single request.
399
+ :type _headers: dict, optional
400
+ :param _host_index: set to override the host_index for a single
401
+ request; this effectively ignores the host_index
402
+ in the spec for a single request.
403
+ :type _host_index: int, optional
404
+ :return: Returns the result object.
405
+ """ # noqa: E501
406
+
407
+ _param = self._get_workflows_serialize(
408
+ version=version,
409
+ x_platform_id=x_platform_id,
410
+ limit=limit,
411
+ page=page,
412
+ order_by=order_by,
413
+ order_direction=order_direction,
414
+ _request_auth=_request_auth,
415
+ _content_type=_content_type,
416
+ _headers=_headers,
417
+ _host_index=_host_index
418
+ )
419
+
420
+ _response_types_map: Dict[str, Optional[str]] = {
421
+ '200': "WorkflowPaginatedResponse",
422
+ '401': "ApiError",
423
+ '403': "ApiError",
424
+ }
425
+ response_data = self.api_client.call_api(
426
+ *_param,
427
+ _request_timeout=_request_timeout
428
+ )
429
+ response_data.read()
430
+ return self.api_client.response_deserialize(
431
+ response_data=response_data,
432
+ response_types_map=_response_types_map,
433
+ ).data
434
+
435
+
436
+ @validate_call
437
+ def get_workflows_with_http_info(
438
+ self,
439
+ version: Annotated[StrictStr, Field(description="version")],
440
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
441
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
442
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
443
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
444
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
445
+ _request_timeout: Union[
446
+ None,
447
+ Annotated[StrictFloat, Field(gt=0)],
448
+ Tuple[
449
+ Annotated[StrictFloat, Field(gt=0)],
450
+ Annotated[StrictFloat, Field(gt=0)]
451
+ ]
452
+ ] = None,
453
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
454
+ _content_type: Optional[StrictStr] = None,
455
+ _headers: Optional[Dict[StrictStr, Any]] = None,
456
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
457
+ ) -> ApiResponse[WorkflowPaginatedResponse]:
458
+ """Get all workflows
459
+
460
+ Returns paginated workflow definitions for the authenticated platform. Use this to inspect workflow definitions, their target use cases, and their current status. Requires the WORKFLOW.VIEW permission.
461
+
462
+ :param version: version (required)
463
+ :type version: str
464
+ :param x_platform_id: Platform ID.
465
+ :type x_platform_id: str
466
+ :param limit: The amount of records shown in the list
467
+ :type limit: int
468
+ :param page: The page which is going to be shown
469
+ :type page: int
470
+ :param order_by: The parameter by which the response is ordered.
471
+ :type order_by: str
472
+ :param order_direction: The order direction by which the response is ordered.
473
+ :type order_direction: str
474
+ :param _request_timeout: timeout setting for this request. If one
475
+ number provided, it will be total request
476
+ timeout. It can also be a pair (tuple) of
477
+ (connection, read) timeouts.
478
+ :type _request_timeout: int, tuple(int, int), optional
479
+ :param _request_auth: set to override the auth_settings for an a single
480
+ request; this effectively ignores the
481
+ authentication in the spec for a single request.
482
+ :type _request_auth: dict, optional
483
+ :param _content_type: force content-type for the request.
484
+ :type _content_type: str, Optional
485
+ :param _headers: set to override the headers for a single
486
+ request; this effectively ignores the headers
487
+ in the spec for a single request.
488
+ :type _headers: dict, optional
489
+ :param _host_index: set to override the host_index for a single
490
+ request; this effectively ignores the host_index
491
+ in the spec for a single request.
492
+ :type _host_index: int, optional
493
+ :return: Returns the result object.
494
+ """ # noqa: E501
495
+
496
+ _param = self._get_workflows_serialize(
497
+ version=version,
498
+ x_platform_id=x_platform_id,
499
+ limit=limit,
500
+ page=page,
501
+ order_by=order_by,
502
+ order_direction=order_direction,
503
+ _request_auth=_request_auth,
504
+ _content_type=_content_type,
505
+ _headers=_headers,
506
+ _host_index=_host_index
507
+ )
508
+
509
+ _response_types_map: Dict[str, Optional[str]] = {
510
+ '200': "WorkflowPaginatedResponse",
511
+ '401': "ApiError",
512
+ '403': "ApiError",
513
+ }
514
+ response_data = self.api_client.call_api(
515
+ *_param,
516
+ _request_timeout=_request_timeout
517
+ )
518
+ response_data.read()
519
+ return self.api_client.response_deserialize(
520
+ response_data=response_data,
521
+ response_types_map=_response_types_map,
522
+ )
523
+
524
+
525
+ @validate_call
526
+ def get_workflows_without_preload_content(
527
+ self,
528
+ version: Annotated[StrictStr, Field(description="version")],
529
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
530
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
531
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
532
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
533
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
534
+ _request_timeout: Union[
535
+ None,
536
+ Annotated[StrictFloat, Field(gt=0)],
537
+ Tuple[
538
+ Annotated[StrictFloat, Field(gt=0)],
539
+ Annotated[StrictFloat, Field(gt=0)]
540
+ ]
541
+ ] = None,
542
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
543
+ _content_type: Optional[StrictStr] = None,
544
+ _headers: Optional[Dict[StrictStr, Any]] = None,
545
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
546
+ ) -> RESTResponseType:
547
+ """Get all workflows
548
+
549
+ Returns paginated workflow definitions for the authenticated platform. Use this to inspect workflow definitions, their target use cases, and their current status. Requires the WORKFLOW.VIEW permission.
550
+
551
+ :param version: version (required)
552
+ :type version: str
553
+ :param x_platform_id: Platform ID.
554
+ :type x_platform_id: str
555
+ :param limit: The amount of records shown in the list
556
+ :type limit: int
557
+ :param page: The page which is going to be shown
558
+ :type page: int
559
+ :param order_by: The parameter by which the response is ordered.
560
+ :type order_by: str
561
+ :param order_direction: The order direction by which the response is ordered.
562
+ :type order_direction: str
563
+ :param _request_timeout: timeout setting for this request. If one
564
+ number provided, it will be total request
565
+ timeout. It can also be a pair (tuple) of
566
+ (connection, read) timeouts.
567
+ :type _request_timeout: int, tuple(int, int), optional
568
+ :param _request_auth: set to override the auth_settings for an a single
569
+ request; this effectively ignores the
570
+ authentication in the spec for a single request.
571
+ :type _request_auth: dict, optional
572
+ :param _content_type: force content-type for the request.
573
+ :type _content_type: str, Optional
574
+ :param _headers: set to override the headers for a single
575
+ request; this effectively ignores the headers
576
+ in the spec for a single request.
577
+ :type _headers: dict, optional
578
+ :param _host_index: set to override the host_index for a single
579
+ request; this effectively ignores the host_index
580
+ in the spec for a single request.
581
+ :type _host_index: int, optional
582
+ :return: Returns the result object.
583
+ """ # noqa: E501
584
+
585
+ _param = self._get_workflows_serialize(
586
+ version=version,
587
+ x_platform_id=x_platform_id,
588
+ limit=limit,
589
+ page=page,
590
+ order_by=order_by,
591
+ order_direction=order_direction,
592
+ _request_auth=_request_auth,
593
+ _content_type=_content_type,
594
+ _headers=_headers,
595
+ _host_index=_host_index
596
+ )
597
+
598
+ _response_types_map: Dict[str, Optional[str]] = {
599
+ '200': "WorkflowPaginatedResponse",
600
+ '401': "ApiError",
601
+ '403': "ApiError",
602
+ }
603
+ response_data = self.api_client.call_api(
604
+ *_param,
605
+ _request_timeout=_request_timeout
606
+ )
607
+ return response_data.response
608
+
609
+
610
+ def _get_workflows_serialize(
611
+ self,
612
+ version,
613
+ x_platform_id,
614
+ limit,
615
+ page,
616
+ order_by,
617
+ order_direction,
618
+ _request_auth,
619
+ _content_type,
620
+ _headers,
621
+ _host_index,
622
+ ) -> RequestSerialized:
623
+
624
+ _host = None
625
+
626
+ _collection_formats: Dict[str, str] = {
627
+ }
628
+
629
+ _path_params: Dict[str, str] = {}
630
+ _query_params: List[Tuple[str, str]] = []
631
+ _header_params: Dict[str, Optional[str]] = _headers or {}
632
+ _form_params: List[Tuple[str, str]] = []
633
+ _files: Dict[
634
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
635
+ ] = {}
636
+ _body_params: Optional[bytes] = None
637
+
638
+ # process the path parameters
639
+ if version is not None:
640
+ _path_params['version'] = version
641
+ # process the query parameters
642
+ if limit is not None:
643
+
644
+ _query_params.append(('limit', limit))
645
+
646
+ if page is not None:
647
+
648
+ _query_params.append(('page', page))
649
+
650
+ if order_by is not None:
651
+
652
+ _query_params.append(('order_by', order_by))
653
+
654
+ if order_direction is not None:
655
+
656
+ _query_params.append(('order_direction', order_direction))
657
+
658
+ # process the header parameters
659
+ if x_platform_id is not None:
660
+ _header_params['x-platform-id'] = x_platform_id
661
+ # process the form parameters
662
+ # process the body parameter
663
+
664
+
665
+ # set the HTTP header `Accept`
666
+ if 'Accept' not in _header_params:
667
+ _header_params['Accept'] = self.api_client.select_header_accept(
668
+ [
669
+ 'application/json',
670
+ '*/*'
671
+ ]
672
+ )
673
+
674
+
675
+ # authentication setting
676
+ _auth_settings: List[str] = [
677
+ 'JWT-Authentication',
678
+ 'API-Key'
679
+ ]
680
+
681
+ return self.api_client.param_serialize(
682
+ method='GET',
683
+ resource_path='/v{version}/workflows',
684
+ path_params=_path_params,
685
+ query_params=_query_params,
686
+ header_params=_header_params,
687
+ body=_body_params,
688
+ post_params=_form_params,
689
+ files=_files,
690
+ auth_settings=_auth_settings,
691
+ collection_formats=_collection_formats,
692
+ _host=_host,
693
+ _request_auth=_request_auth
694
+ )
695
+
696
+
697
+
698
+
699
+ @validate_call
700
+ def get_workflows_by_resource_id_or_reference(
701
+ self,
702
+ version: Annotated[StrictStr, Field(description="version")],
703
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
704
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
705
+ _request_timeout: Union[
706
+ None,
707
+ Annotated[StrictFloat, Field(gt=0)],
708
+ Tuple[
709
+ Annotated[StrictFloat, Field(gt=0)],
710
+ Annotated[StrictFloat, Field(gt=0)]
711
+ ]
712
+ ] = None,
713
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
714
+ _content_type: Optional[StrictStr] = None,
715
+ _headers: Optional[Dict[StrictStr, Any]] = None,
716
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
717
+ ) -> Workflow:
718
+ """Get workflow by ID or reference
719
+
720
+ Fetches a single workflow definition using either its resource ID or reference. Requires the WORKFLOW.VIEW permission.
721
+
722
+ :param version: version (required)
723
+ :type version: str
724
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
725
+ :type resource_id_or_reference: str
726
+ :param x_platform_id: Platform ID.
727
+ :type x_platform_id: str
728
+ :param _request_timeout: timeout setting for this request. If one
729
+ number provided, it will be total request
730
+ timeout. It can also be a pair (tuple) of
731
+ (connection, read) timeouts.
732
+ :type _request_timeout: int, tuple(int, int), optional
733
+ :param _request_auth: set to override the auth_settings for an a single
734
+ request; this effectively ignores the
735
+ authentication in the spec for a single request.
736
+ :type _request_auth: dict, optional
737
+ :param _content_type: force content-type for the request.
738
+ :type _content_type: str, Optional
739
+ :param _headers: set to override the headers for a single
740
+ request; this effectively ignores the headers
741
+ in the spec for a single request.
742
+ :type _headers: dict, optional
743
+ :param _host_index: set to override the host_index for a single
744
+ request; this effectively ignores the host_index
745
+ in the spec for a single request.
746
+ :type _host_index: int, optional
747
+ :return: Returns the result object.
748
+ """ # noqa: E501
749
+
750
+ _param = self._get_workflows_by_resource_id_or_reference_serialize(
751
+ version=version,
752
+ resource_id_or_reference=resource_id_or_reference,
753
+ x_platform_id=x_platform_id,
754
+ _request_auth=_request_auth,
755
+ _content_type=_content_type,
756
+ _headers=_headers,
757
+ _host_index=_host_index
758
+ )
759
+
760
+ _response_types_map: Dict[str, Optional[str]] = {
761
+ '200': "Workflow",
762
+ '401': "ApiError",
763
+ '403': "ApiError",
764
+ }
765
+ response_data = self.api_client.call_api(
766
+ *_param,
767
+ _request_timeout=_request_timeout
768
+ )
769
+ response_data.read()
770
+ return self.api_client.response_deserialize(
771
+ response_data=response_data,
772
+ response_types_map=_response_types_map,
773
+ ).data
774
+
775
+
776
+ @validate_call
777
+ def get_workflows_by_resource_id_or_reference_with_http_info(
778
+ self,
779
+ version: Annotated[StrictStr, Field(description="version")],
780
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
781
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
782
+ _request_timeout: Union[
783
+ None,
784
+ Annotated[StrictFloat, Field(gt=0)],
785
+ Tuple[
786
+ Annotated[StrictFloat, Field(gt=0)],
787
+ Annotated[StrictFloat, Field(gt=0)]
788
+ ]
789
+ ] = None,
790
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
791
+ _content_type: Optional[StrictStr] = None,
792
+ _headers: Optional[Dict[StrictStr, Any]] = None,
793
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
794
+ ) -> ApiResponse[Workflow]:
795
+ """Get workflow by ID or reference
796
+
797
+ Fetches a single workflow definition using either its resource ID or reference. Requires the WORKFLOW.VIEW permission.
798
+
799
+ :param version: version (required)
800
+ :type version: str
801
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
802
+ :type resource_id_or_reference: str
803
+ :param x_platform_id: Platform ID.
804
+ :type x_platform_id: str
805
+ :param _request_timeout: timeout setting for this request. If one
806
+ number provided, it will be total request
807
+ timeout. It can also be a pair (tuple) of
808
+ (connection, read) timeouts.
809
+ :type _request_timeout: int, tuple(int, int), optional
810
+ :param _request_auth: set to override the auth_settings for an a single
811
+ request; this effectively ignores the
812
+ authentication in the spec for a single request.
813
+ :type _request_auth: dict, optional
814
+ :param _content_type: force content-type for the request.
815
+ :type _content_type: str, Optional
816
+ :param _headers: set to override the headers for a single
817
+ request; this effectively ignores the headers
818
+ in the spec for a single request.
819
+ :type _headers: dict, optional
820
+ :param _host_index: set to override the host_index for a single
821
+ request; this effectively ignores the host_index
822
+ in the spec for a single request.
823
+ :type _host_index: int, optional
824
+ :return: Returns the result object.
825
+ """ # noqa: E501
826
+
827
+ _param = self._get_workflows_by_resource_id_or_reference_serialize(
828
+ version=version,
829
+ resource_id_or_reference=resource_id_or_reference,
830
+ x_platform_id=x_platform_id,
831
+ _request_auth=_request_auth,
832
+ _content_type=_content_type,
833
+ _headers=_headers,
834
+ _host_index=_host_index
835
+ )
836
+
837
+ _response_types_map: Dict[str, Optional[str]] = {
838
+ '200': "Workflow",
839
+ '401': "ApiError",
840
+ '403': "ApiError",
841
+ }
842
+ response_data = self.api_client.call_api(
843
+ *_param,
844
+ _request_timeout=_request_timeout
845
+ )
846
+ response_data.read()
847
+ return self.api_client.response_deserialize(
848
+ response_data=response_data,
849
+ response_types_map=_response_types_map,
850
+ )
851
+
852
+
853
+ @validate_call
854
+ def get_workflows_by_resource_id_or_reference_without_preload_content(
855
+ self,
856
+ version: Annotated[StrictStr, Field(description="version")],
857
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
858
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
859
+ _request_timeout: Union[
860
+ None,
861
+ Annotated[StrictFloat, Field(gt=0)],
862
+ Tuple[
863
+ Annotated[StrictFloat, Field(gt=0)],
864
+ Annotated[StrictFloat, Field(gt=0)]
865
+ ]
866
+ ] = None,
867
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
868
+ _content_type: Optional[StrictStr] = None,
869
+ _headers: Optional[Dict[StrictStr, Any]] = None,
870
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
871
+ ) -> RESTResponseType:
872
+ """Get workflow by ID or reference
873
+
874
+ Fetches a single workflow definition using either its resource ID or reference. Requires the WORKFLOW.VIEW permission.
875
+
876
+ :param version: version (required)
877
+ :type version: str
878
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
879
+ :type resource_id_or_reference: str
880
+ :param x_platform_id: Platform ID.
881
+ :type x_platform_id: str
882
+ :param _request_timeout: timeout setting for this request. If one
883
+ number provided, it will be total request
884
+ timeout. It can also be a pair (tuple) of
885
+ (connection, read) timeouts.
886
+ :type _request_timeout: int, tuple(int, int), optional
887
+ :param _request_auth: set to override the auth_settings for an a single
888
+ request; this effectively ignores the
889
+ authentication in the spec for a single request.
890
+ :type _request_auth: dict, optional
891
+ :param _content_type: force content-type for the request.
892
+ :type _content_type: str, Optional
893
+ :param _headers: set to override the headers for a single
894
+ request; this effectively ignores the headers
895
+ in the spec for a single request.
896
+ :type _headers: dict, optional
897
+ :param _host_index: set to override the host_index for a single
898
+ request; this effectively ignores the host_index
899
+ in the spec for a single request.
900
+ :type _host_index: int, optional
901
+ :return: Returns the result object.
902
+ """ # noqa: E501
903
+
904
+ _param = self._get_workflows_by_resource_id_or_reference_serialize(
905
+ version=version,
906
+ resource_id_or_reference=resource_id_or_reference,
907
+ x_platform_id=x_platform_id,
908
+ _request_auth=_request_auth,
909
+ _content_type=_content_type,
910
+ _headers=_headers,
911
+ _host_index=_host_index
912
+ )
913
+
914
+ _response_types_map: Dict[str, Optional[str]] = {
915
+ '200': "Workflow",
916
+ '401': "ApiError",
917
+ '403': "ApiError",
918
+ }
919
+ response_data = self.api_client.call_api(
920
+ *_param,
921
+ _request_timeout=_request_timeout
922
+ )
923
+ return response_data.response
924
+
925
+
926
+ def _get_workflows_by_resource_id_or_reference_serialize(
927
+ self,
928
+ version,
929
+ resource_id_or_reference,
930
+ x_platform_id,
931
+ _request_auth,
932
+ _content_type,
933
+ _headers,
934
+ _host_index,
935
+ ) -> RequestSerialized:
936
+
937
+ _host = None
938
+
939
+ _collection_formats: Dict[str, str] = {
940
+ }
941
+
942
+ _path_params: Dict[str, str] = {}
943
+ _query_params: List[Tuple[str, str]] = []
944
+ _header_params: Dict[str, Optional[str]] = _headers or {}
945
+ _form_params: List[Tuple[str, str]] = []
946
+ _files: Dict[
947
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
948
+ ] = {}
949
+ _body_params: Optional[bytes] = None
950
+
951
+ # process the path parameters
952
+ if version is not None:
953
+ _path_params['version'] = version
954
+ if resource_id_or_reference is not None:
955
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
956
+ # process the query parameters
957
+ # process the header parameters
958
+ if x_platform_id is not None:
959
+ _header_params['x-platform-id'] = x_platform_id
960
+ # process the form parameters
961
+ # process the body parameter
962
+
963
+
964
+ # set the HTTP header `Accept`
965
+ if 'Accept' not in _header_params:
966
+ _header_params['Accept'] = self.api_client.select_header_accept(
967
+ [
968
+ 'application/json',
969
+ '*/*'
970
+ ]
971
+ )
972
+
973
+
974
+ # authentication setting
975
+ _auth_settings: List[str] = [
976
+ 'JWT-Authentication',
977
+ 'API-Key'
978
+ ]
979
+
980
+ return self.api_client.param_serialize(
981
+ method='GET',
982
+ resource_path='/v{version}/workflows/{resourceIdOrReference}',
983
+ path_params=_path_params,
984
+ query_params=_query_params,
985
+ header_params=_header_params,
986
+ body=_body_params,
987
+ post_params=_form_params,
988
+ files=_files,
989
+ auth_settings=_auth_settings,
990
+ collection_formats=_collection_formats,
991
+ _host=_host,
992
+ _request_auth=_request_auth
993
+ )
994
+
995
+
996
+
997
+
998
+ @validate_call
999
+ def post_workflows(
1000
+ self,
1001
+ version: Annotated[StrictStr, Field(description="version")],
1002
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1003
+ workflow_create_request: Optional[WorkflowCreateRequest] = None,
1004
+ _request_timeout: Union[
1005
+ None,
1006
+ Annotated[StrictFloat, Field(gt=0)],
1007
+ Tuple[
1008
+ Annotated[StrictFloat, Field(gt=0)],
1009
+ Annotated[StrictFloat, Field(gt=0)]
1010
+ ]
1011
+ ] = None,
1012
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1013
+ _content_type: Optional[StrictStr] = None,
1014
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1015
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1016
+ ) -> Workflow:
1017
+ """Create a workflow
1018
+
1019
+ Creates a workflow definition. Set the target type, provide the corresponding configuration block, and use workflow triggers later to execute the workflow for a concrete resource instance. Requires the WORKFLOW.CREATE permission.
1020
+
1021
+ :param version: version (required)
1022
+ :type version: str
1023
+ :param x_platform_id: Platform ID.
1024
+ :type x_platform_id: str
1025
+ :param workflow_create_request:
1026
+ :type workflow_create_request: WorkflowCreateRequest
1027
+ :param _request_timeout: timeout setting for this request. If one
1028
+ number provided, it will be total request
1029
+ timeout. It can also be a pair (tuple) of
1030
+ (connection, read) timeouts.
1031
+ :type _request_timeout: int, tuple(int, int), optional
1032
+ :param _request_auth: set to override the auth_settings for an a single
1033
+ request; this effectively ignores the
1034
+ authentication in the spec for a single request.
1035
+ :type _request_auth: dict, optional
1036
+ :param _content_type: force content-type for the request.
1037
+ :type _content_type: str, Optional
1038
+ :param _headers: set to override the headers for a single
1039
+ request; this effectively ignores the headers
1040
+ in the spec for a single request.
1041
+ :type _headers: dict, optional
1042
+ :param _host_index: set to override the host_index for a single
1043
+ request; this effectively ignores the host_index
1044
+ in the spec for a single request.
1045
+ :type _host_index: int, optional
1046
+ :return: Returns the result object.
1047
+ """ # noqa: E501
1048
+
1049
+ _param = self._post_workflows_serialize(
1050
+ version=version,
1051
+ x_platform_id=x_platform_id,
1052
+ workflow_create_request=workflow_create_request,
1053
+ _request_auth=_request_auth,
1054
+ _content_type=_content_type,
1055
+ _headers=_headers,
1056
+ _host_index=_host_index
1057
+ )
1058
+
1059
+ _response_types_map: Dict[str, Optional[str]] = {
1060
+ '201': "Workflow",
1061
+ '401': "ApiError",
1062
+ '403': "ApiError",
1063
+ }
1064
+ response_data = self.api_client.call_api(
1065
+ *_param,
1066
+ _request_timeout=_request_timeout
1067
+ )
1068
+ response_data.read()
1069
+ return self.api_client.response_deserialize(
1070
+ response_data=response_data,
1071
+ response_types_map=_response_types_map,
1072
+ ).data
1073
+
1074
+
1075
+ @validate_call
1076
+ def post_workflows_with_http_info(
1077
+ self,
1078
+ version: Annotated[StrictStr, Field(description="version")],
1079
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1080
+ workflow_create_request: Optional[WorkflowCreateRequest] = None,
1081
+ _request_timeout: Union[
1082
+ None,
1083
+ Annotated[StrictFloat, Field(gt=0)],
1084
+ Tuple[
1085
+ Annotated[StrictFloat, Field(gt=0)],
1086
+ Annotated[StrictFloat, Field(gt=0)]
1087
+ ]
1088
+ ] = None,
1089
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1090
+ _content_type: Optional[StrictStr] = None,
1091
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1092
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1093
+ ) -> ApiResponse[Workflow]:
1094
+ """Create a workflow
1095
+
1096
+ Creates a workflow definition. Set the target type, provide the corresponding configuration block, and use workflow triggers later to execute the workflow for a concrete resource instance. Requires the WORKFLOW.CREATE permission.
1097
+
1098
+ :param version: version (required)
1099
+ :type version: str
1100
+ :param x_platform_id: Platform ID.
1101
+ :type x_platform_id: str
1102
+ :param workflow_create_request:
1103
+ :type workflow_create_request: WorkflowCreateRequest
1104
+ :param _request_timeout: timeout setting for this request. If one
1105
+ number provided, it will be total request
1106
+ timeout. It can also be a pair (tuple) of
1107
+ (connection, read) timeouts.
1108
+ :type _request_timeout: int, tuple(int, int), optional
1109
+ :param _request_auth: set to override the auth_settings for an a single
1110
+ request; this effectively ignores the
1111
+ authentication in the spec for a single request.
1112
+ :type _request_auth: dict, optional
1113
+ :param _content_type: force content-type for the request.
1114
+ :type _content_type: str, Optional
1115
+ :param _headers: set to override the headers for a single
1116
+ request; this effectively ignores the headers
1117
+ in the spec for a single request.
1118
+ :type _headers: dict, optional
1119
+ :param _host_index: set to override the host_index for a single
1120
+ request; this effectively ignores the host_index
1121
+ in the spec for a single request.
1122
+ :type _host_index: int, optional
1123
+ :return: Returns the result object.
1124
+ """ # noqa: E501
1125
+
1126
+ _param = self._post_workflows_serialize(
1127
+ version=version,
1128
+ x_platform_id=x_platform_id,
1129
+ workflow_create_request=workflow_create_request,
1130
+ _request_auth=_request_auth,
1131
+ _content_type=_content_type,
1132
+ _headers=_headers,
1133
+ _host_index=_host_index
1134
+ )
1135
+
1136
+ _response_types_map: Dict[str, Optional[str]] = {
1137
+ '201': "Workflow",
1138
+ '401': "ApiError",
1139
+ '403': "ApiError",
1140
+ }
1141
+ response_data = self.api_client.call_api(
1142
+ *_param,
1143
+ _request_timeout=_request_timeout
1144
+ )
1145
+ response_data.read()
1146
+ return self.api_client.response_deserialize(
1147
+ response_data=response_data,
1148
+ response_types_map=_response_types_map,
1149
+ )
1150
+
1151
+
1152
+ @validate_call
1153
+ def post_workflows_without_preload_content(
1154
+ self,
1155
+ version: Annotated[StrictStr, Field(description="version")],
1156
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1157
+ workflow_create_request: Optional[WorkflowCreateRequest] = None,
1158
+ _request_timeout: Union[
1159
+ None,
1160
+ Annotated[StrictFloat, Field(gt=0)],
1161
+ Tuple[
1162
+ Annotated[StrictFloat, Field(gt=0)],
1163
+ Annotated[StrictFloat, Field(gt=0)]
1164
+ ]
1165
+ ] = None,
1166
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1167
+ _content_type: Optional[StrictStr] = None,
1168
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1169
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1170
+ ) -> RESTResponseType:
1171
+ """Create a workflow
1172
+
1173
+ Creates a workflow definition. Set the target type, provide the corresponding configuration block, and use workflow triggers later to execute the workflow for a concrete resource instance. Requires the WORKFLOW.CREATE permission.
1174
+
1175
+ :param version: version (required)
1176
+ :type version: str
1177
+ :param x_platform_id: Platform ID.
1178
+ :type x_platform_id: str
1179
+ :param workflow_create_request:
1180
+ :type workflow_create_request: WorkflowCreateRequest
1181
+ :param _request_timeout: timeout setting for this request. If one
1182
+ number provided, it will be total request
1183
+ timeout. It can also be a pair (tuple) of
1184
+ (connection, read) timeouts.
1185
+ :type _request_timeout: int, tuple(int, int), optional
1186
+ :param _request_auth: set to override the auth_settings for an a single
1187
+ request; this effectively ignores the
1188
+ authentication in the spec for a single request.
1189
+ :type _request_auth: dict, optional
1190
+ :param _content_type: force content-type for the request.
1191
+ :type _content_type: str, Optional
1192
+ :param _headers: set to override the headers for a single
1193
+ request; this effectively ignores the headers
1194
+ in the spec for a single request.
1195
+ :type _headers: dict, optional
1196
+ :param _host_index: set to override the host_index for a single
1197
+ request; this effectively ignores the host_index
1198
+ in the spec for a single request.
1199
+ :type _host_index: int, optional
1200
+ :return: Returns the result object.
1201
+ """ # noqa: E501
1202
+
1203
+ _param = self._post_workflows_serialize(
1204
+ version=version,
1205
+ x_platform_id=x_platform_id,
1206
+ workflow_create_request=workflow_create_request,
1207
+ _request_auth=_request_auth,
1208
+ _content_type=_content_type,
1209
+ _headers=_headers,
1210
+ _host_index=_host_index
1211
+ )
1212
+
1213
+ _response_types_map: Dict[str, Optional[str]] = {
1214
+ '201': "Workflow",
1215
+ '401': "ApiError",
1216
+ '403': "ApiError",
1217
+ }
1218
+ response_data = self.api_client.call_api(
1219
+ *_param,
1220
+ _request_timeout=_request_timeout
1221
+ )
1222
+ return response_data.response
1223
+
1224
+
1225
+ def _post_workflows_serialize(
1226
+ self,
1227
+ version,
1228
+ x_platform_id,
1229
+ workflow_create_request,
1230
+ _request_auth,
1231
+ _content_type,
1232
+ _headers,
1233
+ _host_index,
1234
+ ) -> RequestSerialized:
1235
+
1236
+ _host = None
1237
+
1238
+ _collection_formats: Dict[str, str] = {
1239
+ }
1240
+
1241
+ _path_params: Dict[str, str] = {}
1242
+ _query_params: List[Tuple[str, str]] = []
1243
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1244
+ _form_params: List[Tuple[str, str]] = []
1245
+ _files: Dict[
1246
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1247
+ ] = {}
1248
+ _body_params: Optional[bytes] = None
1249
+
1250
+ # process the path parameters
1251
+ if version is not None:
1252
+ _path_params['version'] = version
1253
+ # process the query parameters
1254
+ # process the header parameters
1255
+ if x_platform_id is not None:
1256
+ _header_params['x-platform-id'] = x_platform_id
1257
+ # process the form parameters
1258
+ # process the body parameter
1259
+ if workflow_create_request is not None:
1260
+ _body_params = workflow_create_request
1261
+
1262
+
1263
+ # set the HTTP header `Accept`
1264
+ if 'Accept' not in _header_params:
1265
+ _header_params['Accept'] = self.api_client.select_header_accept(
1266
+ [
1267
+ 'application/json',
1268
+ '*/*'
1269
+ ]
1270
+ )
1271
+
1272
+ # set the HTTP header `Content-Type`
1273
+ if _content_type:
1274
+ _header_params['Content-Type'] = _content_type
1275
+ else:
1276
+ _default_content_type = (
1277
+ self.api_client.select_header_content_type(
1278
+ [
1279
+ 'application/json'
1280
+ ]
1281
+ )
1282
+ )
1283
+ if _default_content_type is not None:
1284
+ _header_params['Content-Type'] = _default_content_type
1285
+
1286
+ # authentication setting
1287
+ _auth_settings: List[str] = [
1288
+ 'JWT-Authentication',
1289
+ 'API-Key'
1290
+ ]
1291
+
1292
+ return self.api_client.param_serialize(
1293
+ method='POST',
1294
+ resource_path='/v{version}/workflows',
1295
+ path_params=_path_params,
1296
+ query_params=_query_params,
1297
+ header_params=_header_params,
1298
+ body=_body_params,
1299
+ post_params=_form_params,
1300
+ files=_files,
1301
+ auth_settings=_auth_settings,
1302
+ collection_formats=_collection_formats,
1303
+ _host=_host,
1304
+ _request_auth=_request_auth
1305
+ )
1306
+
1307
+
1308
+
1309
+
1310
+ @validate_call
1311
+ def post_workflows_by_resource_id_or_reference_activate(
1312
+ self,
1313
+ version: Annotated[StrictStr, Field(description="version")],
1314
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1315
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1316
+ _request_timeout: Union[
1317
+ None,
1318
+ Annotated[StrictFloat, Field(gt=0)],
1319
+ Tuple[
1320
+ Annotated[StrictFloat, Field(gt=0)],
1321
+ Annotated[StrictFloat, Field(gt=0)]
1322
+ ]
1323
+ ] = None,
1324
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1325
+ _content_type: Optional[StrictStr] = None,
1326
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1327
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1328
+ ) -> Workflow:
1329
+ """Activate a workflow
1330
+
1331
+ Transitions a workflow to ACTIVE so it can be matched by workflow trigger creation. Requires the WORKFLOW.UPDATE permission.
1332
+
1333
+ :param version: version (required)
1334
+ :type version: str
1335
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1336
+ :type resource_id_or_reference: str
1337
+ :param x_platform_id: Platform ID.
1338
+ :type x_platform_id: str
1339
+ :param _request_timeout: timeout setting for this request. If one
1340
+ number provided, it will be total request
1341
+ timeout. It can also be a pair (tuple) of
1342
+ (connection, read) timeouts.
1343
+ :type _request_timeout: int, tuple(int, int), optional
1344
+ :param _request_auth: set to override the auth_settings for an a single
1345
+ request; this effectively ignores the
1346
+ authentication in the spec for a single request.
1347
+ :type _request_auth: dict, optional
1348
+ :param _content_type: force content-type for the request.
1349
+ :type _content_type: str, Optional
1350
+ :param _headers: set to override the headers for a single
1351
+ request; this effectively ignores the headers
1352
+ in the spec for a single request.
1353
+ :type _headers: dict, optional
1354
+ :param _host_index: set to override the host_index for a single
1355
+ request; this effectively ignores the host_index
1356
+ in the spec for a single request.
1357
+ :type _host_index: int, optional
1358
+ :return: Returns the result object.
1359
+ """ # noqa: E501
1360
+
1361
+ _param = self._post_workflows_by_resource_id_or_reference_activate_serialize(
1362
+ version=version,
1363
+ resource_id_or_reference=resource_id_or_reference,
1364
+ x_platform_id=x_platform_id,
1365
+ _request_auth=_request_auth,
1366
+ _content_type=_content_type,
1367
+ _headers=_headers,
1368
+ _host_index=_host_index
1369
+ )
1370
+
1371
+ _response_types_map: Dict[str, Optional[str]] = {
1372
+ '200': "Workflow",
1373
+ '401': "ApiError",
1374
+ '403': "ApiError",
1375
+ }
1376
+ response_data = self.api_client.call_api(
1377
+ *_param,
1378
+ _request_timeout=_request_timeout
1379
+ )
1380
+ response_data.read()
1381
+ return self.api_client.response_deserialize(
1382
+ response_data=response_data,
1383
+ response_types_map=_response_types_map,
1384
+ ).data
1385
+
1386
+
1387
+ @validate_call
1388
+ def post_workflows_by_resource_id_or_reference_activate_with_http_info(
1389
+ self,
1390
+ version: Annotated[StrictStr, Field(description="version")],
1391
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1392
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1393
+ _request_timeout: Union[
1394
+ None,
1395
+ Annotated[StrictFloat, Field(gt=0)],
1396
+ Tuple[
1397
+ Annotated[StrictFloat, Field(gt=0)],
1398
+ Annotated[StrictFloat, Field(gt=0)]
1399
+ ]
1400
+ ] = None,
1401
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1402
+ _content_type: Optional[StrictStr] = None,
1403
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1404
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1405
+ ) -> ApiResponse[Workflow]:
1406
+ """Activate a workflow
1407
+
1408
+ Transitions a workflow to ACTIVE so it can be matched by workflow trigger creation. Requires the WORKFLOW.UPDATE permission.
1409
+
1410
+ :param version: version (required)
1411
+ :type version: str
1412
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1413
+ :type resource_id_or_reference: str
1414
+ :param x_platform_id: Platform ID.
1415
+ :type x_platform_id: str
1416
+ :param _request_timeout: timeout setting for this request. If one
1417
+ number provided, it will be total request
1418
+ timeout. It can also be a pair (tuple) of
1419
+ (connection, read) timeouts.
1420
+ :type _request_timeout: int, tuple(int, int), optional
1421
+ :param _request_auth: set to override the auth_settings for an a single
1422
+ request; this effectively ignores the
1423
+ authentication in the spec for a single request.
1424
+ :type _request_auth: dict, optional
1425
+ :param _content_type: force content-type for the request.
1426
+ :type _content_type: str, Optional
1427
+ :param _headers: set to override the headers for a single
1428
+ request; this effectively ignores the headers
1429
+ in the spec for a single request.
1430
+ :type _headers: dict, optional
1431
+ :param _host_index: set to override the host_index for a single
1432
+ request; this effectively ignores the host_index
1433
+ in the spec for a single request.
1434
+ :type _host_index: int, optional
1435
+ :return: Returns the result object.
1436
+ """ # noqa: E501
1437
+
1438
+ _param = self._post_workflows_by_resource_id_or_reference_activate_serialize(
1439
+ version=version,
1440
+ resource_id_or_reference=resource_id_or_reference,
1441
+ x_platform_id=x_platform_id,
1442
+ _request_auth=_request_auth,
1443
+ _content_type=_content_type,
1444
+ _headers=_headers,
1445
+ _host_index=_host_index
1446
+ )
1447
+
1448
+ _response_types_map: Dict[str, Optional[str]] = {
1449
+ '200': "Workflow",
1450
+ '401': "ApiError",
1451
+ '403': "ApiError",
1452
+ }
1453
+ response_data = self.api_client.call_api(
1454
+ *_param,
1455
+ _request_timeout=_request_timeout
1456
+ )
1457
+ response_data.read()
1458
+ return self.api_client.response_deserialize(
1459
+ response_data=response_data,
1460
+ response_types_map=_response_types_map,
1461
+ )
1462
+
1463
+
1464
+ @validate_call
1465
+ def post_workflows_by_resource_id_or_reference_activate_without_preload_content(
1466
+ self,
1467
+ version: Annotated[StrictStr, Field(description="version")],
1468
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1469
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1470
+ _request_timeout: Union[
1471
+ None,
1472
+ Annotated[StrictFloat, Field(gt=0)],
1473
+ Tuple[
1474
+ Annotated[StrictFloat, Field(gt=0)],
1475
+ Annotated[StrictFloat, Field(gt=0)]
1476
+ ]
1477
+ ] = None,
1478
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1479
+ _content_type: Optional[StrictStr] = None,
1480
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1481
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1482
+ ) -> RESTResponseType:
1483
+ """Activate a workflow
1484
+
1485
+ Transitions a workflow to ACTIVE so it can be matched by workflow trigger creation. Requires the WORKFLOW.UPDATE permission.
1486
+
1487
+ :param version: version (required)
1488
+ :type version: str
1489
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1490
+ :type resource_id_or_reference: str
1491
+ :param x_platform_id: Platform ID.
1492
+ :type x_platform_id: str
1493
+ :param _request_timeout: timeout setting for this request. If one
1494
+ number provided, it will be total request
1495
+ timeout. It can also be a pair (tuple) of
1496
+ (connection, read) timeouts.
1497
+ :type _request_timeout: int, tuple(int, int), optional
1498
+ :param _request_auth: set to override the auth_settings for an a single
1499
+ request; this effectively ignores the
1500
+ authentication in the spec for a single request.
1501
+ :type _request_auth: dict, optional
1502
+ :param _content_type: force content-type for the request.
1503
+ :type _content_type: str, Optional
1504
+ :param _headers: set to override the headers for a single
1505
+ request; this effectively ignores the headers
1506
+ in the spec for a single request.
1507
+ :type _headers: dict, optional
1508
+ :param _host_index: set to override the host_index for a single
1509
+ request; this effectively ignores the host_index
1510
+ in the spec for a single request.
1511
+ :type _host_index: int, optional
1512
+ :return: Returns the result object.
1513
+ """ # noqa: E501
1514
+
1515
+ _param = self._post_workflows_by_resource_id_or_reference_activate_serialize(
1516
+ version=version,
1517
+ resource_id_or_reference=resource_id_or_reference,
1518
+ x_platform_id=x_platform_id,
1519
+ _request_auth=_request_auth,
1520
+ _content_type=_content_type,
1521
+ _headers=_headers,
1522
+ _host_index=_host_index
1523
+ )
1524
+
1525
+ _response_types_map: Dict[str, Optional[str]] = {
1526
+ '200': "Workflow",
1527
+ '401': "ApiError",
1528
+ '403': "ApiError",
1529
+ }
1530
+ response_data = self.api_client.call_api(
1531
+ *_param,
1532
+ _request_timeout=_request_timeout
1533
+ )
1534
+ return response_data.response
1535
+
1536
+
1537
+ def _post_workflows_by_resource_id_or_reference_activate_serialize(
1538
+ self,
1539
+ version,
1540
+ resource_id_or_reference,
1541
+ x_platform_id,
1542
+ _request_auth,
1543
+ _content_type,
1544
+ _headers,
1545
+ _host_index,
1546
+ ) -> RequestSerialized:
1547
+
1548
+ _host = None
1549
+
1550
+ _collection_formats: Dict[str, str] = {
1551
+ }
1552
+
1553
+ _path_params: Dict[str, str] = {}
1554
+ _query_params: List[Tuple[str, str]] = []
1555
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1556
+ _form_params: List[Tuple[str, str]] = []
1557
+ _files: Dict[
1558
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1559
+ ] = {}
1560
+ _body_params: Optional[bytes] = None
1561
+
1562
+ # process the path parameters
1563
+ if version is not None:
1564
+ _path_params['version'] = version
1565
+ if resource_id_or_reference is not None:
1566
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
1567
+ # process the query parameters
1568
+ # process the header parameters
1569
+ if x_platform_id is not None:
1570
+ _header_params['x-platform-id'] = x_platform_id
1571
+ # process the form parameters
1572
+ # process the body parameter
1573
+
1574
+
1575
+ # set the HTTP header `Accept`
1576
+ if 'Accept' not in _header_params:
1577
+ _header_params['Accept'] = self.api_client.select_header_accept(
1578
+ [
1579
+ 'application/json',
1580
+ '*/*'
1581
+ ]
1582
+ )
1583
+
1584
+
1585
+ # authentication setting
1586
+ _auth_settings: List[str] = [
1587
+ 'JWT-Authentication',
1588
+ 'API-Key'
1589
+ ]
1590
+
1591
+ return self.api_client.param_serialize(
1592
+ method='POST',
1593
+ resource_path='/v{version}/workflows/{resourceIdOrReference}/activate',
1594
+ path_params=_path_params,
1595
+ query_params=_query_params,
1596
+ header_params=_header_params,
1597
+ body=_body_params,
1598
+ post_params=_form_params,
1599
+ files=_files,
1600
+ auth_settings=_auth_settings,
1601
+ collection_formats=_collection_formats,
1602
+ _host=_host,
1603
+ _request_auth=_request_auth
1604
+ )
1605
+
1606
+
1607
+
1608
+
1609
+ @validate_call
1610
+ def post_workflows_by_resource_id_or_reference_archive(
1611
+ self,
1612
+ version: Annotated[StrictStr, Field(description="version")],
1613
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1614
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1615
+ _request_timeout: Union[
1616
+ None,
1617
+ Annotated[StrictFloat, Field(gt=0)],
1618
+ Tuple[
1619
+ Annotated[StrictFloat, Field(gt=0)],
1620
+ Annotated[StrictFloat, Field(gt=0)]
1621
+ ]
1622
+ ] = None,
1623
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1624
+ _content_type: Optional[StrictStr] = None,
1625
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1626
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1627
+ ) -> Workflow:
1628
+ """Archive a workflow
1629
+
1630
+ Transitions a workflow to ARCHIVED. Archived workflows cannot be updated again. Requires the WORKFLOW.UPDATE permission.
1631
+
1632
+ :param version: version (required)
1633
+ :type version: str
1634
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1635
+ :type resource_id_or_reference: str
1636
+ :param x_platform_id: Platform ID.
1637
+ :type x_platform_id: str
1638
+ :param _request_timeout: timeout setting for this request. If one
1639
+ number provided, it will be total request
1640
+ timeout. It can also be a pair (tuple) of
1641
+ (connection, read) timeouts.
1642
+ :type _request_timeout: int, tuple(int, int), optional
1643
+ :param _request_auth: set to override the auth_settings for an a single
1644
+ request; this effectively ignores the
1645
+ authentication in the spec for a single request.
1646
+ :type _request_auth: dict, optional
1647
+ :param _content_type: force content-type for the request.
1648
+ :type _content_type: str, Optional
1649
+ :param _headers: set to override the headers for a single
1650
+ request; this effectively ignores the headers
1651
+ in the spec for a single request.
1652
+ :type _headers: dict, optional
1653
+ :param _host_index: set to override the host_index for a single
1654
+ request; this effectively ignores the host_index
1655
+ in the spec for a single request.
1656
+ :type _host_index: int, optional
1657
+ :return: Returns the result object.
1658
+ """ # noqa: E501
1659
+
1660
+ _param = self._post_workflows_by_resource_id_or_reference_archive_serialize(
1661
+ version=version,
1662
+ resource_id_or_reference=resource_id_or_reference,
1663
+ x_platform_id=x_platform_id,
1664
+ _request_auth=_request_auth,
1665
+ _content_type=_content_type,
1666
+ _headers=_headers,
1667
+ _host_index=_host_index
1668
+ )
1669
+
1670
+ _response_types_map: Dict[str, Optional[str]] = {
1671
+ '200': "Workflow",
1672
+ '401': "ApiError",
1673
+ '403': "ApiError",
1674
+ }
1675
+ response_data = self.api_client.call_api(
1676
+ *_param,
1677
+ _request_timeout=_request_timeout
1678
+ )
1679
+ response_data.read()
1680
+ return self.api_client.response_deserialize(
1681
+ response_data=response_data,
1682
+ response_types_map=_response_types_map,
1683
+ ).data
1684
+
1685
+
1686
+ @validate_call
1687
+ def post_workflows_by_resource_id_or_reference_archive_with_http_info(
1688
+ self,
1689
+ version: Annotated[StrictStr, Field(description="version")],
1690
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1691
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1692
+ _request_timeout: Union[
1693
+ None,
1694
+ Annotated[StrictFloat, Field(gt=0)],
1695
+ Tuple[
1696
+ Annotated[StrictFloat, Field(gt=0)],
1697
+ Annotated[StrictFloat, Field(gt=0)]
1698
+ ]
1699
+ ] = None,
1700
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1701
+ _content_type: Optional[StrictStr] = None,
1702
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1703
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1704
+ ) -> ApiResponse[Workflow]:
1705
+ """Archive a workflow
1706
+
1707
+ Transitions a workflow to ARCHIVED. Archived workflows cannot be updated again. Requires the WORKFLOW.UPDATE permission.
1708
+
1709
+ :param version: version (required)
1710
+ :type version: str
1711
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1712
+ :type resource_id_or_reference: str
1713
+ :param x_platform_id: Platform ID.
1714
+ :type x_platform_id: str
1715
+ :param _request_timeout: timeout setting for this request. If one
1716
+ number provided, it will be total request
1717
+ timeout. It can also be a pair (tuple) of
1718
+ (connection, read) timeouts.
1719
+ :type _request_timeout: int, tuple(int, int), optional
1720
+ :param _request_auth: set to override the auth_settings for an a single
1721
+ request; this effectively ignores the
1722
+ authentication in the spec for a single request.
1723
+ :type _request_auth: dict, optional
1724
+ :param _content_type: force content-type for the request.
1725
+ :type _content_type: str, Optional
1726
+ :param _headers: set to override the headers for a single
1727
+ request; this effectively ignores the headers
1728
+ in the spec for a single request.
1729
+ :type _headers: dict, optional
1730
+ :param _host_index: set to override the host_index for a single
1731
+ request; this effectively ignores the host_index
1732
+ in the spec for a single request.
1733
+ :type _host_index: int, optional
1734
+ :return: Returns the result object.
1735
+ """ # noqa: E501
1736
+
1737
+ _param = self._post_workflows_by_resource_id_or_reference_archive_serialize(
1738
+ version=version,
1739
+ resource_id_or_reference=resource_id_or_reference,
1740
+ x_platform_id=x_platform_id,
1741
+ _request_auth=_request_auth,
1742
+ _content_type=_content_type,
1743
+ _headers=_headers,
1744
+ _host_index=_host_index
1745
+ )
1746
+
1747
+ _response_types_map: Dict[str, Optional[str]] = {
1748
+ '200': "Workflow",
1749
+ '401': "ApiError",
1750
+ '403': "ApiError",
1751
+ }
1752
+ response_data = self.api_client.call_api(
1753
+ *_param,
1754
+ _request_timeout=_request_timeout
1755
+ )
1756
+ response_data.read()
1757
+ return self.api_client.response_deserialize(
1758
+ response_data=response_data,
1759
+ response_types_map=_response_types_map,
1760
+ )
1761
+
1762
+
1763
+ @validate_call
1764
+ def post_workflows_by_resource_id_or_reference_archive_without_preload_content(
1765
+ self,
1766
+ version: Annotated[StrictStr, Field(description="version")],
1767
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1768
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1769
+ _request_timeout: Union[
1770
+ None,
1771
+ Annotated[StrictFloat, Field(gt=0)],
1772
+ Tuple[
1773
+ Annotated[StrictFloat, Field(gt=0)],
1774
+ Annotated[StrictFloat, Field(gt=0)]
1775
+ ]
1776
+ ] = None,
1777
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1778
+ _content_type: Optional[StrictStr] = None,
1779
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1780
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1781
+ ) -> RESTResponseType:
1782
+ """Archive a workflow
1783
+
1784
+ Transitions a workflow to ARCHIVED. Archived workflows cannot be updated again. Requires the WORKFLOW.UPDATE permission.
1785
+
1786
+ :param version: version (required)
1787
+ :type version: str
1788
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1789
+ :type resource_id_or_reference: str
1790
+ :param x_platform_id: Platform ID.
1791
+ :type x_platform_id: str
1792
+ :param _request_timeout: timeout setting for this request. If one
1793
+ number provided, it will be total request
1794
+ timeout. It can also be a pair (tuple) of
1795
+ (connection, read) timeouts.
1796
+ :type _request_timeout: int, tuple(int, int), optional
1797
+ :param _request_auth: set to override the auth_settings for an a single
1798
+ request; this effectively ignores the
1799
+ authentication in the spec for a single request.
1800
+ :type _request_auth: dict, optional
1801
+ :param _content_type: force content-type for the request.
1802
+ :type _content_type: str, Optional
1803
+ :param _headers: set to override the headers for a single
1804
+ request; this effectively ignores the headers
1805
+ in the spec for a single request.
1806
+ :type _headers: dict, optional
1807
+ :param _host_index: set to override the host_index for a single
1808
+ request; this effectively ignores the host_index
1809
+ in the spec for a single request.
1810
+ :type _host_index: int, optional
1811
+ :return: Returns the result object.
1812
+ """ # noqa: E501
1813
+
1814
+ _param = self._post_workflows_by_resource_id_or_reference_archive_serialize(
1815
+ version=version,
1816
+ resource_id_or_reference=resource_id_or_reference,
1817
+ x_platform_id=x_platform_id,
1818
+ _request_auth=_request_auth,
1819
+ _content_type=_content_type,
1820
+ _headers=_headers,
1821
+ _host_index=_host_index
1822
+ )
1823
+
1824
+ _response_types_map: Dict[str, Optional[str]] = {
1825
+ '200': "Workflow",
1826
+ '401': "ApiError",
1827
+ '403': "ApiError",
1828
+ }
1829
+ response_data = self.api_client.call_api(
1830
+ *_param,
1831
+ _request_timeout=_request_timeout
1832
+ )
1833
+ return response_data.response
1834
+
1835
+
1836
+ def _post_workflows_by_resource_id_or_reference_archive_serialize(
1837
+ self,
1838
+ version,
1839
+ resource_id_or_reference,
1840
+ x_platform_id,
1841
+ _request_auth,
1842
+ _content_type,
1843
+ _headers,
1844
+ _host_index,
1845
+ ) -> RequestSerialized:
1846
+
1847
+ _host = None
1848
+
1849
+ _collection_formats: Dict[str, str] = {
1850
+ }
1851
+
1852
+ _path_params: Dict[str, str] = {}
1853
+ _query_params: List[Tuple[str, str]] = []
1854
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1855
+ _form_params: List[Tuple[str, str]] = []
1856
+ _files: Dict[
1857
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1858
+ ] = {}
1859
+ _body_params: Optional[bytes] = None
1860
+
1861
+ # process the path parameters
1862
+ if version is not None:
1863
+ _path_params['version'] = version
1864
+ if resource_id_or_reference is not None:
1865
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
1866
+ # process the query parameters
1867
+ # process the header parameters
1868
+ if x_platform_id is not None:
1869
+ _header_params['x-platform-id'] = x_platform_id
1870
+ # process the form parameters
1871
+ # process the body parameter
1872
+
1873
+
1874
+ # set the HTTP header `Accept`
1875
+ if 'Accept' not in _header_params:
1876
+ _header_params['Accept'] = self.api_client.select_header_accept(
1877
+ [
1878
+ 'application/json',
1879
+ '*/*'
1880
+ ]
1881
+ )
1882
+
1883
+
1884
+ # authentication setting
1885
+ _auth_settings: List[str] = [
1886
+ 'JWT-Authentication',
1887
+ 'API-Key'
1888
+ ]
1889
+
1890
+ return self.api_client.param_serialize(
1891
+ method='POST',
1892
+ resource_path='/v{version}/workflows/{resourceIdOrReference}/archive',
1893
+ path_params=_path_params,
1894
+ query_params=_query_params,
1895
+ header_params=_header_params,
1896
+ body=_body_params,
1897
+ post_params=_form_params,
1898
+ files=_files,
1899
+ auth_settings=_auth_settings,
1900
+ collection_formats=_collection_formats,
1901
+ _host=_host,
1902
+ _request_auth=_request_auth
1903
+ )
1904
+
1905
+
1906
+
1907
+
1908
+ @validate_call
1909
+ def post_workflows_by_resource_id_or_reference_deactivate(
1910
+ self,
1911
+ version: Annotated[StrictStr, Field(description="version")],
1912
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1913
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1914
+ _request_timeout: Union[
1915
+ None,
1916
+ Annotated[StrictFloat, Field(gt=0)],
1917
+ Tuple[
1918
+ Annotated[StrictFloat, Field(gt=0)],
1919
+ Annotated[StrictFloat, Field(gt=0)]
1920
+ ]
1921
+ ] = None,
1922
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1923
+ _content_type: Optional[StrictStr] = None,
1924
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1925
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1926
+ ) -> Workflow:
1927
+ """Deactivate a workflow
1928
+
1929
+ Transitions a workflow to INACTIVE. so it's stops matching and executing the workflow without archiving it. Requires the WORKFLOW.UPDATE permission.
1930
+
1931
+ :param version: version (required)
1932
+ :type version: str
1933
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
1934
+ :type resource_id_or_reference: str
1935
+ :param x_platform_id: Platform ID.
1936
+ :type x_platform_id: str
1937
+ :param _request_timeout: timeout setting for this request. If one
1938
+ number provided, it will be total request
1939
+ timeout. It can also be a pair (tuple) of
1940
+ (connection, read) timeouts.
1941
+ :type _request_timeout: int, tuple(int, int), optional
1942
+ :param _request_auth: set to override the auth_settings for an a single
1943
+ request; this effectively ignores the
1944
+ authentication in the spec for a single request.
1945
+ :type _request_auth: dict, optional
1946
+ :param _content_type: force content-type for the request.
1947
+ :type _content_type: str, Optional
1948
+ :param _headers: set to override the headers for a single
1949
+ request; this effectively ignores the headers
1950
+ in the spec for a single request.
1951
+ :type _headers: dict, optional
1952
+ :param _host_index: set to override the host_index for a single
1953
+ request; this effectively ignores the host_index
1954
+ in the spec for a single request.
1955
+ :type _host_index: int, optional
1956
+ :return: Returns the result object.
1957
+ """ # noqa: E501
1958
+
1959
+ _param = self._post_workflows_by_resource_id_or_reference_deactivate_serialize(
1960
+ version=version,
1961
+ resource_id_or_reference=resource_id_or_reference,
1962
+ x_platform_id=x_platform_id,
1963
+ _request_auth=_request_auth,
1964
+ _content_type=_content_type,
1965
+ _headers=_headers,
1966
+ _host_index=_host_index
1967
+ )
1968
+
1969
+ _response_types_map: Dict[str, Optional[str]] = {
1970
+ '200': "Workflow",
1971
+ '401': "ApiError",
1972
+ '403': "ApiError",
1973
+ }
1974
+ response_data = self.api_client.call_api(
1975
+ *_param,
1976
+ _request_timeout=_request_timeout
1977
+ )
1978
+ response_data.read()
1979
+ return self.api_client.response_deserialize(
1980
+ response_data=response_data,
1981
+ response_types_map=_response_types_map,
1982
+ ).data
1983
+
1984
+
1985
+ @validate_call
1986
+ def post_workflows_by_resource_id_or_reference_deactivate_with_http_info(
1987
+ self,
1988
+ version: Annotated[StrictStr, Field(description="version")],
1989
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
1990
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1991
+ _request_timeout: Union[
1992
+ None,
1993
+ Annotated[StrictFloat, Field(gt=0)],
1994
+ Tuple[
1995
+ Annotated[StrictFloat, Field(gt=0)],
1996
+ Annotated[StrictFloat, Field(gt=0)]
1997
+ ]
1998
+ ] = None,
1999
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2000
+ _content_type: Optional[StrictStr] = None,
2001
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2002
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2003
+ ) -> ApiResponse[Workflow]:
2004
+ """Deactivate a workflow
2005
+
2006
+ Transitions a workflow to INACTIVE. so it's stops matching and executing the workflow without archiving it. Requires the WORKFLOW.UPDATE permission.
2007
+
2008
+ :param version: version (required)
2009
+ :type version: str
2010
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
2011
+ :type resource_id_or_reference: str
2012
+ :param x_platform_id: Platform ID.
2013
+ :type x_platform_id: str
2014
+ :param _request_timeout: timeout setting for this request. If one
2015
+ number provided, it will be total request
2016
+ timeout. It can also be a pair (tuple) of
2017
+ (connection, read) timeouts.
2018
+ :type _request_timeout: int, tuple(int, int), optional
2019
+ :param _request_auth: set to override the auth_settings for an a single
2020
+ request; this effectively ignores the
2021
+ authentication in the spec for a single request.
2022
+ :type _request_auth: dict, optional
2023
+ :param _content_type: force content-type for the request.
2024
+ :type _content_type: str, Optional
2025
+ :param _headers: set to override the headers for a single
2026
+ request; this effectively ignores the headers
2027
+ in the spec for a single request.
2028
+ :type _headers: dict, optional
2029
+ :param _host_index: set to override the host_index for a single
2030
+ request; this effectively ignores the host_index
2031
+ in the spec for a single request.
2032
+ :type _host_index: int, optional
2033
+ :return: Returns the result object.
2034
+ """ # noqa: E501
2035
+
2036
+ _param = self._post_workflows_by_resource_id_or_reference_deactivate_serialize(
2037
+ version=version,
2038
+ resource_id_or_reference=resource_id_or_reference,
2039
+ x_platform_id=x_platform_id,
2040
+ _request_auth=_request_auth,
2041
+ _content_type=_content_type,
2042
+ _headers=_headers,
2043
+ _host_index=_host_index
2044
+ )
2045
+
2046
+ _response_types_map: Dict[str, Optional[str]] = {
2047
+ '200': "Workflow",
2048
+ '401': "ApiError",
2049
+ '403': "ApiError",
2050
+ }
2051
+ response_data = self.api_client.call_api(
2052
+ *_param,
2053
+ _request_timeout=_request_timeout
2054
+ )
2055
+ response_data.read()
2056
+ return self.api_client.response_deserialize(
2057
+ response_data=response_data,
2058
+ response_types_map=_response_types_map,
2059
+ )
2060
+
2061
+
2062
+ @validate_call
2063
+ def post_workflows_by_resource_id_or_reference_deactivate_without_preload_content(
2064
+ self,
2065
+ version: Annotated[StrictStr, Field(description="version")],
2066
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
2067
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2068
+ _request_timeout: Union[
2069
+ None,
2070
+ Annotated[StrictFloat, Field(gt=0)],
2071
+ Tuple[
2072
+ Annotated[StrictFloat, Field(gt=0)],
2073
+ Annotated[StrictFloat, Field(gt=0)]
2074
+ ]
2075
+ ] = None,
2076
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2077
+ _content_type: Optional[StrictStr] = None,
2078
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2079
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2080
+ ) -> RESTResponseType:
2081
+ """Deactivate a workflow
2082
+
2083
+ Transitions a workflow to INACTIVE. so it's stops matching and executing the workflow without archiving it. Requires the WORKFLOW.UPDATE permission.
2084
+
2085
+ :param version: version (required)
2086
+ :type version: str
2087
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
2088
+ :type resource_id_or_reference: str
2089
+ :param x_platform_id: Platform ID.
2090
+ :type x_platform_id: str
2091
+ :param _request_timeout: timeout setting for this request. If one
2092
+ number provided, it will be total request
2093
+ timeout. It can also be a pair (tuple) of
2094
+ (connection, read) timeouts.
2095
+ :type _request_timeout: int, tuple(int, int), optional
2096
+ :param _request_auth: set to override the auth_settings for an a single
2097
+ request; this effectively ignores the
2098
+ authentication in the spec for a single request.
2099
+ :type _request_auth: dict, optional
2100
+ :param _content_type: force content-type for the request.
2101
+ :type _content_type: str, Optional
2102
+ :param _headers: set to override the headers for a single
2103
+ request; this effectively ignores the headers
2104
+ in the spec for a single request.
2105
+ :type _headers: dict, optional
2106
+ :param _host_index: set to override the host_index for a single
2107
+ request; this effectively ignores the host_index
2108
+ in the spec for a single request.
2109
+ :type _host_index: int, optional
2110
+ :return: Returns the result object.
2111
+ """ # noqa: E501
2112
+
2113
+ _param = self._post_workflows_by_resource_id_or_reference_deactivate_serialize(
2114
+ version=version,
2115
+ resource_id_or_reference=resource_id_or_reference,
2116
+ x_platform_id=x_platform_id,
2117
+ _request_auth=_request_auth,
2118
+ _content_type=_content_type,
2119
+ _headers=_headers,
2120
+ _host_index=_host_index
2121
+ )
2122
+
2123
+ _response_types_map: Dict[str, Optional[str]] = {
2124
+ '200': "Workflow",
2125
+ '401': "ApiError",
2126
+ '403': "ApiError",
2127
+ }
2128
+ response_data = self.api_client.call_api(
2129
+ *_param,
2130
+ _request_timeout=_request_timeout
2131
+ )
2132
+ return response_data.response
2133
+
2134
+
2135
+ def _post_workflows_by_resource_id_or_reference_deactivate_serialize(
2136
+ self,
2137
+ version,
2138
+ resource_id_or_reference,
2139
+ x_platform_id,
2140
+ _request_auth,
2141
+ _content_type,
2142
+ _headers,
2143
+ _host_index,
2144
+ ) -> RequestSerialized:
2145
+
2146
+ _host = None
2147
+
2148
+ _collection_formats: Dict[str, str] = {
2149
+ }
2150
+
2151
+ _path_params: Dict[str, str] = {}
2152
+ _query_params: List[Tuple[str, str]] = []
2153
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2154
+ _form_params: List[Tuple[str, str]] = []
2155
+ _files: Dict[
2156
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2157
+ ] = {}
2158
+ _body_params: Optional[bytes] = None
2159
+
2160
+ # process the path parameters
2161
+ if version is not None:
2162
+ _path_params['version'] = version
2163
+ if resource_id_or_reference is not None:
2164
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
2165
+ # process the query parameters
2166
+ # process the header parameters
2167
+ if x_platform_id is not None:
2168
+ _header_params['x-platform-id'] = x_platform_id
2169
+ # process the form parameters
2170
+ # process the body parameter
2171
+
2172
+
2173
+ # set the HTTP header `Accept`
2174
+ if 'Accept' not in _header_params:
2175
+ _header_params['Accept'] = self.api_client.select_header_accept(
2176
+ [
2177
+ 'application/json',
2178
+ '*/*'
2179
+ ]
2180
+ )
2181
+
2182
+
2183
+ # authentication setting
2184
+ _auth_settings: List[str] = [
2185
+ 'JWT-Authentication',
2186
+ 'API-Key'
2187
+ ]
2188
+
2189
+ return self.api_client.param_serialize(
2190
+ method='POST',
2191
+ resource_path='/v{version}/workflows/{resourceIdOrReference}/deactivate',
2192
+ path_params=_path_params,
2193
+ query_params=_query_params,
2194
+ header_params=_header_params,
2195
+ body=_body_params,
2196
+ post_params=_form_params,
2197
+ files=_files,
2198
+ auth_settings=_auth_settings,
2199
+ collection_formats=_collection_formats,
2200
+ _host=_host,
2201
+ _request_auth=_request_auth
2202
+ )
2203
+
2204
+
2205
+
2206
+
2207
+ @validate_call
2208
+ def post_workflows_init(
2209
+ self,
2210
+ version: Annotated[StrictStr, Field(description="version")],
2211
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2212
+ workflow_init_create_request: Optional[WorkflowInitCreateRequest] = None,
2213
+ _request_timeout: Union[
2214
+ None,
2215
+ Annotated[StrictFloat, Field(gt=0)],
2216
+ Tuple[
2217
+ Annotated[StrictFloat, Field(gt=0)],
2218
+ Annotated[StrictFloat, Field(gt=0)]
2219
+ ]
2220
+ ] = None,
2221
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2222
+ _content_type: Optional[StrictStr] = None,
2223
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2224
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2225
+ ) -> WorkflowInit:
2226
+ """Initialise a workflow
2227
+
2228
+ Ensures a workflow and its actions exist. The workflow is matched by its reference; when it already exists it and its actions are left untouched. Returns the composed workflow with its actions. Requires the WORKFLOW.CREATE permission.
2229
+
2230
+ :param version: version (required)
2231
+ :type version: str
2232
+ :param x_platform_id: Platform ID.
2233
+ :type x_platform_id: str
2234
+ :param workflow_init_create_request:
2235
+ :type workflow_init_create_request: WorkflowInitCreateRequest
2236
+ :param _request_timeout: timeout setting for this request. If one
2237
+ number provided, it will be total request
2238
+ timeout. It can also be a pair (tuple) of
2239
+ (connection, read) timeouts.
2240
+ :type _request_timeout: int, tuple(int, int), optional
2241
+ :param _request_auth: set to override the auth_settings for an a single
2242
+ request; this effectively ignores the
2243
+ authentication in the spec for a single request.
2244
+ :type _request_auth: dict, optional
2245
+ :param _content_type: force content-type for the request.
2246
+ :type _content_type: str, Optional
2247
+ :param _headers: set to override the headers for a single
2248
+ request; this effectively ignores the headers
2249
+ in the spec for a single request.
2250
+ :type _headers: dict, optional
2251
+ :param _host_index: set to override the host_index for a single
2252
+ request; this effectively ignores the host_index
2253
+ in the spec for a single request.
2254
+ :type _host_index: int, optional
2255
+ :return: Returns the result object.
2256
+ """ # noqa: E501
2257
+
2258
+ _param = self._post_workflows_init_serialize(
2259
+ version=version,
2260
+ x_platform_id=x_platform_id,
2261
+ workflow_init_create_request=workflow_init_create_request,
2262
+ _request_auth=_request_auth,
2263
+ _content_type=_content_type,
2264
+ _headers=_headers,
2265
+ _host_index=_host_index
2266
+ )
2267
+
2268
+ _response_types_map: Dict[str, Optional[str]] = {
2269
+ '200': "WorkflowInit",
2270
+ '401': "ApiError",
2271
+ '403': "ApiError",
2272
+ }
2273
+ response_data = self.api_client.call_api(
2274
+ *_param,
2275
+ _request_timeout=_request_timeout
2276
+ )
2277
+ response_data.read()
2278
+ return self.api_client.response_deserialize(
2279
+ response_data=response_data,
2280
+ response_types_map=_response_types_map,
2281
+ ).data
2282
+
2283
+
2284
+ @validate_call
2285
+ def post_workflows_init_with_http_info(
2286
+ self,
2287
+ version: Annotated[StrictStr, Field(description="version")],
2288
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2289
+ workflow_init_create_request: Optional[WorkflowInitCreateRequest] = None,
2290
+ _request_timeout: Union[
2291
+ None,
2292
+ Annotated[StrictFloat, Field(gt=0)],
2293
+ Tuple[
2294
+ Annotated[StrictFloat, Field(gt=0)],
2295
+ Annotated[StrictFloat, Field(gt=0)]
2296
+ ]
2297
+ ] = None,
2298
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2299
+ _content_type: Optional[StrictStr] = None,
2300
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2301
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2302
+ ) -> ApiResponse[WorkflowInit]:
2303
+ """Initialise a workflow
2304
+
2305
+ Ensures a workflow and its actions exist. The workflow is matched by its reference; when it already exists it and its actions are left untouched. Returns the composed workflow with its actions. Requires the WORKFLOW.CREATE permission.
2306
+
2307
+ :param version: version (required)
2308
+ :type version: str
2309
+ :param x_platform_id: Platform ID.
2310
+ :type x_platform_id: str
2311
+ :param workflow_init_create_request:
2312
+ :type workflow_init_create_request: WorkflowInitCreateRequest
2313
+ :param _request_timeout: timeout setting for this request. If one
2314
+ number provided, it will be total request
2315
+ timeout. It can also be a pair (tuple) of
2316
+ (connection, read) timeouts.
2317
+ :type _request_timeout: int, tuple(int, int), optional
2318
+ :param _request_auth: set to override the auth_settings for an a single
2319
+ request; this effectively ignores the
2320
+ authentication in the spec for a single request.
2321
+ :type _request_auth: dict, optional
2322
+ :param _content_type: force content-type for the request.
2323
+ :type _content_type: str, Optional
2324
+ :param _headers: set to override the headers for a single
2325
+ request; this effectively ignores the headers
2326
+ in the spec for a single request.
2327
+ :type _headers: dict, optional
2328
+ :param _host_index: set to override the host_index for a single
2329
+ request; this effectively ignores the host_index
2330
+ in the spec for a single request.
2331
+ :type _host_index: int, optional
2332
+ :return: Returns the result object.
2333
+ """ # noqa: E501
2334
+
2335
+ _param = self._post_workflows_init_serialize(
2336
+ version=version,
2337
+ x_platform_id=x_platform_id,
2338
+ workflow_init_create_request=workflow_init_create_request,
2339
+ _request_auth=_request_auth,
2340
+ _content_type=_content_type,
2341
+ _headers=_headers,
2342
+ _host_index=_host_index
2343
+ )
2344
+
2345
+ _response_types_map: Dict[str, Optional[str]] = {
2346
+ '200': "WorkflowInit",
2347
+ '401': "ApiError",
2348
+ '403': "ApiError",
2349
+ }
2350
+ response_data = self.api_client.call_api(
2351
+ *_param,
2352
+ _request_timeout=_request_timeout
2353
+ )
2354
+ response_data.read()
2355
+ return self.api_client.response_deserialize(
2356
+ response_data=response_data,
2357
+ response_types_map=_response_types_map,
2358
+ )
2359
+
2360
+
2361
+ @validate_call
2362
+ def post_workflows_init_without_preload_content(
2363
+ self,
2364
+ version: Annotated[StrictStr, Field(description="version")],
2365
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2366
+ workflow_init_create_request: Optional[WorkflowInitCreateRequest] = None,
2367
+ _request_timeout: Union[
2368
+ None,
2369
+ Annotated[StrictFloat, Field(gt=0)],
2370
+ Tuple[
2371
+ Annotated[StrictFloat, Field(gt=0)],
2372
+ Annotated[StrictFloat, Field(gt=0)]
2373
+ ]
2374
+ ] = None,
2375
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2376
+ _content_type: Optional[StrictStr] = None,
2377
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2378
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2379
+ ) -> RESTResponseType:
2380
+ """Initialise a workflow
2381
+
2382
+ Ensures a workflow and its actions exist. The workflow is matched by its reference; when it already exists it and its actions are left untouched. Returns the composed workflow with its actions. Requires the WORKFLOW.CREATE permission.
2383
+
2384
+ :param version: version (required)
2385
+ :type version: str
2386
+ :param x_platform_id: Platform ID.
2387
+ :type x_platform_id: str
2388
+ :param workflow_init_create_request:
2389
+ :type workflow_init_create_request: WorkflowInitCreateRequest
2390
+ :param _request_timeout: timeout setting for this request. If one
2391
+ number provided, it will be total request
2392
+ timeout. It can also be a pair (tuple) of
2393
+ (connection, read) timeouts.
2394
+ :type _request_timeout: int, tuple(int, int), optional
2395
+ :param _request_auth: set to override the auth_settings for an a single
2396
+ request; this effectively ignores the
2397
+ authentication in the spec for a single request.
2398
+ :type _request_auth: dict, optional
2399
+ :param _content_type: force content-type for the request.
2400
+ :type _content_type: str, Optional
2401
+ :param _headers: set to override the headers for a single
2402
+ request; this effectively ignores the headers
2403
+ in the spec for a single request.
2404
+ :type _headers: dict, optional
2405
+ :param _host_index: set to override the host_index for a single
2406
+ request; this effectively ignores the host_index
2407
+ in the spec for a single request.
2408
+ :type _host_index: int, optional
2409
+ :return: Returns the result object.
2410
+ """ # noqa: E501
2411
+
2412
+ _param = self._post_workflows_init_serialize(
2413
+ version=version,
2414
+ x_platform_id=x_platform_id,
2415
+ workflow_init_create_request=workflow_init_create_request,
2416
+ _request_auth=_request_auth,
2417
+ _content_type=_content_type,
2418
+ _headers=_headers,
2419
+ _host_index=_host_index
2420
+ )
2421
+
2422
+ _response_types_map: Dict[str, Optional[str]] = {
2423
+ '200': "WorkflowInit",
2424
+ '401': "ApiError",
2425
+ '403': "ApiError",
2426
+ }
2427
+ response_data = self.api_client.call_api(
2428
+ *_param,
2429
+ _request_timeout=_request_timeout
2430
+ )
2431
+ return response_data.response
2432
+
2433
+
2434
+ def _post_workflows_init_serialize(
2435
+ self,
2436
+ version,
2437
+ x_platform_id,
2438
+ workflow_init_create_request,
2439
+ _request_auth,
2440
+ _content_type,
2441
+ _headers,
2442
+ _host_index,
2443
+ ) -> RequestSerialized:
2444
+
2445
+ _host = None
2446
+
2447
+ _collection_formats: Dict[str, str] = {
2448
+ }
2449
+
2450
+ _path_params: Dict[str, str] = {}
2451
+ _query_params: List[Tuple[str, str]] = []
2452
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2453
+ _form_params: List[Tuple[str, str]] = []
2454
+ _files: Dict[
2455
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2456
+ ] = {}
2457
+ _body_params: Optional[bytes] = None
2458
+
2459
+ # process the path parameters
2460
+ if version is not None:
2461
+ _path_params['version'] = version
2462
+ # process the query parameters
2463
+ # process the header parameters
2464
+ if x_platform_id is not None:
2465
+ _header_params['x-platform-id'] = x_platform_id
2466
+ # process the form parameters
2467
+ # process the body parameter
2468
+ if workflow_init_create_request is not None:
2469
+ _body_params = workflow_init_create_request
2470
+
2471
+
2472
+ # set the HTTP header `Accept`
2473
+ if 'Accept' not in _header_params:
2474
+ _header_params['Accept'] = self.api_client.select_header_accept(
2475
+ [
2476
+ 'application/json',
2477
+ '*/*'
2478
+ ]
2479
+ )
2480
+
2481
+ # set the HTTP header `Content-Type`
2482
+ if _content_type:
2483
+ _header_params['Content-Type'] = _content_type
2484
+ else:
2485
+ _default_content_type = (
2486
+ self.api_client.select_header_content_type(
2487
+ [
2488
+ 'application/json'
2489
+ ]
2490
+ )
2491
+ )
2492
+ if _default_content_type is not None:
2493
+ _header_params['Content-Type'] = _default_content_type
2494
+
2495
+ # authentication setting
2496
+ _auth_settings: List[str] = [
2497
+ 'JWT-Authentication',
2498
+ 'API-Key'
2499
+ ]
2500
+
2501
+ return self.api_client.param_serialize(
2502
+ method='POST',
2503
+ resource_path='/v{version}/workflows/init',
2504
+ path_params=_path_params,
2505
+ query_params=_query_params,
2506
+ header_params=_header_params,
2507
+ body=_body_params,
2508
+ post_params=_form_params,
2509
+ files=_files,
2510
+ auth_settings=_auth_settings,
2511
+ collection_formats=_collection_formats,
2512
+ _host=_host,
2513
+ _request_auth=_request_auth
2514
+ )
2515
+
2516
+
2517
+
2518
+
2519
+ @validate_call
2520
+ def post_workflows_search(
2521
+ self,
2522
+ version: Annotated[StrictStr, Field(description="version")],
2523
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2524
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
2525
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2526
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2527
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2528
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2529
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.")] = None,
2530
+ search_create_request: Optional[SearchCreateRequest] = None,
2531
+ _request_timeout: Union[
2532
+ None,
2533
+ Annotated[StrictFloat, Field(gt=0)],
2534
+ Tuple[
2535
+ Annotated[StrictFloat, Field(gt=0)],
2536
+ Annotated[StrictFloat, Field(gt=0)]
2537
+ ]
2538
+ ] = None,
2539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2540
+ _content_type: Optional[StrictStr] = None,
2541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2543
+ ) -> WorkflowPaginatedResponse:
2544
+ """Search workflows
2545
+
2546
+ Searches workflow definitions with the provided search body and optional query filters. Requires the WORKFLOW.VIEW permission.
2547
+
2548
+ :param version: version (required)
2549
+ :type version: str
2550
+ :param x_platform_id: Platform ID.
2551
+ :type x_platform_id: str
2552
+ :param expand: The id fields of the resources that are going to be expanded.
2553
+ :type expand: List[str]
2554
+ :param limit: The amount of records shown in the list
2555
+ :type limit: int
2556
+ :param page: The page which is going to be shown
2557
+ :type page: int
2558
+ :param order_by: The parameter by which the response is ordered.
2559
+ :type order_by: str
2560
+ :param order_direction: The order direction by which the response is ordered.
2561
+ :type order_direction: str
2562
+ :param statuses: Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.
2563
+ :type statuses: List[str]
2564
+ :param search_create_request:
2565
+ :type search_create_request: SearchCreateRequest
2566
+ :param _request_timeout: timeout setting for this request. If one
2567
+ number provided, it will be total request
2568
+ timeout. It can also be a pair (tuple) of
2569
+ (connection, read) timeouts.
2570
+ :type _request_timeout: int, tuple(int, int), optional
2571
+ :param _request_auth: set to override the auth_settings for an a single
2572
+ request; this effectively ignores the
2573
+ authentication in the spec for a single request.
2574
+ :type _request_auth: dict, optional
2575
+ :param _content_type: force content-type for the request.
2576
+ :type _content_type: str, Optional
2577
+ :param _headers: set to override the headers for a single
2578
+ request; this effectively ignores the headers
2579
+ in the spec for a single request.
2580
+ :type _headers: dict, optional
2581
+ :param _host_index: set to override the host_index for a single
2582
+ request; this effectively ignores the host_index
2583
+ in the spec for a single request.
2584
+ :type _host_index: int, optional
2585
+ :return: Returns the result object.
2586
+ """ # noqa: E501
2587
+
2588
+ _param = self._post_workflows_search_serialize(
2589
+ version=version,
2590
+ x_platform_id=x_platform_id,
2591
+ expand=expand,
2592
+ limit=limit,
2593
+ page=page,
2594
+ order_by=order_by,
2595
+ order_direction=order_direction,
2596
+ statuses=statuses,
2597
+ search_create_request=search_create_request,
2598
+ _request_auth=_request_auth,
2599
+ _content_type=_content_type,
2600
+ _headers=_headers,
2601
+ _host_index=_host_index
2602
+ )
2603
+
2604
+ _response_types_map: Dict[str, Optional[str]] = {
2605
+ '200': "WorkflowPaginatedResponse",
2606
+ '401': "ApiError",
2607
+ '403': "ApiError",
2608
+ }
2609
+ response_data = self.api_client.call_api(
2610
+ *_param,
2611
+ _request_timeout=_request_timeout
2612
+ )
2613
+ response_data.read()
2614
+ return self.api_client.response_deserialize(
2615
+ response_data=response_data,
2616
+ response_types_map=_response_types_map,
2617
+ ).data
2618
+
2619
+
2620
+ @validate_call
2621
+ def post_workflows_search_with_http_info(
2622
+ self,
2623
+ version: Annotated[StrictStr, Field(description="version")],
2624
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2625
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
2626
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2627
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2628
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2629
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2630
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.")] = None,
2631
+ search_create_request: Optional[SearchCreateRequest] = None,
2632
+ _request_timeout: Union[
2633
+ None,
2634
+ Annotated[StrictFloat, Field(gt=0)],
2635
+ Tuple[
2636
+ Annotated[StrictFloat, Field(gt=0)],
2637
+ Annotated[StrictFloat, Field(gt=0)]
2638
+ ]
2639
+ ] = None,
2640
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2641
+ _content_type: Optional[StrictStr] = None,
2642
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2643
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2644
+ ) -> ApiResponse[WorkflowPaginatedResponse]:
2645
+ """Search workflows
2646
+
2647
+ Searches workflow definitions with the provided search body and optional query filters. Requires the WORKFLOW.VIEW permission.
2648
+
2649
+ :param version: version (required)
2650
+ :type version: str
2651
+ :param x_platform_id: Platform ID.
2652
+ :type x_platform_id: str
2653
+ :param expand: The id fields of the resources that are going to be expanded.
2654
+ :type expand: List[str]
2655
+ :param limit: The amount of records shown in the list
2656
+ :type limit: int
2657
+ :param page: The page which is going to be shown
2658
+ :type page: int
2659
+ :param order_by: The parameter by which the response is ordered.
2660
+ :type order_by: str
2661
+ :param order_direction: The order direction by which the response is ordered.
2662
+ :type order_direction: str
2663
+ :param statuses: Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.
2664
+ :type statuses: List[str]
2665
+ :param search_create_request:
2666
+ :type search_create_request: SearchCreateRequest
2667
+ :param _request_timeout: timeout setting for this request. If one
2668
+ number provided, it will be total request
2669
+ timeout. It can also be a pair (tuple) of
2670
+ (connection, read) timeouts.
2671
+ :type _request_timeout: int, tuple(int, int), optional
2672
+ :param _request_auth: set to override the auth_settings for an a single
2673
+ request; this effectively ignores the
2674
+ authentication in the spec for a single request.
2675
+ :type _request_auth: dict, optional
2676
+ :param _content_type: force content-type for the request.
2677
+ :type _content_type: str, Optional
2678
+ :param _headers: set to override the headers for a single
2679
+ request; this effectively ignores the headers
2680
+ in the spec for a single request.
2681
+ :type _headers: dict, optional
2682
+ :param _host_index: set to override the host_index for a single
2683
+ request; this effectively ignores the host_index
2684
+ in the spec for a single request.
2685
+ :type _host_index: int, optional
2686
+ :return: Returns the result object.
2687
+ """ # noqa: E501
2688
+
2689
+ _param = self._post_workflows_search_serialize(
2690
+ version=version,
2691
+ x_platform_id=x_platform_id,
2692
+ expand=expand,
2693
+ limit=limit,
2694
+ page=page,
2695
+ order_by=order_by,
2696
+ order_direction=order_direction,
2697
+ statuses=statuses,
2698
+ search_create_request=search_create_request,
2699
+ _request_auth=_request_auth,
2700
+ _content_type=_content_type,
2701
+ _headers=_headers,
2702
+ _host_index=_host_index
2703
+ )
2704
+
2705
+ _response_types_map: Dict[str, Optional[str]] = {
2706
+ '200': "WorkflowPaginatedResponse",
2707
+ '401': "ApiError",
2708
+ '403': "ApiError",
2709
+ }
2710
+ response_data = self.api_client.call_api(
2711
+ *_param,
2712
+ _request_timeout=_request_timeout
2713
+ )
2714
+ response_data.read()
2715
+ return self.api_client.response_deserialize(
2716
+ response_data=response_data,
2717
+ response_types_map=_response_types_map,
2718
+ )
2719
+
2720
+
2721
+ @validate_call
2722
+ def post_workflows_search_without_preload_content(
2723
+ self,
2724
+ version: Annotated[StrictStr, Field(description="version")],
2725
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2726
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
2727
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2728
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2729
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2730
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2731
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.")] = None,
2732
+ search_create_request: Optional[SearchCreateRequest] = None,
2733
+ _request_timeout: Union[
2734
+ None,
2735
+ Annotated[StrictFloat, Field(gt=0)],
2736
+ Tuple[
2737
+ Annotated[StrictFloat, Field(gt=0)],
2738
+ Annotated[StrictFloat, Field(gt=0)]
2739
+ ]
2740
+ ] = None,
2741
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2742
+ _content_type: Optional[StrictStr] = None,
2743
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2744
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2745
+ ) -> RESTResponseType:
2746
+ """Search workflows
2747
+
2748
+ Searches workflow definitions with the provided search body and optional query filters. Requires the WORKFLOW.VIEW permission.
2749
+
2750
+ :param version: version (required)
2751
+ :type version: str
2752
+ :param x_platform_id: Platform ID.
2753
+ :type x_platform_id: str
2754
+ :param expand: The id fields of the resources that are going to be expanded.
2755
+ :type expand: List[str]
2756
+ :param limit: The amount of records shown in the list
2757
+ :type limit: int
2758
+ :param page: The page which is going to be shown
2759
+ :type page: int
2760
+ :param order_by: The parameter by which the response is ordered.
2761
+ :type order_by: str
2762
+ :param order_direction: The order direction by which the response is ordered.
2763
+ :type order_direction: str
2764
+ :param statuses: Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.
2765
+ :type statuses: List[str]
2766
+ :param search_create_request:
2767
+ :type search_create_request: SearchCreateRequest
2768
+ :param _request_timeout: timeout setting for this request. If one
2769
+ number provided, it will be total request
2770
+ timeout. It can also be a pair (tuple) of
2771
+ (connection, read) timeouts.
2772
+ :type _request_timeout: int, tuple(int, int), optional
2773
+ :param _request_auth: set to override the auth_settings for an a single
2774
+ request; this effectively ignores the
2775
+ authentication in the spec for a single request.
2776
+ :type _request_auth: dict, optional
2777
+ :param _content_type: force content-type for the request.
2778
+ :type _content_type: str, Optional
2779
+ :param _headers: set to override the headers for a single
2780
+ request; this effectively ignores the headers
2781
+ in the spec for a single request.
2782
+ :type _headers: dict, optional
2783
+ :param _host_index: set to override the host_index for a single
2784
+ request; this effectively ignores the host_index
2785
+ in the spec for a single request.
2786
+ :type _host_index: int, optional
2787
+ :return: Returns the result object.
2788
+ """ # noqa: E501
2789
+
2790
+ _param = self._post_workflows_search_serialize(
2791
+ version=version,
2792
+ x_platform_id=x_platform_id,
2793
+ expand=expand,
2794
+ limit=limit,
2795
+ page=page,
2796
+ order_by=order_by,
2797
+ order_direction=order_direction,
2798
+ statuses=statuses,
2799
+ search_create_request=search_create_request,
2800
+ _request_auth=_request_auth,
2801
+ _content_type=_content_type,
2802
+ _headers=_headers,
2803
+ _host_index=_host_index
2804
+ )
2805
+
2806
+ _response_types_map: Dict[str, Optional[str]] = {
2807
+ '200': "WorkflowPaginatedResponse",
2808
+ '401': "ApiError",
2809
+ '403': "ApiError",
2810
+ }
2811
+ response_data = self.api_client.call_api(
2812
+ *_param,
2813
+ _request_timeout=_request_timeout
2814
+ )
2815
+ return response_data.response
2816
+
2817
+
2818
+ def _post_workflows_search_serialize(
2819
+ self,
2820
+ version,
2821
+ x_platform_id,
2822
+ expand,
2823
+ limit,
2824
+ page,
2825
+ order_by,
2826
+ order_direction,
2827
+ statuses,
2828
+ search_create_request,
2829
+ _request_auth,
2830
+ _content_type,
2831
+ _headers,
2832
+ _host_index,
2833
+ ) -> RequestSerialized:
2834
+
2835
+ _host = None
2836
+
2837
+ _collection_formats: Dict[str, str] = {
2838
+ 'expand[]': 'multi',
2839
+ 'statuses[]': 'multi',
2840
+ }
2841
+
2842
+ _path_params: Dict[str, str] = {}
2843
+ _query_params: List[Tuple[str, str]] = []
2844
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2845
+ _form_params: List[Tuple[str, str]] = []
2846
+ _files: Dict[
2847
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2848
+ ] = {}
2849
+ _body_params: Optional[bytes] = None
2850
+
2851
+ # process the path parameters
2852
+ if version is not None:
2853
+ _path_params['version'] = version
2854
+ # process the query parameters
2855
+ if expand is not None:
2856
+
2857
+ _query_params.append(('expand[]', expand))
2858
+
2859
+ if limit is not None:
2860
+
2861
+ _query_params.append(('limit', limit))
2862
+
2863
+ if page is not None:
2864
+
2865
+ _query_params.append(('page', page))
2866
+
2867
+ if order_by is not None:
2868
+
2869
+ _query_params.append(('order_by', order_by))
2870
+
2871
+ if order_direction is not None:
2872
+
2873
+ _query_params.append(('order_direction', order_direction))
2874
+
2875
+ if statuses is not None:
2876
+
2877
+ _query_params.append(('statuses[]', statuses))
2878
+
2879
+ # process the header parameters
2880
+ if x_platform_id is not None:
2881
+ _header_params['x-platform-id'] = x_platform_id
2882
+ # process the form parameters
2883
+ # process the body parameter
2884
+ if search_create_request is not None:
2885
+ _body_params = search_create_request
2886
+
2887
+
2888
+ # set the HTTP header `Accept`
2889
+ if 'Accept' not in _header_params:
2890
+ _header_params['Accept'] = self.api_client.select_header_accept(
2891
+ [
2892
+ 'application/json',
2893
+ '*/*'
2894
+ ]
2895
+ )
2896
+
2897
+ # set the HTTP header `Content-Type`
2898
+ if _content_type:
2899
+ _header_params['Content-Type'] = _content_type
2900
+ else:
2901
+ _default_content_type = (
2902
+ self.api_client.select_header_content_type(
2903
+ [
2904
+ 'application/json'
2905
+ ]
2906
+ )
2907
+ )
2908
+ if _default_content_type is not None:
2909
+ _header_params['Content-Type'] = _default_content_type
2910
+
2911
+ # authentication setting
2912
+ _auth_settings: List[str] = [
2913
+ 'JWT-Authentication',
2914
+ 'API-Key'
2915
+ ]
2916
+
2917
+ return self.api_client.param_serialize(
2918
+ method='POST',
2919
+ resource_path='/v{version}/workflows/search',
2920
+ path_params=_path_params,
2921
+ query_params=_query_params,
2922
+ header_params=_header_params,
2923
+ body=_body_params,
2924
+ post_params=_form_params,
2925
+ files=_files,
2926
+ auth_settings=_auth_settings,
2927
+ collection_formats=_collection_formats,
2928
+ _host=_host,
2929
+ _request_auth=_request_auth
2930
+ )
2931
+
2932
+
2933
+
2934
+
2935
+ @validate_call
2936
+ def update_workflows_by_resource_id_or_reference(
2937
+ self,
2938
+ version: Annotated[StrictStr, Field(description="version")],
2939
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
2940
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2941
+ workflow_update_request: Optional[WorkflowUpdateRequest] = None,
2942
+ _request_timeout: Union[
2943
+ None,
2944
+ Annotated[StrictFloat, Field(gt=0)],
2945
+ Tuple[
2946
+ Annotated[StrictFloat, Field(gt=0)],
2947
+ Annotated[StrictFloat, Field(gt=0)]
2948
+ ]
2949
+ ] = None,
2950
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2951
+ _content_type: Optional[StrictStr] = None,
2952
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2953
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2954
+ ) -> Workflow:
2955
+ """Update a workflow by ID or reference
2956
+
2957
+ Updates workflow fields. Requires the WORKFLOW.UPDATE permission.
2958
+
2959
+ :param version: version (required)
2960
+ :type version: str
2961
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
2962
+ :type resource_id_or_reference: str
2963
+ :param x_platform_id: Platform ID.
2964
+ :type x_platform_id: str
2965
+ :param workflow_update_request:
2966
+ :type workflow_update_request: WorkflowUpdateRequest
2967
+ :param _request_timeout: timeout setting for this request. If one
2968
+ number provided, it will be total request
2969
+ timeout. It can also be a pair (tuple) of
2970
+ (connection, read) timeouts.
2971
+ :type _request_timeout: int, tuple(int, int), optional
2972
+ :param _request_auth: set to override the auth_settings for an a single
2973
+ request; this effectively ignores the
2974
+ authentication in the spec for a single request.
2975
+ :type _request_auth: dict, optional
2976
+ :param _content_type: force content-type for the request.
2977
+ :type _content_type: str, Optional
2978
+ :param _headers: set to override the headers for a single
2979
+ request; this effectively ignores the headers
2980
+ in the spec for a single request.
2981
+ :type _headers: dict, optional
2982
+ :param _host_index: set to override the host_index for a single
2983
+ request; this effectively ignores the host_index
2984
+ in the spec for a single request.
2985
+ :type _host_index: int, optional
2986
+ :return: Returns the result object.
2987
+ """ # noqa: E501
2988
+
2989
+ _param = self._update_workflows_by_resource_id_or_reference_serialize(
2990
+ version=version,
2991
+ resource_id_or_reference=resource_id_or_reference,
2992
+ x_platform_id=x_platform_id,
2993
+ workflow_update_request=workflow_update_request,
2994
+ _request_auth=_request_auth,
2995
+ _content_type=_content_type,
2996
+ _headers=_headers,
2997
+ _host_index=_host_index
2998
+ )
2999
+
3000
+ _response_types_map: Dict[str, Optional[str]] = {
3001
+ '200': "Workflow",
3002
+ '401': "ApiError",
3003
+ '403': "ApiError",
3004
+ }
3005
+ response_data = self.api_client.call_api(
3006
+ *_param,
3007
+ _request_timeout=_request_timeout
3008
+ )
3009
+ response_data.read()
3010
+ return self.api_client.response_deserialize(
3011
+ response_data=response_data,
3012
+ response_types_map=_response_types_map,
3013
+ ).data
3014
+
3015
+
3016
+ @validate_call
3017
+ def update_workflows_by_resource_id_or_reference_with_http_info(
3018
+ self,
3019
+ version: Annotated[StrictStr, Field(description="version")],
3020
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
3021
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3022
+ workflow_update_request: Optional[WorkflowUpdateRequest] = None,
3023
+ _request_timeout: Union[
3024
+ None,
3025
+ Annotated[StrictFloat, Field(gt=0)],
3026
+ Tuple[
3027
+ Annotated[StrictFloat, Field(gt=0)],
3028
+ Annotated[StrictFloat, Field(gt=0)]
3029
+ ]
3030
+ ] = None,
3031
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3032
+ _content_type: Optional[StrictStr] = None,
3033
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3034
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3035
+ ) -> ApiResponse[Workflow]:
3036
+ """Update a workflow by ID or reference
3037
+
3038
+ Updates workflow fields. Requires the WORKFLOW.UPDATE permission.
3039
+
3040
+ :param version: version (required)
3041
+ :type version: str
3042
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
3043
+ :type resource_id_or_reference: str
3044
+ :param x_platform_id: Platform ID.
3045
+ :type x_platform_id: str
3046
+ :param workflow_update_request:
3047
+ :type workflow_update_request: WorkflowUpdateRequest
3048
+ :param _request_timeout: timeout setting for this request. If one
3049
+ number provided, it will be total request
3050
+ timeout. It can also be a pair (tuple) of
3051
+ (connection, read) timeouts.
3052
+ :type _request_timeout: int, tuple(int, int), optional
3053
+ :param _request_auth: set to override the auth_settings for an a single
3054
+ request; this effectively ignores the
3055
+ authentication in the spec for a single request.
3056
+ :type _request_auth: dict, optional
3057
+ :param _content_type: force content-type for the request.
3058
+ :type _content_type: str, Optional
3059
+ :param _headers: set to override the headers for a single
3060
+ request; this effectively ignores the headers
3061
+ in the spec for a single request.
3062
+ :type _headers: dict, optional
3063
+ :param _host_index: set to override the host_index for a single
3064
+ request; this effectively ignores the host_index
3065
+ in the spec for a single request.
3066
+ :type _host_index: int, optional
3067
+ :return: Returns the result object.
3068
+ """ # noqa: E501
3069
+
3070
+ _param = self._update_workflows_by_resource_id_or_reference_serialize(
3071
+ version=version,
3072
+ resource_id_or_reference=resource_id_or_reference,
3073
+ x_platform_id=x_platform_id,
3074
+ workflow_update_request=workflow_update_request,
3075
+ _request_auth=_request_auth,
3076
+ _content_type=_content_type,
3077
+ _headers=_headers,
3078
+ _host_index=_host_index
3079
+ )
3080
+
3081
+ _response_types_map: Dict[str, Optional[str]] = {
3082
+ '200': "Workflow",
3083
+ '401': "ApiError",
3084
+ '403': "ApiError",
3085
+ }
3086
+ response_data = self.api_client.call_api(
3087
+ *_param,
3088
+ _request_timeout=_request_timeout
3089
+ )
3090
+ response_data.read()
3091
+ return self.api_client.response_deserialize(
3092
+ response_data=response_data,
3093
+ response_types_map=_response_types_map,
3094
+ )
3095
+
3096
+
3097
+ @validate_call
3098
+ def update_workflows_by_resource_id_or_reference_without_preload_content(
3099
+ self,
3100
+ version: Annotated[StrictStr, Field(description="version")],
3101
+ resource_id_or_reference: Annotated[StrictStr, Field(description="The ID or reference of the resource.")],
3102
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3103
+ workflow_update_request: Optional[WorkflowUpdateRequest] = None,
3104
+ _request_timeout: Union[
3105
+ None,
3106
+ Annotated[StrictFloat, Field(gt=0)],
3107
+ Tuple[
3108
+ Annotated[StrictFloat, Field(gt=0)],
3109
+ Annotated[StrictFloat, Field(gt=0)]
3110
+ ]
3111
+ ] = None,
3112
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3113
+ _content_type: Optional[StrictStr] = None,
3114
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3115
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3116
+ ) -> RESTResponseType:
3117
+ """Update a workflow by ID or reference
3118
+
3119
+ Updates workflow fields. Requires the WORKFLOW.UPDATE permission.
3120
+
3121
+ :param version: version (required)
3122
+ :type version: str
3123
+ :param resource_id_or_reference: The ID or reference of the resource. (required)
3124
+ :type resource_id_or_reference: str
3125
+ :param x_platform_id: Platform ID.
3126
+ :type x_platform_id: str
3127
+ :param workflow_update_request:
3128
+ :type workflow_update_request: WorkflowUpdateRequest
3129
+ :param _request_timeout: timeout setting for this request. If one
3130
+ number provided, it will be total request
3131
+ timeout. It can also be a pair (tuple) of
3132
+ (connection, read) timeouts.
3133
+ :type _request_timeout: int, tuple(int, int), optional
3134
+ :param _request_auth: set to override the auth_settings for an a single
3135
+ request; this effectively ignores the
3136
+ authentication in the spec for a single request.
3137
+ :type _request_auth: dict, optional
3138
+ :param _content_type: force content-type for the request.
3139
+ :type _content_type: str, Optional
3140
+ :param _headers: set to override the headers for a single
3141
+ request; this effectively ignores the headers
3142
+ in the spec for a single request.
3143
+ :type _headers: dict, optional
3144
+ :param _host_index: set to override the host_index for a single
3145
+ request; this effectively ignores the host_index
3146
+ in the spec for a single request.
3147
+ :type _host_index: int, optional
3148
+ :return: Returns the result object.
3149
+ """ # noqa: E501
3150
+
3151
+ _param = self._update_workflows_by_resource_id_or_reference_serialize(
3152
+ version=version,
3153
+ resource_id_or_reference=resource_id_or_reference,
3154
+ x_platform_id=x_platform_id,
3155
+ workflow_update_request=workflow_update_request,
3156
+ _request_auth=_request_auth,
3157
+ _content_type=_content_type,
3158
+ _headers=_headers,
3159
+ _host_index=_host_index
3160
+ )
3161
+
3162
+ _response_types_map: Dict[str, Optional[str]] = {
3163
+ '200': "Workflow",
3164
+ '401': "ApiError",
3165
+ '403': "ApiError",
3166
+ }
3167
+ response_data = self.api_client.call_api(
3168
+ *_param,
3169
+ _request_timeout=_request_timeout
3170
+ )
3171
+ return response_data.response
3172
+
3173
+
3174
+ def _update_workflows_by_resource_id_or_reference_serialize(
3175
+ self,
3176
+ version,
3177
+ resource_id_or_reference,
3178
+ x_platform_id,
3179
+ workflow_update_request,
3180
+ _request_auth,
3181
+ _content_type,
3182
+ _headers,
3183
+ _host_index,
3184
+ ) -> RequestSerialized:
3185
+
3186
+ _host = None
3187
+
3188
+ _collection_formats: Dict[str, str] = {
3189
+ }
3190
+
3191
+ _path_params: Dict[str, str] = {}
3192
+ _query_params: List[Tuple[str, str]] = []
3193
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3194
+ _form_params: List[Tuple[str, str]] = []
3195
+ _files: Dict[
3196
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3197
+ ] = {}
3198
+ _body_params: Optional[bytes] = None
3199
+
3200
+ # process the path parameters
3201
+ if version is not None:
3202
+ _path_params['version'] = version
3203
+ if resource_id_or_reference is not None:
3204
+ _path_params['resourceIdOrReference'] = resource_id_or_reference
3205
+ # process the query parameters
3206
+ # process the header parameters
3207
+ if x_platform_id is not None:
3208
+ _header_params['x-platform-id'] = x_platform_id
3209
+ # process the form parameters
3210
+ # process the body parameter
3211
+ if workflow_update_request is not None:
3212
+ _body_params = workflow_update_request
3213
+
3214
+
3215
+ # set the HTTP header `Accept`
3216
+ if 'Accept' not in _header_params:
3217
+ _header_params['Accept'] = self.api_client.select_header_accept(
3218
+ [
3219
+ 'application/json',
3220
+ '*/*'
3221
+ ]
3222
+ )
3223
+
3224
+ # set the HTTP header `Content-Type`
3225
+ if _content_type:
3226
+ _header_params['Content-Type'] = _content_type
3227
+ else:
3228
+ _default_content_type = (
3229
+ self.api_client.select_header_content_type(
3230
+ [
3231
+ 'application/json'
3232
+ ]
3233
+ )
3234
+ )
3235
+ if _default_content_type is not None:
3236
+ _header_params['Content-Type'] = _default_content_type
3237
+
3238
+ # authentication setting
3239
+ _auth_settings: List[str] = [
3240
+ 'JWT-Authentication',
3241
+ 'API-Key'
3242
+ ]
3243
+
3244
+ return self.api_client.param_serialize(
3245
+ method='PATCH',
3246
+ resource_path='/v{version}/workflows/{resourceIdOrReference}',
3247
+ path_params=_path_params,
3248
+ query_params=_query_params,
3249
+ header_params=_header_params,
3250
+ body=_body_params,
3251
+ post_params=_form_params,
3252
+ files=_files,
3253
+ auth_settings=_auth_settings,
3254
+ collection_formats=_collection_formats,
3255
+ _host=_host,
3256
+ _request_auth=_request_auth
3257
+ )
3258
+
3259
+