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,4754 @@
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, StrictBool, StrictInt, StrictStr
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from solvimon_python_sdk.models.download_url import DownloadUrl
23
+ from solvimon_python_sdk.models.report import Report
24
+ from solvimon_python_sdk.models.report_generate_request import ReportGenerateRequest
25
+ from solvimon_python_sdk.models.report_generate_request_create_request import ReportGenerateRequestCreateRequest
26
+ from solvimon_python_sdk.models.report_generate_request_response_wrapper import ReportGenerateRequestResponseWrapper
27
+ from solvimon_python_sdk.models.report_response_wrapper import ReportResponseWrapper
28
+ from solvimon_python_sdk.models.search_create_request import SearchCreateRequest
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 ReportsApi:
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 get_report_generate_requests(
50
+ self,
51
+ version: Annotated[StrictStr, Field(description="version")],
52
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
53
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
54
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
55
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
56
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
57
+ _request_timeout: Union[
58
+ None,
59
+ Annotated[StrictFloat, Field(gt=0)],
60
+ Tuple[
61
+ Annotated[StrictFloat, Field(gt=0)],
62
+ Annotated[StrictFloat, Field(gt=0)]
63
+ ]
64
+ ] = None,
65
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
66
+ _content_type: Optional[StrictStr] = None,
67
+ _headers: Optional[Dict[StrictStr, Any]] = None,
68
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
69
+ ) -> ReportGenerateRequestResponseWrapper:
70
+ """Get ReportGenerateRequests
71
+
72
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
73
+
74
+ :param version: version (required)
75
+ :type version: str
76
+ :param x_platform_id: Platform ID.
77
+ :type x_platform_id: str
78
+ :param limit: The amount of records shown in the list
79
+ :type limit: int
80
+ :param page: The page which is going to be shown
81
+ :type page: int
82
+ :param order_by: The parameter by which the response is ordered.
83
+ :type order_by: str
84
+ :param order_direction: The order direction by which the response is ordered.
85
+ :type order_direction: str
86
+ :param _request_timeout: timeout setting for this request. If one
87
+ number provided, it will be total request
88
+ timeout. It can also be a pair (tuple) of
89
+ (connection, read) timeouts.
90
+ :type _request_timeout: int, tuple(int, int), optional
91
+ :param _request_auth: set to override the auth_settings for an a single
92
+ request; this effectively ignores the
93
+ authentication in the spec for a single request.
94
+ :type _request_auth: dict, optional
95
+ :param _content_type: force content-type for the request.
96
+ :type _content_type: str, Optional
97
+ :param _headers: set to override the headers for a single
98
+ request; this effectively ignores the headers
99
+ in the spec for a single request.
100
+ :type _headers: dict, optional
101
+ :param _host_index: set to override the host_index for a single
102
+ request; this effectively ignores the host_index
103
+ in the spec for a single request.
104
+ :type _host_index: int, optional
105
+ :return: Returns the result object.
106
+ """ # noqa: E501
107
+
108
+ _param = self._get_report_generate_requests_serialize(
109
+ version=version,
110
+ x_platform_id=x_platform_id,
111
+ limit=limit,
112
+ page=page,
113
+ order_by=order_by,
114
+ order_direction=order_direction,
115
+ _request_auth=_request_auth,
116
+ _content_type=_content_type,
117
+ _headers=_headers,
118
+ _host_index=_host_index
119
+ )
120
+
121
+ _response_types_map: Dict[str, Optional[str]] = {
122
+ '200': "ReportGenerateRequestResponseWrapper",
123
+ '400': "ApiError",
124
+ '401': "ApiError",
125
+ '403': "ApiError",
126
+ '500': "ApiError",
127
+ }
128
+ response_data = self.api_client.call_api(
129
+ *_param,
130
+ _request_timeout=_request_timeout
131
+ )
132
+ response_data.read()
133
+ return self.api_client.response_deserialize(
134
+ response_data=response_data,
135
+ response_types_map=_response_types_map,
136
+ ).data
137
+
138
+
139
+ @validate_call
140
+ def get_report_generate_requests_with_http_info(
141
+ self,
142
+ version: Annotated[StrictStr, Field(description="version")],
143
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
144
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
145
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
146
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
147
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
148
+ _request_timeout: Union[
149
+ None,
150
+ Annotated[StrictFloat, Field(gt=0)],
151
+ Tuple[
152
+ Annotated[StrictFloat, Field(gt=0)],
153
+ Annotated[StrictFloat, Field(gt=0)]
154
+ ]
155
+ ] = None,
156
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
157
+ _content_type: Optional[StrictStr] = None,
158
+ _headers: Optional[Dict[StrictStr, Any]] = None,
159
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
160
+ ) -> ApiResponse[ReportGenerateRequestResponseWrapper]:
161
+ """Get ReportGenerateRequests
162
+
163
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
164
+
165
+ :param version: version (required)
166
+ :type version: str
167
+ :param x_platform_id: Platform ID.
168
+ :type x_platform_id: str
169
+ :param limit: The amount of records shown in the list
170
+ :type limit: int
171
+ :param page: The page which is going to be shown
172
+ :type page: int
173
+ :param order_by: The parameter by which the response is ordered.
174
+ :type order_by: str
175
+ :param order_direction: The order direction by which the response is ordered.
176
+ :type order_direction: str
177
+ :param _request_timeout: timeout setting for this request. If one
178
+ number provided, it will be total request
179
+ timeout. It can also be a pair (tuple) of
180
+ (connection, read) timeouts.
181
+ :type _request_timeout: int, tuple(int, int), optional
182
+ :param _request_auth: set to override the auth_settings for an a single
183
+ request; this effectively ignores the
184
+ authentication in the spec for a single request.
185
+ :type _request_auth: dict, optional
186
+ :param _content_type: force content-type for the request.
187
+ :type _content_type: str, Optional
188
+ :param _headers: set to override the headers for a single
189
+ request; this effectively ignores the headers
190
+ in the spec for a single request.
191
+ :type _headers: dict, optional
192
+ :param _host_index: set to override the host_index for a single
193
+ request; this effectively ignores the host_index
194
+ in the spec for a single request.
195
+ :type _host_index: int, optional
196
+ :return: Returns the result object.
197
+ """ # noqa: E501
198
+
199
+ _param = self._get_report_generate_requests_serialize(
200
+ version=version,
201
+ x_platform_id=x_platform_id,
202
+ limit=limit,
203
+ page=page,
204
+ order_by=order_by,
205
+ order_direction=order_direction,
206
+ _request_auth=_request_auth,
207
+ _content_type=_content_type,
208
+ _headers=_headers,
209
+ _host_index=_host_index
210
+ )
211
+
212
+ _response_types_map: Dict[str, Optional[str]] = {
213
+ '200': "ReportGenerateRequestResponseWrapper",
214
+ '400': "ApiError",
215
+ '401': "ApiError",
216
+ '403': "ApiError",
217
+ '500': "ApiError",
218
+ }
219
+ response_data = self.api_client.call_api(
220
+ *_param,
221
+ _request_timeout=_request_timeout
222
+ )
223
+ response_data.read()
224
+ return self.api_client.response_deserialize(
225
+ response_data=response_data,
226
+ response_types_map=_response_types_map,
227
+ )
228
+
229
+
230
+ @validate_call
231
+ def get_report_generate_requests_without_preload_content(
232
+ self,
233
+ version: Annotated[StrictStr, Field(description="version")],
234
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
235
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
236
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
237
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
238
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
239
+ _request_timeout: Union[
240
+ None,
241
+ Annotated[StrictFloat, Field(gt=0)],
242
+ Tuple[
243
+ Annotated[StrictFloat, Field(gt=0)],
244
+ Annotated[StrictFloat, Field(gt=0)]
245
+ ]
246
+ ] = None,
247
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
248
+ _content_type: Optional[StrictStr] = None,
249
+ _headers: Optional[Dict[StrictStr, Any]] = None,
250
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
251
+ ) -> RESTResponseType:
252
+ """Get ReportGenerateRequests
253
+
254
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
255
+
256
+ :param version: version (required)
257
+ :type version: str
258
+ :param x_platform_id: Platform ID.
259
+ :type x_platform_id: str
260
+ :param limit: The amount of records shown in the list
261
+ :type limit: int
262
+ :param page: The page which is going to be shown
263
+ :type page: int
264
+ :param order_by: The parameter by which the response is ordered.
265
+ :type order_by: str
266
+ :param order_direction: The order direction by which the response is ordered.
267
+ :type order_direction: str
268
+ :param _request_timeout: timeout setting for this request. If one
269
+ number provided, it will be total request
270
+ timeout. It can also be a pair (tuple) of
271
+ (connection, read) timeouts.
272
+ :type _request_timeout: int, tuple(int, int), optional
273
+ :param _request_auth: set to override the auth_settings for an a single
274
+ request; this effectively ignores the
275
+ authentication in the spec for a single request.
276
+ :type _request_auth: dict, optional
277
+ :param _content_type: force content-type for the request.
278
+ :type _content_type: str, Optional
279
+ :param _headers: set to override the headers for a single
280
+ request; this effectively ignores the headers
281
+ in the spec for a single request.
282
+ :type _headers: dict, optional
283
+ :param _host_index: set to override the host_index for a single
284
+ request; this effectively ignores the host_index
285
+ in the spec for a single request.
286
+ :type _host_index: int, optional
287
+ :return: Returns the result object.
288
+ """ # noqa: E501
289
+
290
+ _param = self._get_report_generate_requests_serialize(
291
+ version=version,
292
+ x_platform_id=x_platform_id,
293
+ limit=limit,
294
+ page=page,
295
+ order_by=order_by,
296
+ order_direction=order_direction,
297
+ _request_auth=_request_auth,
298
+ _content_type=_content_type,
299
+ _headers=_headers,
300
+ _host_index=_host_index
301
+ )
302
+
303
+ _response_types_map: Dict[str, Optional[str]] = {
304
+ '200': "ReportGenerateRequestResponseWrapper",
305
+ '400': "ApiError",
306
+ '401': "ApiError",
307
+ '403': "ApiError",
308
+ '500': "ApiError",
309
+ }
310
+ response_data = self.api_client.call_api(
311
+ *_param,
312
+ _request_timeout=_request_timeout
313
+ )
314
+ return response_data.response
315
+
316
+
317
+ def _get_report_generate_requests_serialize(
318
+ self,
319
+ version,
320
+ x_platform_id,
321
+ limit,
322
+ page,
323
+ order_by,
324
+ order_direction,
325
+ _request_auth,
326
+ _content_type,
327
+ _headers,
328
+ _host_index,
329
+ ) -> RequestSerialized:
330
+
331
+ _host = None
332
+
333
+ _collection_formats: Dict[str, str] = {
334
+ }
335
+
336
+ _path_params: Dict[str, str] = {}
337
+ _query_params: List[Tuple[str, str]] = []
338
+ _header_params: Dict[str, Optional[str]] = _headers or {}
339
+ _form_params: List[Tuple[str, str]] = []
340
+ _files: Dict[
341
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
342
+ ] = {}
343
+ _body_params: Optional[bytes] = None
344
+
345
+ # process the path parameters
346
+ if version is not None:
347
+ _path_params['version'] = version
348
+ # process the query parameters
349
+ if limit is not None:
350
+
351
+ _query_params.append(('limit', limit))
352
+
353
+ if page is not None:
354
+
355
+ _query_params.append(('page', page))
356
+
357
+ if order_by is not None:
358
+
359
+ _query_params.append(('order_by', order_by))
360
+
361
+ if order_direction is not None:
362
+
363
+ _query_params.append(('order_direction', order_direction))
364
+
365
+ # process the header parameters
366
+ if x_platform_id is not None:
367
+ _header_params['x-platform-id'] = x_platform_id
368
+ # process the form parameters
369
+ # process the body parameter
370
+
371
+
372
+ # set the HTTP header `Accept`
373
+ if 'Accept' not in _header_params:
374
+ _header_params['Accept'] = self.api_client.select_header_accept(
375
+ [
376
+ 'application/json',
377
+ '*/*'
378
+ ]
379
+ )
380
+
381
+
382
+ # authentication setting
383
+ _auth_settings: List[str] = [
384
+ 'JWT-Authentication',
385
+ 'API-Key'
386
+ ]
387
+
388
+ return self.api_client.param_serialize(
389
+ method='GET',
390
+ resource_path='/v{version}/report-generate-requests',
391
+ path_params=_path_params,
392
+ query_params=_query_params,
393
+ header_params=_header_params,
394
+ body=_body_params,
395
+ post_params=_form_params,
396
+ files=_files,
397
+ auth_settings=_auth_settings,
398
+ collection_formats=_collection_formats,
399
+ _host=_host,
400
+ _request_auth=_request_auth
401
+ )
402
+
403
+
404
+
405
+
406
+ @validate_call
407
+ def get_report_generate_requests_by_resource_id(
408
+ self,
409
+ version: Annotated[StrictStr, Field(description="version")],
410
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
411
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
412
+ _request_timeout: Union[
413
+ None,
414
+ Annotated[StrictFloat, Field(gt=0)],
415
+ Tuple[
416
+ Annotated[StrictFloat, Field(gt=0)],
417
+ Annotated[StrictFloat, Field(gt=0)]
418
+ ]
419
+ ] = None,
420
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
421
+ _content_type: Optional[StrictStr] = None,
422
+ _headers: Optional[Dict[StrictStr, Any]] = None,
423
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
424
+ ) -> ReportGenerateRequest:
425
+ """Get ReportGenerateRequest
426
+
427
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
428
+
429
+ :param version: version (required)
430
+ :type version: str
431
+ :param resource_id: The ID of the resource to be requested. (required)
432
+ :type resource_id: str
433
+ :param x_platform_id: Platform ID.
434
+ :type x_platform_id: str
435
+ :param _request_timeout: timeout setting for this request. If one
436
+ number provided, it will be total request
437
+ timeout. It can also be a pair (tuple) of
438
+ (connection, read) timeouts.
439
+ :type _request_timeout: int, tuple(int, int), optional
440
+ :param _request_auth: set to override the auth_settings for an a single
441
+ request; this effectively ignores the
442
+ authentication in the spec for a single request.
443
+ :type _request_auth: dict, optional
444
+ :param _content_type: force content-type for the request.
445
+ :type _content_type: str, Optional
446
+ :param _headers: set to override the headers for a single
447
+ request; this effectively ignores the headers
448
+ in the spec for a single request.
449
+ :type _headers: dict, optional
450
+ :param _host_index: set to override the host_index for a single
451
+ request; this effectively ignores the host_index
452
+ in the spec for a single request.
453
+ :type _host_index: int, optional
454
+ :return: Returns the result object.
455
+ """ # noqa: E501
456
+
457
+ _param = self._get_report_generate_requests_by_resource_id_serialize(
458
+ version=version,
459
+ resource_id=resource_id,
460
+ x_platform_id=x_platform_id,
461
+ _request_auth=_request_auth,
462
+ _content_type=_content_type,
463
+ _headers=_headers,
464
+ _host_index=_host_index
465
+ )
466
+
467
+ _response_types_map: Dict[str, Optional[str]] = {
468
+ '200': "ReportGenerateRequest",
469
+ '400': "ApiError",
470
+ '401': "ApiError",
471
+ '403': "ApiError",
472
+ '500': "ApiError",
473
+ }
474
+ response_data = self.api_client.call_api(
475
+ *_param,
476
+ _request_timeout=_request_timeout
477
+ )
478
+ response_data.read()
479
+ return self.api_client.response_deserialize(
480
+ response_data=response_data,
481
+ response_types_map=_response_types_map,
482
+ ).data
483
+
484
+
485
+ @validate_call
486
+ def get_report_generate_requests_by_resource_id_with_http_info(
487
+ self,
488
+ version: Annotated[StrictStr, Field(description="version")],
489
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
490
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
491
+ _request_timeout: Union[
492
+ None,
493
+ Annotated[StrictFloat, Field(gt=0)],
494
+ Tuple[
495
+ Annotated[StrictFloat, Field(gt=0)],
496
+ Annotated[StrictFloat, Field(gt=0)]
497
+ ]
498
+ ] = None,
499
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
500
+ _content_type: Optional[StrictStr] = None,
501
+ _headers: Optional[Dict[StrictStr, Any]] = None,
502
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
503
+ ) -> ApiResponse[ReportGenerateRequest]:
504
+ """Get ReportGenerateRequest
505
+
506
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
507
+
508
+ :param version: version (required)
509
+ :type version: str
510
+ :param resource_id: The ID of the resource to be requested. (required)
511
+ :type resource_id: str
512
+ :param x_platform_id: Platform ID.
513
+ :type x_platform_id: str
514
+ :param _request_timeout: timeout setting for this request. If one
515
+ number provided, it will be total request
516
+ timeout. It can also be a pair (tuple) of
517
+ (connection, read) timeouts.
518
+ :type _request_timeout: int, tuple(int, int), optional
519
+ :param _request_auth: set to override the auth_settings for an a single
520
+ request; this effectively ignores the
521
+ authentication in the spec for a single request.
522
+ :type _request_auth: dict, optional
523
+ :param _content_type: force content-type for the request.
524
+ :type _content_type: str, Optional
525
+ :param _headers: set to override the headers for a single
526
+ request; this effectively ignores the headers
527
+ in the spec for a single request.
528
+ :type _headers: dict, optional
529
+ :param _host_index: set to override the host_index for a single
530
+ request; this effectively ignores the host_index
531
+ in the spec for a single request.
532
+ :type _host_index: int, optional
533
+ :return: Returns the result object.
534
+ """ # noqa: E501
535
+
536
+ _param = self._get_report_generate_requests_by_resource_id_serialize(
537
+ version=version,
538
+ resource_id=resource_id,
539
+ x_platform_id=x_platform_id,
540
+ _request_auth=_request_auth,
541
+ _content_type=_content_type,
542
+ _headers=_headers,
543
+ _host_index=_host_index
544
+ )
545
+
546
+ _response_types_map: Dict[str, Optional[str]] = {
547
+ '200': "ReportGenerateRequest",
548
+ '400': "ApiError",
549
+ '401': "ApiError",
550
+ '403': "ApiError",
551
+ '500': "ApiError",
552
+ }
553
+ response_data = self.api_client.call_api(
554
+ *_param,
555
+ _request_timeout=_request_timeout
556
+ )
557
+ response_data.read()
558
+ return self.api_client.response_deserialize(
559
+ response_data=response_data,
560
+ response_types_map=_response_types_map,
561
+ )
562
+
563
+
564
+ @validate_call
565
+ def get_report_generate_requests_by_resource_id_without_preload_content(
566
+ self,
567
+ version: Annotated[StrictStr, Field(description="version")],
568
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
569
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
570
+ _request_timeout: Union[
571
+ None,
572
+ Annotated[StrictFloat, Field(gt=0)],
573
+ Tuple[
574
+ Annotated[StrictFloat, Field(gt=0)],
575
+ Annotated[StrictFloat, Field(gt=0)]
576
+ ]
577
+ ] = None,
578
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
579
+ _content_type: Optional[StrictStr] = None,
580
+ _headers: Optional[Dict[StrictStr, Any]] = None,
581
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
582
+ ) -> RESTResponseType:
583
+ """Get ReportGenerateRequest
584
+
585
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
586
+
587
+ :param version: version (required)
588
+ :type version: str
589
+ :param resource_id: The ID of the resource to be requested. (required)
590
+ :type resource_id: str
591
+ :param x_platform_id: Platform ID.
592
+ :type x_platform_id: str
593
+ :param _request_timeout: timeout setting for this request. If one
594
+ number provided, it will be total request
595
+ timeout. It can also be a pair (tuple) of
596
+ (connection, read) timeouts.
597
+ :type _request_timeout: int, tuple(int, int), optional
598
+ :param _request_auth: set to override the auth_settings for an a single
599
+ request; this effectively ignores the
600
+ authentication in the spec for a single request.
601
+ :type _request_auth: dict, optional
602
+ :param _content_type: force content-type for the request.
603
+ :type _content_type: str, Optional
604
+ :param _headers: set to override the headers for a single
605
+ request; this effectively ignores the headers
606
+ in the spec for a single request.
607
+ :type _headers: dict, optional
608
+ :param _host_index: set to override the host_index for a single
609
+ request; this effectively ignores the host_index
610
+ in the spec for a single request.
611
+ :type _host_index: int, optional
612
+ :return: Returns the result object.
613
+ """ # noqa: E501
614
+
615
+ _param = self._get_report_generate_requests_by_resource_id_serialize(
616
+ version=version,
617
+ resource_id=resource_id,
618
+ x_platform_id=x_platform_id,
619
+ _request_auth=_request_auth,
620
+ _content_type=_content_type,
621
+ _headers=_headers,
622
+ _host_index=_host_index
623
+ )
624
+
625
+ _response_types_map: Dict[str, Optional[str]] = {
626
+ '200': "ReportGenerateRequest",
627
+ '400': "ApiError",
628
+ '401': "ApiError",
629
+ '403': "ApiError",
630
+ '500': "ApiError",
631
+ }
632
+ response_data = self.api_client.call_api(
633
+ *_param,
634
+ _request_timeout=_request_timeout
635
+ )
636
+ return response_data.response
637
+
638
+
639
+ def _get_report_generate_requests_by_resource_id_serialize(
640
+ self,
641
+ version,
642
+ resource_id,
643
+ x_platform_id,
644
+ _request_auth,
645
+ _content_type,
646
+ _headers,
647
+ _host_index,
648
+ ) -> RequestSerialized:
649
+
650
+ _host = None
651
+
652
+ _collection_formats: Dict[str, str] = {
653
+ }
654
+
655
+ _path_params: Dict[str, str] = {}
656
+ _query_params: List[Tuple[str, str]] = []
657
+ _header_params: Dict[str, Optional[str]] = _headers or {}
658
+ _form_params: List[Tuple[str, str]] = []
659
+ _files: Dict[
660
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
661
+ ] = {}
662
+ _body_params: Optional[bytes] = None
663
+
664
+ # process the path parameters
665
+ if version is not None:
666
+ _path_params['version'] = version
667
+ if resource_id is not None:
668
+ _path_params['resourceId'] = resource_id
669
+ # process the query parameters
670
+ # process the header parameters
671
+ if x_platform_id is not None:
672
+ _header_params['x-platform-id'] = x_platform_id
673
+ # process the form parameters
674
+ # process the body parameter
675
+
676
+
677
+ # set the HTTP header `Accept`
678
+ if 'Accept' not in _header_params:
679
+ _header_params['Accept'] = self.api_client.select_header_accept(
680
+ [
681
+ 'application/json',
682
+ '*/*'
683
+ ]
684
+ )
685
+
686
+
687
+ # authentication setting
688
+ _auth_settings: List[str] = [
689
+ 'JWT-Authentication',
690
+ 'API-Key'
691
+ ]
692
+
693
+ return self.api_client.param_serialize(
694
+ method='GET',
695
+ resource_path='/v{version}/report-generate-requests/{resourceId}',
696
+ path_params=_path_params,
697
+ query_params=_query_params,
698
+ header_params=_header_params,
699
+ body=_body_params,
700
+ post_params=_form_params,
701
+ files=_files,
702
+ auth_settings=_auth_settings,
703
+ collection_formats=_collection_formats,
704
+ _host=_host,
705
+ _request_auth=_request_auth
706
+ )
707
+
708
+
709
+
710
+
711
+ @validate_call
712
+ def get_report_generate_requests_by_resource_id_report(
713
+ self,
714
+ version: Annotated[StrictStr, Field(description="version")],
715
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
716
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
717
+ _request_timeout: Union[
718
+ None,
719
+ Annotated[StrictFloat, Field(gt=0)],
720
+ Tuple[
721
+ Annotated[StrictFloat, Field(gt=0)],
722
+ Annotated[StrictFloat, Field(gt=0)]
723
+ ]
724
+ ] = None,
725
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
726
+ _content_type: Optional[StrictStr] = None,
727
+ _headers: Optional[Dict[StrictStr, Any]] = None,
728
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
729
+ ) -> Report:
730
+ """Get Report
731
+
732
+ Requires the REPORT.VIEW permission.
733
+
734
+ :param version: version (required)
735
+ :type version: str
736
+ :param resource_id: The ID of the resource to be requested. (required)
737
+ :type resource_id: str
738
+ :param x_platform_id: Platform ID.
739
+ :type x_platform_id: str
740
+ :param _request_timeout: timeout setting for this request. If one
741
+ number provided, it will be total request
742
+ timeout. It can also be a pair (tuple) of
743
+ (connection, read) timeouts.
744
+ :type _request_timeout: int, tuple(int, int), optional
745
+ :param _request_auth: set to override the auth_settings for an a single
746
+ request; this effectively ignores the
747
+ authentication in the spec for a single request.
748
+ :type _request_auth: dict, optional
749
+ :param _content_type: force content-type for the request.
750
+ :type _content_type: str, Optional
751
+ :param _headers: set to override the headers for a single
752
+ request; this effectively ignores the headers
753
+ in the spec for a single request.
754
+ :type _headers: dict, optional
755
+ :param _host_index: set to override the host_index for a single
756
+ request; this effectively ignores the host_index
757
+ in the spec for a single request.
758
+ :type _host_index: int, optional
759
+ :return: Returns the result object.
760
+ """ # noqa: E501
761
+
762
+ _param = self._get_report_generate_requests_by_resource_id_report_serialize(
763
+ version=version,
764
+ resource_id=resource_id,
765
+ x_platform_id=x_platform_id,
766
+ _request_auth=_request_auth,
767
+ _content_type=_content_type,
768
+ _headers=_headers,
769
+ _host_index=_host_index
770
+ )
771
+
772
+ _response_types_map: Dict[str, Optional[str]] = {
773
+ '200': "Report",
774
+ '400': "ApiError",
775
+ '401': "ApiError",
776
+ '403': "ApiError",
777
+ '500': "ApiError",
778
+ }
779
+ response_data = self.api_client.call_api(
780
+ *_param,
781
+ _request_timeout=_request_timeout
782
+ )
783
+ response_data.read()
784
+ return self.api_client.response_deserialize(
785
+ response_data=response_data,
786
+ response_types_map=_response_types_map,
787
+ ).data
788
+
789
+
790
+ @validate_call
791
+ def get_report_generate_requests_by_resource_id_report_with_http_info(
792
+ self,
793
+ version: Annotated[StrictStr, Field(description="version")],
794
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
795
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
796
+ _request_timeout: Union[
797
+ None,
798
+ Annotated[StrictFloat, Field(gt=0)],
799
+ Tuple[
800
+ Annotated[StrictFloat, Field(gt=0)],
801
+ Annotated[StrictFloat, Field(gt=0)]
802
+ ]
803
+ ] = None,
804
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
805
+ _content_type: Optional[StrictStr] = None,
806
+ _headers: Optional[Dict[StrictStr, Any]] = None,
807
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
808
+ ) -> ApiResponse[Report]:
809
+ """Get Report
810
+
811
+ Requires the REPORT.VIEW permission.
812
+
813
+ :param version: version (required)
814
+ :type version: str
815
+ :param resource_id: The ID of the resource to be requested. (required)
816
+ :type resource_id: str
817
+ :param x_platform_id: Platform ID.
818
+ :type x_platform_id: str
819
+ :param _request_timeout: timeout setting for this request. If one
820
+ number provided, it will be total request
821
+ timeout. It can also be a pair (tuple) of
822
+ (connection, read) timeouts.
823
+ :type _request_timeout: int, tuple(int, int), optional
824
+ :param _request_auth: set to override the auth_settings for an a single
825
+ request; this effectively ignores the
826
+ authentication in the spec for a single request.
827
+ :type _request_auth: dict, optional
828
+ :param _content_type: force content-type for the request.
829
+ :type _content_type: str, Optional
830
+ :param _headers: set to override the headers for a single
831
+ request; this effectively ignores the headers
832
+ in the spec for a single request.
833
+ :type _headers: dict, optional
834
+ :param _host_index: set to override the host_index for a single
835
+ request; this effectively ignores the host_index
836
+ in the spec for a single request.
837
+ :type _host_index: int, optional
838
+ :return: Returns the result object.
839
+ """ # noqa: E501
840
+
841
+ _param = self._get_report_generate_requests_by_resource_id_report_serialize(
842
+ version=version,
843
+ resource_id=resource_id,
844
+ x_platform_id=x_platform_id,
845
+ _request_auth=_request_auth,
846
+ _content_type=_content_type,
847
+ _headers=_headers,
848
+ _host_index=_host_index
849
+ )
850
+
851
+ _response_types_map: Dict[str, Optional[str]] = {
852
+ '200': "Report",
853
+ '400': "ApiError",
854
+ '401': "ApiError",
855
+ '403': "ApiError",
856
+ '500': "ApiError",
857
+ }
858
+ response_data = self.api_client.call_api(
859
+ *_param,
860
+ _request_timeout=_request_timeout
861
+ )
862
+ response_data.read()
863
+ return self.api_client.response_deserialize(
864
+ response_data=response_data,
865
+ response_types_map=_response_types_map,
866
+ )
867
+
868
+
869
+ @validate_call
870
+ def get_report_generate_requests_by_resource_id_report_without_preload_content(
871
+ self,
872
+ version: Annotated[StrictStr, Field(description="version")],
873
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
874
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
875
+ _request_timeout: Union[
876
+ None,
877
+ Annotated[StrictFloat, Field(gt=0)],
878
+ Tuple[
879
+ Annotated[StrictFloat, Field(gt=0)],
880
+ Annotated[StrictFloat, Field(gt=0)]
881
+ ]
882
+ ] = None,
883
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
884
+ _content_type: Optional[StrictStr] = None,
885
+ _headers: Optional[Dict[StrictStr, Any]] = None,
886
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
887
+ ) -> RESTResponseType:
888
+ """Get Report
889
+
890
+ Requires the REPORT.VIEW permission.
891
+
892
+ :param version: version (required)
893
+ :type version: str
894
+ :param resource_id: The ID of the resource to be requested. (required)
895
+ :type resource_id: str
896
+ :param x_platform_id: Platform ID.
897
+ :type x_platform_id: str
898
+ :param _request_timeout: timeout setting for this request. If one
899
+ number provided, it will be total request
900
+ timeout. It can also be a pair (tuple) of
901
+ (connection, read) timeouts.
902
+ :type _request_timeout: int, tuple(int, int), optional
903
+ :param _request_auth: set to override the auth_settings for an a single
904
+ request; this effectively ignores the
905
+ authentication in the spec for a single request.
906
+ :type _request_auth: dict, optional
907
+ :param _content_type: force content-type for the request.
908
+ :type _content_type: str, Optional
909
+ :param _headers: set to override the headers for a single
910
+ request; this effectively ignores the headers
911
+ in the spec for a single request.
912
+ :type _headers: dict, optional
913
+ :param _host_index: set to override the host_index for a single
914
+ request; this effectively ignores the host_index
915
+ in the spec for a single request.
916
+ :type _host_index: int, optional
917
+ :return: Returns the result object.
918
+ """ # noqa: E501
919
+
920
+ _param = self._get_report_generate_requests_by_resource_id_report_serialize(
921
+ version=version,
922
+ resource_id=resource_id,
923
+ x_platform_id=x_platform_id,
924
+ _request_auth=_request_auth,
925
+ _content_type=_content_type,
926
+ _headers=_headers,
927
+ _host_index=_host_index
928
+ )
929
+
930
+ _response_types_map: Dict[str, Optional[str]] = {
931
+ '200': "Report",
932
+ '400': "ApiError",
933
+ '401': "ApiError",
934
+ '403': "ApiError",
935
+ '500': "ApiError",
936
+ }
937
+ response_data = self.api_client.call_api(
938
+ *_param,
939
+ _request_timeout=_request_timeout
940
+ )
941
+ return response_data.response
942
+
943
+
944
+ def _get_report_generate_requests_by_resource_id_report_serialize(
945
+ self,
946
+ version,
947
+ resource_id,
948
+ x_platform_id,
949
+ _request_auth,
950
+ _content_type,
951
+ _headers,
952
+ _host_index,
953
+ ) -> RequestSerialized:
954
+
955
+ _host = None
956
+
957
+ _collection_formats: Dict[str, str] = {
958
+ }
959
+
960
+ _path_params: Dict[str, str] = {}
961
+ _query_params: List[Tuple[str, str]] = []
962
+ _header_params: Dict[str, Optional[str]] = _headers or {}
963
+ _form_params: List[Tuple[str, str]] = []
964
+ _files: Dict[
965
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
966
+ ] = {}
967
+ _body_params: Optional[bytes] = None
968
+
969
+ # process the path parameters
970
+ if version is not None:
971
+ _path_params['version'] = version
972
+ if resource_id is not None:
973
+ _path_params['resourceId'] = resource_id
974
+ # process the query parameters
975
+ # process the header parameters
976
+ if x_platform_id is not None:
977
+ _header_params['x-platform-id'] = x_platform_id
978
+ # process the form parameters
979
+ # process the body parameter
980
+
981
+
982
+ # set the HTTP header `Accept`
983
+ if 'Accept' not in _header_params:
984
+ _header_params['Accept'] = self.api_client.select_header_accept(
985
+ [
986
+ 'application/json',
987
+ '*/*'
988
+ ]
989
+ )
990
+
991
+
992
+ # authentication setting
993
+ _auth_settings: List[str] = [
994
+ 'JWT-Authentication',
995
+ 'API-Key'
996
+ ]
997
+
998
+ return self.api_client.param_serialize(
999
+ method='GET',
1000
+ resource_path='/v{version}/report-generate-requests/{resourceId}/report',
1001
+ path_params=_path_params,
1002
+ query_params=_query_params,
1003
+ header_params=_header_params,
1004
+ body=_body_params,
1005
+ post_params=_form_params,
1006
+ files=_files,
1007
+ auth_settings=_auth_settings,
1008
+ collection_formats=_collection_formats,
1009
+ _host=_host,
1010
+ _request_auth=_request_auth
1011
+ )
1012
+
1013
+
1014
+
1015
+
1016
+ @validate_call
1017
+ def get_reports(
1018
+ self,
1019
+ version: Annotated[StrictStr, Field(description="version")],
1020
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1021
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
1022
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
1023
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
1024
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
1025
+ _request_timeout: Union[
1026
+ None,
1027
+ Annotated[StrictFloat, Field(gt=0)],
1028
+ Tuple[
1029
+ Annotated[StrictFloat, Field(gt=0)],
1030
+ Annotated[StrictFloat, Field(gt=0)]
1031
+ ]
1032
+ ] = None,
1033
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1034
+ _content_type: Optional[StrictStr] = None,
1035
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1036
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1037
+ ) -> ReportResponseWrapper:
1038
+ """Get Reports
1039
+
1040
+ Requires the REPORT.VIEW permission.
1041
+
1042
+ :param version: version (required)
1043
+ :type version: str
1044
+ :param x_platform_id: Platform ID.
1045
+ :type x_platform_id: str
1046
+ :param limit: The amount of records shown in the list
1047
+ :type limit: int
1048
+ :param page: The page which is going to be shown
1049
+ :type page: int
1050
+ :param order_by: The parameter by which the response is ordered.
1051
+ :type order_by: str
1052
+ :param order_direction: The order direction by which the response is ordered.
1053
+ :type order_direction: str
1054
+ :param _request_timeout: timeout setting for this request. If one
1055
+ number provided, it will be total request
1056
+ timeout. It can also be a pair (tuple) of
1057
+ (connection, read) timeouts.
1058
+ :type _request_timeout: int, tuple(int, int), optional
1059
+ :param _request_auth: set to override the auth_settings for an a single
1060
+ request; this effectively ignores the
1061
+ authentication in the spec for a single request.
1062
+ :type _request_auth: dict, optional
1063
+ :param _content_type: force content-type for the request.
1064
+ :type _content_type: str, Optional
1065
+ :param _headers: set to override the headers for a single
1066
+ request; this effectively ignores the headers
1067
+ in the spec for a single request.
1068
+ :type _headers: dict, optional
1069
+ :param _host_index: set to override the host_index for a single
1070
+ request; this effectively ignores the host_index
1071
+ in the spec for a single request.
1072
+ :type _host_index: int, optional
1073
+ :return: Returns the result object.
1074
+ """ # noqa: E501
1075
+
1076
+ _param = self._get_reports_serialize(
1077
+ version=version,
1078
+ x_platform_id=x_platform_id,
1079
+ limit=limit,
1080
+ page=page,
1081
+ order_by=order_by,
1082
+ order_direction=order_direction,
1083
+ _request_auth=_request_auth,
1084
+ _content_type=_content_type,
1085
+ _headers=_headers,
1086
+ _host_index=_host_index
1087
+ )
1088
+
1089
+ _response_types_map: Dict[str, Optional[str]] = {
1090
+ '200': "ReportResponseWrapper",
1091
+ '400': "ApiError",
1092
+ '401': "ApiError",
1093
+ '403': "ApiError",
1094
+ '500': "ApiError",
1095
+ }
1096
+ response_data = self.api_client.call_api(
1097
+ *_param,
1098
+ _request_timeout=_request_timeout
1099
+ )
1100
+ response_data.read()
1101
+ return self.api_client.response_deserialize(
1102
+ response_data=response_data,
1103
+ response_types_map=_response_types_map,
1104
+ ).data
1105
+
1106
+
1107
+ @validate_call
1108
+ def get_reports_with_http_info(
1109
+ self,
1110
+ version: Annotated[StrictStr, Field(description="version")],
1111
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1112
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
1113
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
1114
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
1115
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
1116
+ _request_timeout: Union[
1117
+ None,
1118
+ Annotated[StrictFloat, Field(gt=0)],
1119
+ Tuple[
1120
+ Annotated[StrictFloat, Field(gt=0)],
1121
+ Annotated[StrictFloat, Field(gt=0)]
1122
+ ]
1123
+ ] = None,
1124
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1125
+ _content_type: Optional[StrictStr] = None,
1126
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1127
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1128
+ ) -> ApiResponse[ReportResponseWrapper]:
1129
+ """Get Reports
1130
+
1131
+ Requires the REPORT.VIEW permission.
1132
+
1133
+ :param version: version (required)
1134
+ :type version: str
1135
+ :param x_platform_id: Platform ID.
1136
+ :type x_platform_id: str
1137
+ :param limit: The amount of records shown in the list
1138
+ :type limit: int
1139
+ :param page: The page which is going to be shown
1140
+ :type page: int
1141
+ :param order_by: The parameter by which the response is ordered.
1142
+ :type order_by: str
1143
+ :param order_direction: The order direction by which the response is ordered.
1144
+ :type order_direction: str
1145
+ :param _request_timeout: timeout setting for this request. If one
1146
+ number provided, it will be total request
1147
+ timeout. It can also be a pair (tuple) of
1148
+ (connection, read) timeouts.
1149
+ :type _request_timeout: int, tuple(int, int), optional
1150
+ :param _request_auth: set to override the auth_settings for an a single
1151
+ request; this effectively ignores the
1152
+ authentication in the spec for a single request.
1153
+ :type _request_auth: dict, optional
1154
+ :param _content_type: force content-type for the request.
1155
+ :type _content_type: str, Optional
1156
+ :param _headers: set to override the headers for a single
1157
+ request; this effectively ignores the headers
1158
+ in the spec for a single request.
1159
+ :type _headers: dict, optional
1160
+ :param _host_index: set to override the host_index for a single
1161
+ request; this effectively ignores the host_index
1162
+ in the spec for a single request.
1163
+ :type _host_index: int, optional
1164
+ :return: Returns the result object.
1165
+ """ # noqa: E501
1166
+
1167
+ _param = self._get_reports_serialize(
1168
+ version=version,
1169
+ x_platform_id=x_platform_id,
1170
+ limit=limit,
1171
+ page=page,
1172
+ order_by=order_by,
1173
+ order_direction=order_direction,
1174
+ _request_auth=_request_auth,
1175
+ _content_type=_content_type,
1176
+ _headers=_headers,
1177
+ _host_index=_host_index
1178
+ )
1179
+
1180
+ _response_types_map: Dict[str, Optional[str]] = {
1181
+ '200': "ReportResponseWrapper",
1182
+ '400': "ApiError",
1183
+ '401': "ApiError",
1184
+ '403': "ApiError",
1185
+ '500': "ApiError",
1186
+ }
1187
+ response_data = self.api_client.call_api(
1188
+ *_param,
1189
+ _request_timeout=_request_timeout
1190
+ )
1191
+ response_data.read()
1192
+ return self.api_client.response_deserialize(
1193
+ response_data=response_data,
1194
+ response_types_map=_response_types_map,
1195
+ )
1196
+
1197
+
1198
+ @validate_call
1199
+ def get_reports_without_preload_content(
1200
+ self,
1201
+ version: Annotated[StrictStr, Field(description="version")],
1202
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1203
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
1204
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
1205
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
1206
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
1207
+ _request_timeout: Union[
1208
+ None,
1209
+ Annotated[StrictFloat, Field(gt=0)],
1210
+ Tuple[
1211
+ Annotated[StrictFloat, Field(gt=0)],
1212
+ Annotated[StrictFloat, Field(gt=0)]
1213
+ ]
1214
+ ] = None,
1215
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1216
+ _content_type: Optional[StrictStr] = None,
1217
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1218
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1219
+ ) -> RESTResponseType:
1220
+ """Get Reports
1221
+
1222
+ Requires the REPORT.VIEW permission.
1223
+
1224
+ :param version: version (required)
1225
+ :type version: str
1226
+ :param x_platform_id: Platform ID.
1227
+ :type x_platform_id: str
1228
+ :param limit: The amount of records shown in the list
1229
+ :type limit: int
1230
+ :param page: The page which is going to be shown
1231
+ :type page: int
1232
+ :param order_by: The parameter by which the response is ordered.
1233
+ :type order_by: str
1234
+ :param order_direction: The order direction by which the response is ordered.
1235
+ :type order_direction: str
1236
+ :param _request_timeout: timeout setting for this request. If one
1237
+ number provided, it will be total request
1238
+ timeout. It can also be a pair (tuple) of
1239
+ (connection, read) timeouts.
1240
+ :type _request_timeout: int, tuple(int, int), optional
1241
+ :param _request_auth: set to override the auth_settings for an a single
1242
+ request; this effectively ignores the
1243
+ authentication in the spec for a single request.
1244
+ :type _request_auth: dict, optional
1245
+ :param _content_type: force content-type for the request.
1246
+ :type _content_type: str, Optional
1247
+ :param _headers: set to override the headers for a single
1248
+ request; this effectively ignores the headers
1249
+ in the spec for a single request.
1250
+ :type _headers: dict, optional
1251
+ :param _host_index: set to override the host_index for a single
1252
+ request; this effectively ignores the host_index
1253
+ in the spec for a single request.
1254
+ :type _host_index: int, optional
1255
+ :return: Returns the result object.
1256
+ """ # noqa: E501
1257
+
1258
+ _param = self._get_reports_serialize(
1259
+ version=version,
1260
+ x_platform_id=x_platform_id,
1261
+ limit=limit,
1262
+ page=page,
1263
+ order_by=order_by,
1264
+ order_direction=order_direction,
1265
+ _request_auth=_request_auth,
1266
+ _content_type=_content_type,
1267
+ _headers=_headers,
1268
+ _host_index=_host_index
1269
+ )
1270
+
1271
+ _response_types_map: Dict[str, Optional[str]] = {
1272
+ '200': "ReportResponseWrapper",
1273
+ '400': "ApiError",
1274
+ '401': "ApiError",
1275
+ '403': "ApiError",
1276
+ '500': "ApiError",
1277
+ }
1278
+ response_data = self.api_client.call_api(
1279
+ *_param,
1280
+ _request_timeout=_request_timeout
1281
+ )
1282
+ return response_data.response
1283
+
1284
+
1285
+ def _get_reports_serialize(
1286
+ self,
1287
+ version,
1288
+ x_platform_id,
1289
+ limit,
1290
+ page,
1291
+ order_by,
1292
+ order_direction,
1293
+ _request_auth,
1294
+ _content_type,
1295
+ _headers,
1296
+ _host_index,
1297
+ ) -> RequestSerialized:
1298
+
1299
+ _host = None
1300
+
1301
+ _collection_formats: Dict[str, str] = {
1302
+ }
1303
+
1304
+ _path_params: Dict[str, str] = {}
1305
+ _query_params: List[Tuple[str, str]] = []
1306
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1307
+ _form_params: List[Tuple[str, str]] = []
1308
+ _files: Dict[
1309
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1310
+ ] = {}
1311
+ _body_params: Optional[bytes] = None
1312
+
1313
+ # process the path parameters
1314
+ if version is not None:
1315
+ _path_params['version'] = version
1316
+ # process the query parameters
1317
+ if limit is not None:
1318
+
1319
+ _query_params.append(('limit', limit))
1320
+
1321
+ if page is not None:
1322
+
1323
+ _query_params.append(('page', page))
1324
+
1325
+ if order_by is not None:
1326
+
1327
+ _query_params.append(('order_by', order_by))
1328
+
1329
+ if order_direction is not None:
1330
+
1331
+ _query_params.append(('order_direction', order_direction))
1332
+
1333
+ # process the header parameters
1334
+ if x_platform_id is not None:
1335
+ _header_params['x-platform-id'] = x_platform_id
1336
+ # process the form parameters
1337
+ # process the body parameter
1338
+
1339
+
1340
+ # set the HTTP header `Accept`
1341
+ if 'Accept' not in _header_params:
1342
+ _header_params['Accept'] = self.api_client.select_header_accept(
1343
+ [
1344
+ 'application/json',
1345
+ '*/*'
1346
+ ]
1347
+ )
1348
+
1349
+
1350
+ # authentication setting
1351
+ _auth_settings: List[str] = [
1352
+ 'JWT-Authentication',
1353
+ 'API-Key'
1354
+ ]
1355
+
1356
+ return self.api_client.param_serialize(
1357
+ method='GET',
1358
+ resource_path='/v{version}/reports',
1359
+ path_params=_path_params,
1360
+ query_params=_query_params,
1361
+ header_params=_header_params,
1362
+ body=_body_params,
1363
+ post_params=_form_params,
1364
+ files=_files,
1365
+ auth_settings=_auth_settings,
1366
+ collection_formats=_collection_formats,
1367
+ _host=_host,
1368
+ _request_auth=_request_auth
1369
+ )
1370
+
1371
+
1372
+
1373
+
1374
+ @validate_call
1375
+ def get_reports_by_resource_id(
1376
+ self,
1377
+ version: Annotated[StrictStr, Field(description="version")],
1378
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1379
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1380
+ _request_timeout: Union[
1381
+ None,
1382
+ Annotated[StrictFloat, Field(gt=0)],
1383
+ Tuple[
1384
+ Annotated[StrictFloat, Field(gt=0)],
1385
+ Annotated[StrictFloat, Field(gt=0)]
1386
+ ]
1387
+ ] = None,
1388
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1389
+ _content_type: Optional[StrictStr] = None,
1390
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1391
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1392
+ ) -> Report:
1393
+ """Get report
1394
+
1395
+ Requires the REPORT.VIEW permission.
1396
+
1397
+ :param version: version (required)
1398
+ :type version: str
1399
+ :param resource_id: The ID of the resource to be requested. (required)
1400
+ :type resource_id: str
1401
+ :param x_platform_id: Platform ID.
1402
+ :type x_platform_id: str
1403
+ :param _request_timeout: timeout setting for this request. If one
1404
+ number provided, it will be total request
1405
+ timeout. It can also be a pair (tuple) of
1406
+ (connection, read) timeouts.
1407
+ :type _request_timeout: int, tuple(int, int), optional
1408
+ :param _request_auth: set to override the auth_settings for an a single
1409
+ request; this effectively ignores the
1410
+ authentication in the spec for a single request.
1411
+ :type _request_auth: dict, optional
1412
+ :param _content_type: force content-type for the request.
1413
+ :type _content_type: str, Optional
1414
+ :param _headers: set to override the headers for a single
1415
+ request; this effectively ignores the headers
1416
+ in the spec for a single request.
1417
+ :type _headers: dict, optional
1418
+ :param _host_index: set to override the host_index for a single
1419
+ request; this effectively ignores the host_index
1420
+ in the spec for a single request.
1421
+ :type _host_index: int, optional
1422
+ :return: Returns the result object.
1423
+ """ # noqa: E501
1424
+
1425
+ _param = self._get_reports_by_resource_id_serialize(
1426
+ version=version,
1427
+ resource_id=resource_id,
1428
+ x_platform_id=x_platform_id,
1429
+ _request_auth=_request_auth,
1430
+ _content_type=_content_type,
1431
+ _headers=_headers,
1432
+ _host_index=_host_index
1433
+ )
1434
+
1435
+ _response_types_map: Dict[str, Optional[str]] = {
1436
+ '200': "Report",
1437
+ '400': "ApiError",
1438
+ '401': "ApiError",
1439
+ '403': "ApiError",
1440
+ '500': "ApiError",
1441
+ }
1442
+ response_data = self.api_client.call_api(
1443
+ *_param,
1444
+ _request_timeout=_request_timeout
1445
+ )
1446
+ response_data.read()
1447
+ return self.api_client.response_deserialize(
1448
+ response_data=response_data,
1449
+ response_types_map=_response_types_map,
1450
+ ).data
1451
+
1452
+
1453
+ @validate_call
1454
+ def get_reports_by_resource_id_with_http_info(
1455
+ self,
1456
+ version: Annotated[StrictStr, Field(description="version")],
1457
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1458
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1459
+ _request_timeout: Union[
1460
+ None,
1461
+ Annotated[StrictFloat, Field(gt=0)],
1462
+ Tuple[
1463
+ Annotated[StrictFloat, Field(gt=0)],
1464
+ Annotated[StrictFloat, Field(gt=0)]
1465
+ ]
1466
+ ] = None,
1467
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1468
+ _content_type: Optional[StrictStr] = None,
1469
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1470
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1471
+ ) -> ApiResponse[Report]:
1472
+ """Get report
1473
+
1474
+ Requires the REPORT.VIEW permission.
1475
+
1476
+ :param version: version (required)
1477
+ :type version: str
1478
+ :param resource_id: The ID of the resource to be requested. (required)
1479
+ :type resource_id: str
1480
+ :param x_platform_id: Platform ID.
1481
+ :type x_platform_id: str
1482
+ :param _request_timeout: timeout setting for this request. If one
1483
+ number provided, it will be total request
1484
+ timeout. It can also be a pair (tuple) of
1485
+ (connection, read) timeouts.
1486
+ :type _request_timeout: int, tuple(int, int), optional
1487
+ :param _request_auth: set to override the auth_settings for an a single
1488
+ request; this effectively ignores the
1489
+ authentication in the spec for a single request.
1490
+ :type _request_auth: dict, optional
1491
+ :param _content_type: force content-type for the request.
1492
+ :type _content_type: str, Optional
1493
+ :param _headers: set to override the headers for a single
1494
+ request; this effectively ignores the headers
1495
+ in the spec for a single request.
1496
+ :type _headers: dict, optional
1497
+ :param _host_index: set to override the host_index for a single
1498
+ request; this effectively ignores the host_index
1499
+ in the spec for a single request.
1500
+ :type _host_index: int, optional
1501
+ :return: Returns the result object.
1502
+ """ # noqa: E501
1503
+
1504
+ _param = self._get_reports_by_resource_id_serialize(
1505
+ version=version,
1506
+ resource_id=resource_id,
1507
+ x_platform_id=x_platform_id,
1508
+ _request_auth=_request_auth,
1509
+ _content_type=_content_type,
1510
+ _headers=_headers,
1511
+ _host_index=_host_index
1512
+ )
1513
+
1514
+ _response_types_map: Dict[str, Optional[str]] = {
1515
+ '200': "Report",
1516
+ '400': "ApiError",
1517
+ '401': "ApiError",
1518
+ '403': "ApiError",
1519
+ '500': "ApiError",
1520
+ }
1521
+ response_data = self.api_client.call_api(
1522
+ *_param,
1523
+ _request_timeout=_request_timeout
1524
+ )
1525
+ response_data.read()
1526
+ return self.api_client.response_deserialize(
1527
+ response_data=response_data,
1528
+ response_types_map=_response_types_map,
1529
+ )
1530
+
1531
+
1532
+ @validate_call
1533
+ def get_reports_by_resource_id_without_preload_content(
1534
+ self,
1535
+ version: Annotated[StrictStr, Field(description="version")],
1536
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1537
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1538
+ _request_timeout: Union[
1539
+ None,
1540
+ Annotated[StrictFloat, Field(gt=0)],
1541
+ Tuple[
1542
+ Annotated[StrictFloat, Field(gt=0)],
1543
+ Annotated[StrictFloat, Field(gt=0)]
1544
+ ]
1545
+ ] = None,
1546
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1547
+ _content_type: Optional[StrictStr] = None,
1548
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1549
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1550
+ ) -> RESTResponseType:
1551
+ """Get report
1552
+
1553
+ Requires the REPORT.VIEW permission.
1554
+
1555
+ :param version: version (required)
1556
+ :type version: str
1557
+ :param resource_id: The ID of the resource to be requested. (required)
1558
+ :type resource_id: str
1559
+ :param x_platform_id: Platform ID.
1560
+ :type x_platform_id: str
1561
+ :param _request_timeout: timeout setting for this request. If one
1562
+ number provided, it will be total request
1563
+ timeout. It can also be a pair (tuple) of
1564
+ (connection, read) timeouts.
1565
+ :type _request_timeout: int, tuple(int, int), optional
1566
+ :param _request_auth: set to override the auth_settings for an a single
1567
+ request; this effectively ignores the
1568
+ authentication in the spec for a single request.
1569
+ :type _request_auth: dict, optional
1570
+ :param _content_type: force content-type for the request.
1571
+ :type _content_type: str, Optional
1572
+ :param _headers: set to override the headers for a single
1573
+ request; this effectively ignores the headers
1574
+ in the spec for a single request.
1575
+ :type _headers: dict, optional
1576
+ :param _host_index: set to override the host_index for a single
1577
+ request; this effectively ignores the host_index
1578
+ in the spec for a single request.
1579
+ :type _host_index: int, optional
1580
+ :return: Returns the result object.
1581
+ """ # noqa: E501
1582
+
1583
+ _param = self._get_reports_by_resource_id_serialize(
1584
+ version=version,
1585
+ resource_id=resource_id,
1586
+ x_platform_id=x_platform_id,
1587
+ _request_auth=_request_auth,
1588
+ _content_type=_content_type,
1589
+ _headers=_headers,
1590
+ _host_index=_host_index
1591
+ )
1592
+
1593
+ _response_types_map: Dict[str, Optional[str]] = {
1594
+ '200': "Report",
1595
+ '400': "ApiError",
1596
+ '401': "ApiError",
1597
+ '403': "ApiError",
1598
+ '500': "ApiError",
1599
+ }
1600
+ response_data = self.api_client.call_api(
1601
+ *_param,
1602
+ _request_timeout=_request_timeout
1603
+ )
1604
+ return response_data.response
1605
+
1606
+
1607
+ def _get_reports_by_resource_id_serialize(
1608
+ self,
1609
+ version,
1610
+ resource_id,
1611
+ x_platform_id,
1612
+ _request_auth,
1613
+ _content_type,
1614
+ _headers,
1615
+ _host_index,
1616
+ ) -> RequestSerialized:
1617
+
1618
+ _host = None
1619
+
1620
+ _collection_formats: Dict[str, str] = {
1621
+ }
1622
+
1623
+ _path_params: Dict[str, str] = {}
1624
+ _query_params: List[Tuple[str, str]] = []
1625
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1626
+ _form_params: List[Tuple[str, str]] = []
1627
+ _files: Dict[
1628
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1629
+ ] = {}
1630
+ _body_params: Optional[bytes] = None
1631
+
1632
+ # process the path parameters
1633
+ if version is not None:
1634
+ _path_params['version'] = version
1635
+ if resource_id is not None:
1636
+ _path_params['resourceId'] = resource_id
1637
+ # process the query parameters
1638
+ # process the header parameters
1639
+ if x_platform_id is not None:
1640
+ _header_params['x-platform-id'] = x_platform_id
1641
+ # process the form parameters
1642
+ # process the body parameter
1643
+
1644
+
1645
+ # set the HTTP header `Accept`
1646
+ if 'Accept' not in _header_params:
1647
+ _header_params['Accept'] = self.api_client.select_header_accept(
1648
+ [
1649
+ 'application/json',
1650
+ '*/*'
1651
+ ]
1652
+ )
1653
+
1654
+
1655
+ # authentication setting
1656
+ _auth_settings: List[str] = [
1657
+ 'JWT-Authentication',
1658
+ 'API-Key'
1659
+ ]
1660
+
1661
+ return self.api_client.param_serialize(
1662
+ method='GET',
1663
+ resource_path='/v{version}/reports/{resourceId}',
1664
+ path_params=_path_params,
1665
+ query_params=_query_params,
1666
+ header_params=_header_params,
1667
+ body=_body_params,
1668
+ post_params=_form_params,
1669
+ files=_files,
1670
+ auth_settings=_auth_settings,
1671
+ collection_formats=_collection_formats,
1672
+ _host=_host,
1673
+ _request_auth=_request_auth
1674
+ )
1675
+
1676
+
1677
+
1678
+
1679
+ @validate_call
1680
+ def get_reports_by_resource_id_download_url(
1681
+ self,
1682
+ version: Annotated[StrictStr, Field(description="version")],
1683
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1684
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1685
+ _request_timeout: Union[
1686
+ None,
1687
+ Annotated[StrictFloat, Field(gt=0)],
1688
+ Tuple[
1689
+ Annotated[StrictFloat, Field(gt=0)],
1690
+ Annotated[StrictFloat, Field(gt=0)]
1691
+ ]
1692
+ ] = None,
1693
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1694
+ _content_type: Optional[StrictStr] = None,
1695
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1696
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1697
+ ) -> DownloadUrl:
1698
+ """Get report download URL
1699
+
1700
+ Requires the REPORT.VIEW permission.
1701
+
1702
+ :param version: version (required)
1703
+ :type version: str
1704
+ :param resource_id: The ID of the resource to be requested. (required)
1705
+ :type resource_id: str
1706
+ :param x_platform_id: Platform ID.
1707
+ :type x_platform_id: str
1708
+ :param _request_timeout: timeout setting for this request. If one
1709
+ number provided, it will be total request
1710
+ timeout. It can also be a pair (tuple) of
1711
+ (connection, read) timeouts.
1712
+ :type _request_timeout: int, tuple(int, int), optional
1713
+ :param _request_auth: set to override the auth_settings for an a single
1714
+ request; this effectively ignores the
1715
+ authentication in the spec for a single request.
1716
+ :type _request_auth: dict, optional
1717
+ :param _content_type: force content-type for the request.
1718
+ :type _content_type: str, Optional
1719
+ :param _headers: set to override the headers for a single
1720
+ request; this effectively ignores the headers
1721
+ in the spec for a single request.
1722
+ :type _headers: dict, optional
1723
+ :param _host_index: set to override the host_index for a single
1724
+ request; this effectively ignores the host_index
1725
+ in the spec for a single request.
1726
+ :type _host_index: int, optional
1727
+ :return: Returns the result object.
1728
+ """ # noqa: E501
1729
+
1730
+ _param = self._get_reports_by_resource_id_download_url_serialize(
1731
+ version=version,
1732
+ resource_id=resource_id,
1733
+ x_platform_id=x_platform_id,
1734
+ _request_auth=_request_auth,
1735
+ _content_type=_content_type,
1736
+ _headers=_headers,
1737
+ _host_index=_host_index
1738
+ )
1739
+
1740
+ _response_types_map: Dict[str, Optional[str]] = {
1741
+ '200': "DownloadUrl",
1742
+ '400': "ApiError",
1743
+ '401': "ApiError",
1744
+ '403': "ApiError",
1745
+ '500': "ApiError",
1746
+ }
1747
+ response_data = self.api_client.call_api(
1748
+ *_param,
1749
+ _request_timeout=_request_timeout
1750
+ )
1751
+ response_data.read()
1752
+ return self.api_client.response_deserialize(
1753
+ response_data=response_data,
1754
+ response_types_map=_response_types_map,
1755
+ ).data
1756
+
1757
+
1758
+ @validate_call
1759
+ def get_reports_by_resource_id_download_url_with_http_info(
1760
+ self,
1761
+ version: Annotated[StrictStr, Field(description="version")],
1762
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1763
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1764
+ _request_timeout: Union[
1765
+ None,
1766
+ Annotated[StrictFloat, Field(gt=0)],
1767
+ Tuple[
1768
+ Annotated[StrictFloat, Field(gt=0)],
1769
+ Annotated[StrictFloat, Field(gt=0)]
1770
+ ]
1771
+ ] = None,
1772
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1773
+ _content_type: Optional[StrictStr] = None,
1774
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1775
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1776
+ ) -> ApiResponse[DownloadUrl]:
1777
+ """Get report download URL
1778
+
1779
+ Requires the REPORT.VIEW permission.
1780
+
1781
+ :param version: version (required)
1782
+ :type version: str
1783
+ :param resource_id: The ID of the resource to be requested. (required)
1784
+ :type resource_id: str
1785
+ :param x_platform_id: Platform ID.
1786
+ :type x_platform_id: str
1787
+ :param _request_timeout: timeout setting for this request. If one
1788
+ number provided, it will be total request
1789
+ timeout. It can also be a pair (tuple) of
1790
+ (connection, read) timeouts.
1791
+ :type _request_timeout: int, tuple(int, int), optional
1792
+ :param _request_auth: set to override the auth_settings for an a single
1793
+ request; this effectively ignores the
1794
+ authentication in the spec for a single request.
1795
+ :type _request_auth: dict, optional
1796
+ :param _content_type: force content-type for the request.
1797
+ :type _content_type: str, Optional
1798
+ :param _headers: set to override the headers for a single
1799
+ request; this effectively ignores the headers
1800
+ in the spec for a single request.
1801
+ :type _headers: dict, optional
1802
+ :param _host_index: set to override the host_index for a single
1803
+ request; this effectively ignores the host_index
1804
+ in the spec for a single request.
1805
+ :type _host_index: int, optional
1806
+ :return: Returns the result object.
1807
+ """ # noqa: E501
1808
+
1809
+ _param = self._get_reports_by_resource_id_download_url_serialize(
1810
+ version=version,
1811
+ resource_id=resource_id,
1812
+ x_platform_id=x_platform_id,
1813
+ _request_auth=_request_auth,
1814
+ _content_type=_content_type,
1815
+ _headers=_headers,
1816
+ _host_index=_host_index
1817
+ )
1818
+
1819
+ _response_types_map: Dict[str, Optional[str]] = {
1820
+ '200': "DownloadUrl",
1821
+ '400': "ApiError",
1822
+ '401': "ApiError",
1823
+ '403': "ApiError",
1824
+ '500': "ApiError",
1825
+ }
1826
+ response_data = self.api_client.call_api(
1827
+ *_param,
1828
+ _request_timeout=_request_timeout
1829
+ )
1830
+ response_data.read()
1831
+ return self.api_client.response_deserialize(
1832
+ response_data=response_data,
1833
+ response_types_map=_response_types_map,
1834
+ )
1835
+
1836
+
1837
+ @validate_call
1838
+ def get_reports_by_resource_id_download_url_without_preload_content(
1839
+ self,
1840
+ version: Annotated[StrictStr, Field(description="version")],
1841
+ resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
1842
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1843
+ _request_timeout: Union[
1844
+ None,
1845
+ Annotated[StrictFloat, Field(gt=0)],
1846
+ Tuple[
1847
+ Annotated[StrictFloat, Field(gt=0)],
1848
+ Annotated[StrictFloat, Field(gt=0)]
1849
+ ]
1850
+ ] = None,
1851
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1852
+ _content_type: Optional[StrictStr] = None,
1853
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1854
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1855
+ ) -> RESTResponseType:
1856
+ """Get report download URL
1857
+
1858
+ Requires the REPORT.VIEW permission.
1859
+
1860
+ :param version: version (required)
1861
+ :type version: str
1862
+ :param resource_id: The ID of the resource to be requested. (required)
1863
+ :type resource_id: str
1864
+ :param x_platform_id: Platform ID.
1865
+ :type x_platform_id: str
1866
+ :param _request_timeout: timeout setting for this request. If one
1867
+ number provided, it will be total request
1868
+ timeout. It can also be a pair (tuple) of
1869
+ (connection, read) timeouts.
1870
+ :type _request_timeout: int, tuple(int, int), optional
1871
+ :param _request_auth: set to override the auth_settings for an a single
1872
+ request; this effectively ignores the
1873
+ authentication in the spec for a single request.
1874
+ :type _request_auth: dict, optional
1875
+ :param _content_type: force content-type for the request.
1876
+ :type _content_type: str, Optional
1877
+ :param _headers: set to override the headers for a single
1878
+ request; this effectively ignores the headers
1879
+ in the spec for a single request.
1880
+ :type _headers: dict, optional
1881
+ :param _host_index: set to override the host_index for a single
1882
+ request; this effectively ignores the host_index
1883
+ in the spec for a single request.
1884
+ :type _host_index: int, optional
1885
+ :return: Returns the result object.
1886
+ """ # noqa: E501
1887
+
1888
+ _param = self._get_reports_by_resource_id_download_url_serialize(
1889
+ version=version,
1890
+ resource_id=resource_id,
1891
+ x_platform_id=x_platform_id,
1892
+ _request_auth=_request_auth,
1893
+ _content_type=_content_type,
1894
+ _headers=_headers,
1895
+ _host_index=_host_index
1896
+ )
1897
+
1898
+ _response_types_map: Dict[str, Optional[str]] = {
1899
+ '200': "DownloadUrl",
1900
+ '400': "ApiError",
1901
+ '401': "ApiError",
1902
+ '403': "ApiError",
1903
+ '500': "ApiError",
1904
+ }
1905
+ response_data = self.api_client.call_api(
1906
+ *_param,
1907
+ _request_timeout=_request_timeout
1908
+ )
1909
+ return response_data.response
1910
+
1911
+
1912
+ def _get_reports_by_resource_id_download_url_serialize(
1913
+ self,
1914
+ version,
1915
+ resource_id,
1916
+ x_platform_id,
1917
+ _request_auth,
1918
+ _content_type,
1919
+ _headers,
1920
+ _host_index,
1921
+ ) -> RequestSerialized:
1922
+
1923
+ _host = None
1924
+
1925
+ _collection_formats: Dict[str, str] = {
1926
+ }
1927
+
1928
+ _path_params: Dict[str, str] = {}
1929
+ _query_params: List[Tuple[str, str]] = []
1930
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1931
+ _form_params: List[Tuple[str, str]] = []
1932
+ _files: Dict[
1933
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1934
+ ] = {}
1935
+ _body_params: Optional[bytes] = None
1936
+
1937
+ # process the path parameters
1938
+ if version is not None:
1939
+ _path_params['version'] = version
1940
+ if resource_id is not None:
1941
+ _path_params['resourceId'] = resource_id
1942
+ # process the query parameters
1943
+ # process the header parameters
1944
+ if x_platform_id is not None:
1945
+ _header_params['x-platform-id'] = x_platform_id
1946
+ # process the form parameters
1947
+ # process the body parameter
1948
+
1949
+
1950
+ # set the HTTP header `Accept`
1951
+ if 'Accept' not in _header_params:
1952
+ _header_params['Accept'] = self.api_client.select_header_accept(
1953
+ [
1954
+ 'application/json',
1955
+ '*/*'
1956
+ ]
1957
+ )
1958
+
1959
+
1960
+ # authentication setting
1961
+ _auth_settings: List[str] = [
1962
+ 'JWT-Authentication',
1963
+ 'API-Key'
1964
+ ]
1965
+
1966
+ return self.api_client.param_serialize(
1967
+ method='GET',
1968
+ resource_path='/v{version}/reports/{resourceId}/download-url',
1969
+ path_params=_path_params,
1970
+ query_params=_query_params,
1971
+ header_params=_header_params,
1972
+ body=_body_params,
1973
+ post_params=_form_params,
1974
+ files=_files,
1975
+ auth_settings=_auth_settings,
1976
+ collection_formats=_collection_formats,
1977
+ _host=_host,
1978
+ _request_auth=_request_auth
1979
+ )
1980
+
1981
+
1982
+
1983
+
1984
+ @validate_call
1985
+ def get_reports_invoice_headers_overview(
1986
+ self,
1987
+ version: Annotated[StrictStr, Field(description="version")],
1988
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
1989
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
1990
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
1991
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
1992
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
1993
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
1994
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
1995
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
1996
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
1997
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
1998
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
1999
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2000
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2001
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2002
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2003
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2004
+ _request_timeout: Union[
2005
+ None,
2006
+ Annotated[StrictFloat, Field(gt=0)],
2007
+ Tuple[
2008
+ Annotated[StrictFloat, Field(gt=0)],
2009
+ Annotated[StrictFloat, Field(gt=0)]
2010
+ ]
2011
+ ] = None,
2012
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2013
+ _content_type: Optional[StrictStr] = None,
2014
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2015
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2016
+ ) -> ReportGenerateRequest:
2017
+ """Get invoice header report
2018
+
2019
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2020
+
2021
+ :param version: version (required)
2022
+ :type version: str
2023
+ :param x_platform_id: Platform ID.
2024
+ :type x_platform_id: str
2025
+ :param customer_id: Filter based of customer ID
2026
+ :type customer_id: str
2027
+ :param statuses: Filter invoices based on invoice status(es)
2028
+ :type statuses: List[str]
2029
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2030
+ :type workflow_action_execution_statuses: List[str]
2031
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2032
+ :type invoice_date: str
2033
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2034
+ :type paid: str
2035
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2036
+ :type on_hold: str
2037
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2038
+ :type pricing_plan_subscription_id: str
2039
+ :param product_id: Filter invoices containing a product resource id
2040
+ :type product_id: str
2041
+ :param product_item_id: Filter invoices containing a product item resource id
2042
+ :type product_item_id: str
2043
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2044
+ :type include_periods: bool
2045
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2046
+ :type include_lines: bool
2047
+ :param limit: The amount of records shown in the list
2048
+ :type limit: int
2049
+ :param page: The page which is going to be shown
2050
+ :type page: int
2051
+ :param order_by: The parameter by which the response is ordered.
2052
+ :type order_by: str
2053
+ :param order_direction: The order direction by which the response is ordered.
2054
+ :type order_direction: str
2055
+ :param _request_timeout: timeout setting for this request. If one
2056
+ number provided, it will be total request
2057
+ timeout. It can also be a pair (tuple) of
2058
+ (connection, read) timeouts.
2059
+ :type _request_timeout: int, tuple(int, int), optional
2060
+ :param _request_auth: set to override the auth_settings for an a single
2061
+ request; this effectively ignores the
2062
+ authentication in the spec for a single request.
2063
+ :type _request_auth: dict, optional
2064
+ :param _content_type: force content-type for the request.
2065
+ :type _content_type: str, Optional
2066
+ :param _headers: set to override the headers for a single
2067
+ request; this effectively ignores the headers
2068
+ in the spec for a single request.
2069
+ :type _headers: dict, optional
2070
+ :param _host_index: set to override the host_index for a single
2071
+ request; this effectively ignores the host_index
2072
+ in the spec for a single request.
2073
+ :type _host_index: int, optional
2074
+ :return: Returns the result object.
2075
+ """ # noqa: E501
2076
+
2077
+ _param = self._get_reports_invoice_headers_overview_serialize(
2078
+ version=version,
2079
+ x_platform_id=x_platform_id,
2080
+ customer_id=customer_id,
2081
+ statuses=statuses,
2082
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2083
+ invoice_date=invoice_date,
2084
+ paid=paid,
2085
+ on_hold=on_hold,
2086
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2087
+ product_id=product_id,
2088
+ product_item_id=product_item_id,
2089
+ include_periods=include_periods,
2090
+ include_lines=include_lines,
2091
+ limit=limit,
2092
+ page=page,
2093
+ order_by=order_by,
2094
+ order_direction=order_direction,
2095
+ _request_auth=_request_auth,
2096
+ _content_type=_content_type,
2097
+ _headers=_headers,
2098
+ _host_index=_host_index
2099
+ )
2100
+
2101
+ _response_types_map: Dict[str, Optional[str]] = {
2102
+ '200': "ReportGenerateRequest",
2103
+ '400': "ApiError",
2104
+ '401': "ApiError",
2105
+ '403': "ApiError",
2106
+ '500': "ApiError",
2107
+ }
2108
+ response_data = self.api_client.call_api(
2109
+ *_param,
2110
+ _request_timeout=_request_timeout
2111
+ )
2112
+ response_data.read()
2113
+ return self.api_client.response_deserialize(
2114
+ response_data=response_data,
2115
+ response_types_map=_response_types_map,
2116
+ ).data
2117
+
2118
+
2119
+ @validate_call
2120
+ def get_reports_invoice_headers_overview_with_http_info(
2121
+ self,
2122
+ version: Annotated[StrictStr, Field(description="version")],
2123
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2124
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
2125
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
2126
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
2127
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
2128
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
2129
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
2130
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
2131
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
2132
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
2133
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
2134
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2135
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2136
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2137
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2138
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2139
+ _request_timeout: Union[
2140
+ None,
2141
+ Annotated[StrictFloat, Field(gt=0)],
2142
+ Tuple[
2143
+ Annotated[StrictFloat, Field(gt=0)],
2144
+ Annotated[StrictFloat, Field(gt=0)]
2145
+ ]
2146
+ ] = None,
2147
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2148
+ _content_type: Optional[StrictStr] = None,
2149
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2150
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2151
+ ) -> ApiResponse[ReportGenerateRequest]:
2152
+ """Get invoice header report
2153
+
2154
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2155
+
2156
+ :param version: version (required)
2157
+ :type version: str
2158
+ :param x_platform_id: Platform ID.
2159
+ :type x_platform_id: str
2160
+ :param customer_id: Filter based of customer ID
2161
+ :type customer_id: str
2162
+ :param statuses: Filter invoices based on invoice status(es)
2163
+ :type statuses: List[str]
2164
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2165
+ :type workflow_action_execution_statuses: List[str]
2166
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2167
+ :type invoice_date: str
2168
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2169
+ :type paid: str
2170
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2171
+ :type on_hold: str
2172
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2173
+ :type pricing_plan_subscription_id: str
2174
+ :param product_id: Filter invoices containing a product resource id
2175
+ :type product_id: str
2176
+ :param product_item_id: Filter invoices containing a product item resource id
2177
+ :type product_item_id: str
2178
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2179
+ :type include_periods: bool
2180
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2181
+ :type include_lines: bool
2182
+ :param limit: The amount of records shown in the list
2183
+ :type limit: int
2184
+ :param page: The page which is going to be shown
2185
+ :type page: int
2186
+ :param order_by: The parameter by which the response is ordered.
2187
+ :type order_by: str
2188
+ :param order_direction: The order direction by which the response is ordered.
2189
+ :type order_direction: str
2190
+ :param _request_timeout: timeout setting for this request. If one
2191
+ number provided, it will be total request
2192
+ timeout. It can also be a pair (tuple) of
2193
+ (connection, read) timeouts.
2194
+ :type _request_timeout: int, tuple(int, int), optional
2195
+ :param _request_auth: set to override the auth_settings for an a single
2196
+ request; this effectively ignores the
2197
+ authentication in the spec for a single request.
2198
+ :type _request_auth: dict, optional
2199
+ :param _content_type: force content-type for the request.
2200
+ :type _content_type: str, Optional
2201
+ :param _headers: set to override the headers for a single
2202
+ request; this effectively ignores the headers
2203
+ in the spec for a single request.
2204
+ :type _headers: dict, optional
2205
+ :param _host_index: set to override the host_index for a single
2206
+ request; this effectively ignores the host_index
2207
+ in the spec for a single request.
2208
+ :type _host_index: int, optional
2209
+ :return: Returns the result object.
2210
+ """ # noqa: E501
2211
+
2212
+ _param = self._get_reports_invoice_headers_overview_serialize(
2213
+ version=version,
2214
+ x_platform_id=x_platform_id,
2215
+ customer_id=customer_id,
2216
+ statuses=statuses,
2217
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2218
+ invoice_date=invoice_date,
2219
+ paid=paid,
2220
+ on_hold=on_hold,
2221
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2222
+ product_id=product_id,
2223
+ product_item_id=product_item_id,
2224
+ include_periods=include_periods,
2225
+ include_lines=include_lines,
2226
+ limit=limit,
2227
+ page=page,
2228
+ order_by=order_by,
2229
+ order_direction=order_direction,
2230
+ _request_auth=_request_auth,
2231
+ _content_type=_content_type,
2232
+ _headers=_headers,
2233
+ _host_index=_host_index
2234
+ )
2235
+
2236
+ _response_types_map: Dict[str, Optional[str]] = {
2237
+ '200': "ReportGenerateRequest",
2238
+ '400': "ApiError",
2239
+ '401': "ApiError",
2240
+ '403': "ApiError",
2241
+ '500': "ApiError",
2242
+ }
2243
+ response_data = self.api_client.call_api(
2244
+ *_param,
2245
+ _request_timeout=_request_timeout
2246
+ )
2247
+ response_data.read()
2248
+ return self.api_client.response_deserialize(
2249
+ response_data=response_data,
2250
+ response_types_map=_response_types_map,
2251
+ )
2252
+
2253
+
2254
+ @validate_call
2255
+ def get_reports_invoice_headers_overview_without_preload_content(
2256
+ self,
2257
+ version: Annotated[StrictStr, Field(description="version")],
2258
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2259
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
2260
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
2261
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
2262
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
2263
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
2264
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
2265
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
2266
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
2267
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
2268
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
2269
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2270
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2271
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2272
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2273
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2274
+ _request_timeout: Union[
2275
+ None,
2276
+ Annotated[StrictFloat, Field(gt=0)],
2277
+ Tuple[
2278
+ Annotated[StrictFloat, Field(gt=0)],
2279
+ Annotated[StrictFloat, Field(gt=0)]
2280
+ ]
2281
+ ] = None,
2282
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2283
+ _content_type: Optional[StrictStr] = None,
2284
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2285
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2286
+ ) -> RESTResponseType:
2287
+ """Get invoice header report
2288
+
2289
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2290
+
2291
+ :param version: version (required)
2292
+ :type version: str
2293
+ :param x_platform_id: Platform ID.
2294
+ :type x_platform_id: str
2295
+ :param customer_id: Filter based of customer ID
2296
+ :type customer_id: str
2297
+ :param statuses: Filter invoices based on invoice status(es)
2298
+ :type statuses: List[str]
2299
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2300
+ :type workflow_action_execution_statuses: List[str]
2301
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2302
+ :type invoice_date: str
2303
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2304
+ :type paid: str
2305
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2306
+ :type on_hold: str
2307
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2308
+ :type pricing_plan_subscription_id: str
2309
+ :param product_id: Filter invoices containing a product resource id
2310
+ :type product_id: str
2311
+ :param product_item_id: Filter invoices containing a product item resource id
2312
+ :type product_item_id: str
2313
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2314
+ :type include_periods: bool
2315
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2316
+ :type include_lines: bool
2317
+ :param limit: The amount of records shown in the list
2318
+ :type limit: int
2319
+ :param page: The page which is going to be shown
2320
+ :type page: int
2321
+ :param order_by: The parameter by which the response is ordered.
2322
+ :type order_by: str
2323
+ :param order_direction: The order direction by which the response is ordered.
2324
+ :type order_direction: str
2325
+ :param _request_timeout: timeout setting for this request. If one
2326
+ number provided, it will be total request
2327
+ timeout. It can also be a pair (tuple) of
2328
+ (connection, read) timeouts.
2329
+ :type _request_timeout: int, tuple(int, int), optional
2330
+ :param _request_auth: set to override the auth_settings for an a single
2331
+ request; this effectively ignores the
2332
+ authentication in the spec for a single request.
2333
+ :type _request_auth: dict, optional
2334
+ :param _content_type: force content-type for the request.
2335
+ :type _content_type: str, Optional
2336
+ :param _headers: set to override the headers for a single
2337
+ request; this effectively ignores the headers
2338
+ in the spec for a single request.
2339
+ :type _headers: dict, optional
2340
+ :param _host_index: set to override the host_index for a single
2341
+ request; this effectively ignores the host_index
2342
+ in the spec for a single request.
2343
+ :type _host_index: int, optional
2344
+ :return: Returns the result object.
2345
+ """ # noqa: E501
2346
+
2347
+ _param = self._get_reports_invoice_headers_overview_serialize(
2348
+ version=version,
2349
+ x_platform_id=x_platform_id,
2350
+ customer_id=customer_id,
2351
+ statuses=statuses,
2352
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2353
+ invoice_date=invoice_date,
2354
+ paid=paid,
2355
+ on_hold=on_hold,
2356
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2357
+ product_id=product_id,
2358
+ product_item_id=product_item_id,
2359
+ include_periods=include_periods,
2360
+ include_lines=include_lines,
2361
+ limit=limit,
2362
+ page=page,
2363
+ order_by=order_by,
2364
+ order_direction=order_direction,
2365
+ _request_auth=_request_auth,
2366
+ _content_type=_content_type,
2367
+ _headers=_headers,
2368
+ _host_index=_host_index
2369
+ )
2370
+
2371
+ _response_types_map: Dict[str, Optional[str]] = {
2372
+ '200': "ReportGenerateRequest",
2373
+ '400': "ApiError",
2374
+ '401': "ApiError",
2375
+ '403': "ApiError",
2376
+ '500': "ApiError",
2377
+ }
2378
+ response_data = self.api_client.call_api(
2379
+ *_param,
2380
+ _request_timeout=_request_timeout
2381
+ )
2382
+ return response_data.response
2383
+
2384
+
2385
+ def _get_reports_invoice_headers_overview_serialize(
2386
+ self,
2387
+ version,
2388
+ x_platform_id,
2389
+ customer_id,
2390
+ statuses,
2391
+ workflow_action_execution_statuses,
2392
+ invoice_date,
2393
+ paid,
2394
+ on_hold,
2395
+ pricing_plan_subscription_id,
2396
+ product_id,
2397
+ product_item_id,
2398
+ include_periods,
2399
+ include_lines,
2400
+ limit,
2401
+ page,
2402
+ order_by,
2403
+ order_direction,
2404
+ _request_auth,
2405
+ _content_type,
2406
+ _headers,
2407
+ _host_index,
2408
+ ) -> RequestSerialized:
2409
+
2410
+ _host = None
2411
+
2412
+ _collection_formats: Dict[str, str] = {
2413
+ 'statuses[]': 'multi',
2414
+ 'workflow_action_execution_statuses[]': 'multi',
2415
+ }
2416
+
2417
+ _path_params: Dict[str, str] = {}
2418
+ _query_params: List[Tuple[str, str]] = []
2419
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2420
+ _form_params: List[Tuple[str, str]] = []
2421
+ _files: Dict[
2422
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2423
+ ] = {}
2424
+ _body_params: Optional[bytes] = None
2425
+
2426
+ # process the path parameters
2427
+ if version is not None:
2428
+ _path_params['version'] = version
2429
+ # process the query parameters
2430
+ if customer_id is not None:
2431
+
2432
+ _query_params.append(('customer_id', customer_id))
2433
+
2434
+ if statuses is not None:
2435
+
2436
+ _query_params.append(('statuses[]', statuses))
2437
+
2438
+ if workflow_action_execution_statuses is not None:
2439
+
2440
+ _query_params.append(('workflow_action_execution_statuses[]', workflow_action_execution_statuses))
2441
+
2442
+ if invoice_date is not None:
2443
+
2444
+ _query_params.append(('invoice_date', invoice_date))
2445
+
2446
+ if paid is not None:
2447
+
2448
+ _query_params.append(('paid', paid))
2449
+
2450
+ if on_hold is not None:
2451
+
2452
+ _query_params.append(('on_hold', on_hold))
2453
+
2454
+ if pricing_plan_subscription_id is not None:
2455
+
2456
+ _query_params.append(('pricing_plan_subscription_id', pricing_plan_subscription_id))
2457
+
2458
+ if product_id is not None:
2459
+
2460
+ _query_params.append(('product_id', product_id))
2461
+
2462
+ if product_item_id is not None:
2463
+
2464
+ _query_params.append(('product_item_id', product_item_id))
2465
+
2466
+ if include_periods is not None:
2467
+
2468
+ _query_params.append(('include_periods', include_periods))
2469
+
2470
+ if include_lines is not None:
2471
+
2472
+ _query_params.append(('include_lines', include_lines))
2473
+
2474
+ if limit is not None:
2475
+
2476
+ _query_params.append(('limit', limit))
2477
+
2478
+ if page is not None:
2479
+
2480
+ _query_params.append(('page', page))
2481
+
2482
+ if order_by is not None:
2483
+
2484
+ _query_params.append(('order_by', order_by))
2485
+
2486
+ if order_direction is not None:
2487
+
2488
+ _query_params.append(('order_direction', order_direction))
2489
+
2490
+ # process the header parameters
2491
+ if x_platform_id is not None:
2492
+ _header_params['x-platform-id'] = x_platform_id
2493
+ # process the form parameters
2494
+ # process the body parameter
2495
+
2496
+
2497
+ # set the HTTP header `Accept`
2498
+ if 'Accept' not in _header_params:
2499
+ _header_params['Accept'] = self.api_client.select_header_accept(
2500
+ [
2501
+ 'application/json',
2502
+ '*/*'
2503
+ ]
2504
+ )
2505
+
2506
+
2507
+ # authentication setting
2508
+ _auth_settings: List[str] = [
2509
+ 'JWT-Authentication',
2510
+ 'API-Key'
2511
+ ]
2512
+
2513
+ return self.api_client.param_serialize(
2514
+ method='GET',
2515
+ resource_path='/v{version}/reports/invoice-headers-overview',
2516
+ path_params=_path_params,
2517
+ query_params=_query_params,
2518
+ header_params=_header_params,
2519
+ body=_body_params,
2520
+ post_params=_form_params,
2521
+ files=_files,
2522
+ auth_settings=_auth_settings,
2523
+ collection_formats=_collection_formats,
2524
+ _host=_host,
2525
+ _request_auth=_request_auth
2526
+ )
2527
+
2528
+
2529
+
2530
+
2531
+ @validate_call
2532
+ def get_reports_invoice_lines_overview(
2533
+ self,
2534
+ version: Annotated[StrictStr, Field(description="version")],
2535
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2536
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
2537
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
2538
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
2539
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
2540
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
2541
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
2542
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
2543
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
2544
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
2545
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
2546
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2547
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2548
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2549
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2550
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2551
+ _request_timeout: Union[
2552
+ None,
2553
+ Annotated[StrictFloat, Field(gt=0)],
2554
+ Tuple[
2555
+ Annotated[StrictFloat, Field(gt=0)],
2556
+ Annotated[StrictFloat, Field(gt=0)]
2557
+ ]
2558
+ ] = None,
2559
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2560
+ _content_type: Optional[StrictStr] = None,
2561
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2562
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2563
+ ) -> ReportGenerateRequest:
2564
+ """Get invoice lines report
2565
+
2566
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2567
+
2568
+ :param version: version (required)
2569
+ :type version: str
2570
+ :param x_platform_id: Platform ID.
2571
+ :type x_platform_id: str
2572
+ :param customer_id: Filter based of customer ID
2573
+ :type customer_id: str
2574
+ :param statuses: Filter invoices based on invoice status(es)
2575
+ :type statuses: List[str]
2576
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2577
+ :type workflow_action_execution_statuses: List[str]
2578
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2579
+ :type invoice_date: str
2580
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2581
+ :type paid: str
2582
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2583
+ :type on_hold: str
2584
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2585
+ :type pricing_plan_subscription_id: str
2586
+ :param product_id: Filter invoices containing a product resource id
2587
+ :type product_id: str
2588
+ :param product_item_id: Filter invoices containing a product item resource id
2589
+ :type product_item_id: str
2590
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2591
+ :type include_periods: bool
2592
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2593
+ :type include_lines: bool
2594
+ :param limit: The amount of records shown in the list
2595
+ :type limit: int
2596
+ :param page: The page which is going to be shown
2597
+ :type page: int
2598
+ :param order_by: The parameter by which the response is ordered.
2599
+ :type order_by: str
2600
+ :param order_direction: The order direction by which the response is ordered.
2601
+ :type order_direction: str
2602
+ :param _request_timeout: timeout setting for this request. If one
2603
+ number provided, it will be total request
2604
+ timeout. It can also be a pair (tuple) of
2605
+ (connection, read) timeouts.
2606
+ :type _request_timeout: int, tuple(int, int), optional
2607
+ :param _request_auth: set to override the auth_settings for an a single
2608
+ request; this effectively ignores the
2609
+ authentication in the spec for a single request.
2610
+ :type _request_auth: dict, optional
2611
+ :param _content_type: force content-type for the request.
2612
+ :type _content_type: str, Optional
2613
+ :param _headers: set to override the headers for a single
2614
+ request; this effectively ignores the headers
2615
+ in the spec for a single request.
2616
+ :type _headers: dict, optional
2617
+ :param _host_index: set to override the host_index for a single
2618
+ request; this effectively ignores the host_index
2619
+ in the spec for a single request.
2620
+ :type _host_index: int, optional
2621
+ :return: Returns the result object.
2622
+ """ # noqa: E501
2623
+
2624
+ _param = self._get_reports_invoice_lines_overview_serialize(
2625
+ version=version,
2626
+ x_platform_id=x_platform_id,
2627
+ customer_id=customer_id,
2628
+ statuses=statuses,
2629
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2630
+ invoice_date=invoice_date,
2631
+ paid=paid,
2632
+ on_hold=on_hold,
2633
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2634
+ product_id=product_id,
2635
+ product_item_id=product_item_id,
2636
+ include_periods=include_periods,
2637
+ include_lines=include_lines,
2638
+ limit=limit,
2639
+ page=page,
2640
+ order_by=order_by,
2641
+ order_direction=order_direction,
2642
+ _request_auth=_request_auth,
2643
+ _content_type=_content_type,
2644
+ _headers=_headers,
2645
+ _host_index=_host_index
2646
+ )
2647
+
2648
+ _response_types_map: Dict[str, Optional[str]] = {
2649
+ '200': "ReportGenerateRequest",
2650
+ '400': "ApiError",
2651
+ '401': "ApiError",
2652
+ '403': "ApiError",
2653
+ '500': "ApiError",
2654
+ }
2655
+ response_data = self.api_client.call_api(
2656
+ *_param,
2657
+ _request_timeout=_request_timeout
2658
+ )
2659
+ response_data.read()
2660
+ return self.api_client.response_deserialize(
2661
+ response_data=response_data,
2662
+ response_types_map=_response_types_map,
2663
+ ).data
2664
+
2665
+
2666
+ @validate_call
2667
+ def get_reports_invoice_lines_overview_with_http_info(
2668
+ self,
2669
+ version: Annotated[StrictStr, Field(description="version")],
2670
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2671
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
2672
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
2673
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
2674
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
2675
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
2676
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
2677
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
2678
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
2679
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
2680
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
2681
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2682
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2683
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2684
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2685
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2686
+ _request_timeout: Union[
2687
+ None,
2688
+ Annotated[StrictFloat, Field(gt=0)],
2689
+ Tuple[
2690
+ Annotated[StrictFloat, Field(gt=0)],
2691
+ Annotated[StrictFloat, Field(gt=0)]
2692
+ ]
2693
+ ] = None,
2694
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2695
+ _content_type: Optional[StrictStr] = None,
2696
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2697
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2698
+ ) -> ApiResponse[ReportGenerateRequest]:
2699
+ """Get invoice lines report
2700
+
2701
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2702
+
2703
+ :param version: version (required)
2704
+ :type version: str
2705
+ :param x_platform_id: Platform ID.
2706
+ :type x_platform_id: str
2707
+ :param customer_id: Filter based of customer ID
2708
+ :type customer_id: str
2709
+ :param statuses: Filter invoices based on invoice status(es)
2710
+ :type statuses: List[str]
2711
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2712
+ :type workflow_action_execution_statuses: List[str]
2713
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2714
+ :type invoice_date: str
2715
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2716
+ :type paid: str
2717
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2718
+ :type on_hold: str
2719
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2720
+ :type pricing_plan_subscription_id: str
2721
+ :param product_id: Filter invoices containing a product resource id
2722
+ :type product_id: str
2723
+ :param product_item_id: Filter invoices containing a product item resource id
2724
+ :type product_item_id: str
2725
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2726
+ :type include_periods: bool
2727
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2728
+ :type include_lines: bool
2729
+ :param limit: The amount of records shown in the list
2730
+ :type limit: int
2731
+ :param page: The page which is going to be shown
2732
+ :type page: int
2733
+ :param order_by: The parameter by which the response is ordered.
2734
+ :type order_by: str
2735
+ :param order_direction: The order direction by which the response is ordered.
2736
+ :type order_direction: str
2737
+ :param _request_timeout: timeout setting for this request. If one
2738
+ number provided, it will be total request
2739
+ timeout. It can also be a pair (tuple) of
2740
+ (connection, read) timeouts.
2741
+ :type _request_timeout: int, tuple(int, int), optional
2742
+ :param _request_auth: set to override the auth_settings for an a single
2743
+ request; this effectively ignores the
2744
+ authentication in the spec for a single request.
2745
+ :type _request_auth: dict, optional
2746
+ :param _content_type: force content-type for the request.
2747
+ :type _content_type: str, Optional
2748
+ :param _headers: set to override the headers for a single
2749
+ request; this effectively ignores the headers
2750
+ in the spec for a single request.
2751
+ :type _headers: dict, optional
2752
+ :param _host_index: set to override the host_index for a single
2753
+ request; this effectively ignores the host_index
2754
+ in the spec for a single request.
2755
+ :type _host_index: int, optional
2756
+ :return: Returns the result object.
2757
+ """ # noqa: E501
2758
+
2759
+ _param = self._get_reports_invoice_lines_overview_serialize(
2760
+ version=version,
2761
+ x_platform_id=x_platform_id,
2762
+ customer_id=customer_id,
2763
+ statuses=statuses,
2764
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2765
+ invoice_date=invoice_date,
2766
+ paid=paid,
2767
+ on_hold=on_hold,
2768
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2769
+ product_id=product_id,
2770
+ product_item_id=product_item_id,
2771
+ include_periods=include_periods,
2772
+ include_lines=include_lines,
2773
+ limit=limit,
2774
+ page=page,
2775
+ order_by=order_by,
2776
+ order_direction=order_direction,
2777
+ _request_auth=_request_auth,
2778
+ _content_type=_content_type,
2779
+ _headers=_headers,
2780
+ _host_index=_host_index
2781
+ )
2782
+
2783
+ _response_types_map: Dict[str, Optional[str]] = {
2784
+ '200': "ReportGenerateRequest",
2785
+ '400': "ApiError",
2786
+ '401': "ApiError",
2787
+ '403': "ApiError",
2788
+ '500': "ApiError",
2789
+ }
2790
+ response_data = self.api_client.call_api(
2791
+ *_param,
2792
+ _request_timeout=_request_timeout
2793
+ )
2794
+ response_data.read()
2795
+ return self.api_client.response_deserialize(
2796
+ response_data=response_data,
2797
+ response_types_map=_response_types_map,
2798
+ )
2799
+
2800
+
2801
+ @validate_call
2802
+ def get_reports_invoice_lines_overview_without_preload_content(
2803
+ self,
2804
+ version: Annotated[StrictStr, Field(description="version")],
2805
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
2806
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
2807
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
2808
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
2809
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
2810
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
2811
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
2812
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
2813
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
2814
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
2815
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
2816
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
2817
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
2818
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
2819
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
2820
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
2821
+ _request_timeout: Union[
2822
+ None,
2823
+ Annotated[StrictFloat, Field(gt=0)],
2824
+ Tuple[
2825
+ Annotated[StrictFloat, Field(gt=0)],
2826
+ Annotated[StrictFloat, Field(gt=0)]
2827
+ ]
2828
+ ] = None,
2829
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2830
+ _content_type: Optional[StrictStr] = None,
2831
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2832
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2833
+ ) -> RESTResponseType:
2834
+ """Get invoice lines report
2835
+
2836
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
2837
+
2838
+ :param version: version (required)
2839
+ :type version: str
2840
+ :param x_platform_id: Platform ID.
2841
+ :type x_platform_id: str
2842
+ :param customer_id: Filter based of customer ID
2843
+ :type customer_id: str
2844
+ :param statuses: Filter invoices based on invoice status(es)
2845
+ :type statuses: List[str]
2846
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
2847
+ :type workflow_action_execution_statuses: List[str]
2848
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
2849
+ :type invoice_date: str
2850
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
2851
+ :type paid: str
2852
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
2853
+ :type on_hold: str
2854
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
2855
+ :type pricing_plan_subscription_id: str
2856
+ :param product_id: Filter invoices containing a product resource id
2857
+ :type product_id: str
2858
+ :param product_item_id: Filter invoices containing a product item resource id
2859
+ :type product_item_id: str
2860
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
2861
+ :type include_periods: bool
2862
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
2863
+ :type include_lines: bool
2864
+ :param limit: The amount of records shown in the list
2865
+ :type limit: int
2866
+ :param page: The page which is going to be shown
2867
+ :type page: int
2868
+ :param order_by: The parameter by which the response is ordered.
2869
+ :type order_by: str
2870
+ :param order_direction: The order direction by which the response is ordered.
2871
+ :type order_direction: str
2872
+ :param _request_timeout: timeout setting for this request. If one
2873
+ number provided, it will be total request
2874
+ timeout. It can also be a pair (tuple) of
2875
+ (connection, read) timeouts.
2876
+ :type _request_timeout: int, tuple(int, int), optional
2877
+ :param _request_auth: set to override the auth_settings for an a single
2878
+ request; this effectively ignores the
2879
+ authentication in the spec for a single request.
2880
+ :type _request_auth: dict, optional
2881
+ :param _content_type: force content-type for the request.
2882
+ :type _content_type: str, Optional
2883
+ :param _headers: set to override the headers for a single
2884
+ request; this effectively ignores the headers
2885
+ in the spec for a single request.
2886
+ :type _headers: dict, optional
2887
+ :param _host_index: set to override the host_index for a single
2888
+ request; this effectively ignores the host_index
2889
+ in the spec for a single request.
2890
+ :type _host_index: int, optional
2891
+ :return: Returns the result object.
2892
+ """ # noqa: E501
2893
+
2894
+ _param = self._get_reports_invoice_lines_overview_serialize(
2895
+ version=version,
2896
+ x_platform_id=x_platform_id,
2897
+ customer_id=customer_id,
2898
+ statuses=statuses,
2899
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
2900
+ invoice_date=invoice_date,
2901
+ paid=paid,
2902
+ on_hold=on_hold,
2903
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
2904
+ product_id=product_id,
2905
+ product_item_id=product_item_id,
2906
+ include_periods=include_periods,
2907
+ include_lines=include_lines,
2908
+ limit=limit,
2909
+ page=page,
2910
+ order_by=order_by,
2911
+ order_direction=order_direction,
2912
+ _request_auth=_request_auth,
2913
+ _content_type=_content_type,
2914
+ _headers=_headers,
2915
+ _host_index=_host_index
2916
+ )
2917
+
2918
+ _response_types_map: Dict[str, Optional[str]] = {
2919
+ '200': "ReportGenerateRequest",
2920
+ '400': "ApiError",
2921
+ '401': "ApiError",
2922
+ '403': "ApiError",
2923
+ '500': "ApiError",
2924
+ }
2925
+ response_data = self.api_client.call_api(
2926
+ *_param,
2927
+ _request_timeout=_request_timeout
2928
+ )
2929
+ return response_data.response
2930
+
2931
+
2932
+ def _get_reports_invoice_lines_overview_serialize(
2933
+ self,
2934
+ version,
2935
+ x_platform_id,
2936
+ customer_id,
2937
+ statuses,
2938
+ workflow_action_execution_statuses,
2939
+ invoice_date,
2940
+ paid,
2941
+ on_hold,
2942
+ pricing_plan_subscription_id,
2943
+ product_id,
2944
+ product_item_id,
2945
+ include_periods,
2946
+ include_lines,
2947
+ limit,
2948
+ page,
2949
+ order_by,
2950
+ order_direction,
2951
+ _request_auth,
2952
+ _content_type,
2953
+ _headers,
2954
+ _host_index,
2955
+ ) -> RequestSerialized:
2956
+
2957
+ _host = None
2958
+
2959
+ _collection_formats: Dict[str, str] = {
2960
+ 'statuses[]': 'multi',
2961
+ 'workflow_action_execution_statuses[]': 'multi',
2962
+ }
2963
+
2964
+ _path_params: Dict[str, str] = {}
2965
+ _query_params: List[Tuple[str, str]] = []
2966
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2967
+ _form_params: List[Tuple[str, str]] = []
2968
+ _files: Dict[
2969
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2970
+ ] = {}
2971
+ _body_params: Optional[bytes] = None
2972
+
2973
+ # process the path parameters
2974
+ if version is not None:
2975
+ _path_params['version'] = version
2976
+ # process the query parameters
2977
+ if customer_id is not None:
2978
+
2979
+ _query_params.append(('customer_id', customer_id))
2980
+
2981
+ if statuses is not None:
2982
+
2983
+ _query_params.append(('statuses[]', statuses))
2984
+
2985
+ if workflow_action_execution_statuses is not None:
2986
+
2987
+ _query_params.append(('workflow_action_execution_statuses[]', workflow_action_execution_statuses))
2988
+
2989
+ if invoice_date is not None:
2990
+
2991
+ _query_params.append(('invoice_date', invoice_date))
2992
+
2993
+ if paid is not None:
2994
+
2995
+ _query_params.append(('paid', paid))
2996
+
2997
+ if on_hold is not None:
2998
+
2999
+ _query_params.append(('on_hold', on_hold))
3000
+
3001
+ if pricing_plan_subscription_id is not None:
3002
+
3003
+ _query_params.append(('pricing_plan_subscription_id', pricing_plan_subscription_id))
3004
+
3005
+ if product_id is not None:
3006
+
3007
+ _query_params.append(('product_id', product_id))
3008
+
3009
+ if product_item_id is not None:
3010
+
3011
+ _query_params.append(('product_item_id', product_item_id))
3012
+
3013
+ if include_periods is not None:
3014
+
3015
+ _query_params.append(('include_periods', include_periods))
3016
+
3017
+ if include_lines is not None:
3018
+
3019
+ _query_params.append(('include_lines', include_lines))
3020
+
3021
+ if limit is not None:
3022
+
3023
+ _query_params.append(('limit', limit))
3024
+
3025
+ if page is not None:
3026
+
3027
+ _query_params.append(('page', page))
3028
+
3029
+ if order_by is not None:
3030
+
3031
+ _query_params.append(('order_by', order_by))
3032
+
3033
+ if order_direction is not None:
3034
+
3035
+ _query_params.append(('order_direction', order_direction))
3036
+
3037
+ # process the header parameters
3038
+ if x_platform_id is not None:
3039
+ _header_params['x-platform-id'] = x_platform_id
3040
+ # process the form parameters
3041
+ # process the body parameter
3042
+
3043
+
3044
+ # set the HTTP header `Accept`
3045
+ if 'Accept' not in _header_params:
3046
+ _header_params['Accept'] = self.api_client.select_header_accept(
3047
+ [
3048
+ 'application/json',
3049
+ '*/*'
3050
+ ]
3051
+ )
3052
+
3053
+
3054
+ # authentication setting
3055
+ _auth_settings: List[str] = [
3056
+ 'JWT-Authentication',
3057
+ 'API-Key'
3058
+ ]
3059
+
3060
+ return self.api_client.param_serialize(
3061
+ method='GET',
3062
+ resource_path='/v{version}/reports/invoice-lines-overview',
3063
+ path_params=_path_params,
3064
+ query_params=_query_params,
3065
+ header_params=_header_params,
3066
+ body=_body_params,
3067
+ post_params=_form_params,
3068
+ files=_files,
3069
+ auth_settings=_auth_settings,
3070
+ collection_formats=_collection_formats,
3071
+ _host=_host,
3072
+ _request_auth=_request_auth
3073
+ )
3074
+
3075
+
3076
+
3077
+
3078
+ @validate_call
3079
+ def get_reports_invoice_tax_overview(
3080
+ self,
3081
+ version: Annotated[StrictStr, Field(description="version")],
3082
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3083
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
3084
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
3085
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
3086
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
3087
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
3088
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
3089
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
3090
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
3091
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
3092
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
3093
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
3094
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
3095
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
3096
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
3097
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
3098
+ _request_timeout: Union[
3099
+ None,
3100
+ Annotated[StrictFloat, Field(gt=0)],
3101
+ Tuple[
3102
+ Annotated[StrictFloat, Field(gt=0)],
3103
+ Annotated[StrictFloat, Field(gt=0)]
3104
+ ]
3105
+ ] = None,
3106
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3107
+ _content_type: Optional[StrictStr] = None,
3108
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3109
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3110
+ ) -> ReportGenerateRequest:
3111
+ """Get invoice tax report
3112
+
3113
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3114
+
3115
+ :param version: version (required)
3116
+ :type version: str
3117
+ :param x_platform_id: Platform ID.
3118
+ :type x_platform_id: str
3119
+ :param customer_id: Filter based of customer ID
3120
+ :type customer_id: str
3121
+ :param statuses: Filter invoices based on invoice status(es)
3122
+ :type statuses: List[str]
3123
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
3124
+ :type workflow_action_execution_statuses: List[str]
3125
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
3126
+ :type invoice_date: str
3127
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
3128
+ :type paid: str
3129
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
3130
+ :type on_hold: str
3131
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
3132
+ :type pricing_plan_subscription_id: str
3133
+ :param product_id: Filter invoices containing a product resource id
3134
+ :type product_id: str
3135
+ :param product_item_id: Filter invoices containing a product item resource id
3136
+ :type product_item_id: str
3137
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
3138
+ :type include_periods: bool
3139
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
3140
+ :type include_lines: bool
3141
+ :param limit: The amount of records shown in the list
3142
+ :type limit: int
3143
+ :param page: The page which is going to be shown
3144
+ :type page: int
3145
+ :param order_by: The parameter by which the response is ordered.
3146
+ :type order_by: str
3147
+ :param order_direction: The order direction by which the response is ordered.
3148
+ :type order_direction: str
3149
+ :param _request_timeout: timeout setting for this request. If one
3150
+ number provided, it will be total request
3151
+ timeout. It can also be a pair (tuple) of
3152
+ (connection, read) timeouts.
3153
+ :type _request_timeout: int, tuple(int, int), optional
3154
+ :param _request_auth: set to override the auth_settings for an a single
3155
+ request; this effectively ignores the
3156
+ authentication in the spec for a single request.
3157
+ :type _request_auth: dict, optional
3158
+ :param _content_type: force content-type for the request.
3159
+ :type _content_type: str, Optional
3160
+ :param _headers: set to override the headers for a single
3161
+ request; this effectively ignores the headers
3162
+ in the spec for a single request.
3163
+ :type _headers: dict, optional
3164
+ :param _host_index: set to override the host_index for a single
3165
+ request; this effectively ignores the host_index
3166
+ in the spec for a single request.
3167
+ :type _host_index: int, optional
3168
+ :return: Returns the result object.
3169
+ """ # noqa: E501
3170
+
3171
+ _param = self._get_reports_invoice_tax_overview_serialize(
3172
+ version=version,
3173
+ x_platform_id=x_platform_id,
3174
+ customer_id=customer_id,
3175
+ statuses=statuses,
3176
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
3177
+ invoice_date=invoice_date,
3178
+ paid=paid,
3179
+ on_hold=on_hold,
3180
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
3181
+ product_id=product_id,
3182
+ product_item_id=product_item_id,
3183
+ include_periods=include_periods,
3184
+ include_lines=include_lines,
3185
+ limit=limit,
3186
+ page=page,
3187
+ order_by=order_by,
3188
+ order_direction=order_direction,
3189
+ _request_auth=_request_auth,
3190
+ _content_type=_content_type,
3191
+ _headers=_headers,
3192
+ _host_index=_host_index
3193
+ )
3194
+
3195
+ _response_types_map: Dict[str, Optional[str]] = {
3196
+ '200': "ReportGenerateRequest",
3197
+ '400': "ApiError",
3198
+ '401': "ApiError",
3199
+ '403': "ApiError",
3200
+ '500': "ApiError",
3201
+ }
3202
+ response_data = self.api_client.call_api(
3203
+ *_param,
3204
+ _request_timeout=_request_timeout
3205
+ )
3206
+ response_data.read()
3207
+ return self.api_client.response_deserialize(
3208
+ response_data=response_data,
3209
+ response_types_map=_response_types_map,
3210
+ ).data
3211
+
3212
+
3213
+ @validate_call
3214
+ def get_reports_invoice_tax_overview_with_http_info(
3215
+ self,
3216
+ version: Annotated[StrictStr, Field(description="version")],
3217
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3218
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
3219
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
3220
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
3221
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
3222
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
3223
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
3224
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
3225
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
3226
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
3227
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
3228
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
3229
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
3230
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
3231
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
3232
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
3233
+ _request_timeout: Union[
3234
+ None,
3235
+ Annotated[StrictFloat, Field(gt=0)],
3236
+ Tuple[
3237
+ Annotated[StrictFloat, Field(gt=0)],
3238
+ Annotated[StrictFloat, Field(gt=0)]
3239
+ ]
3240
+ ] = None,
3241
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3242
+ _content_type: Optional[StrictStr] = None,
3243
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3244
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3245
+ ) -> ApiResponse[ReportGenerateRequest]:
3246
+ """Get invoice tax report
3247
+
3248
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3249
+
3250
+ :param version: version (required)
3251
+ :type version: str
3252
+ :param x_platform_id: Platform ID.
3253
+ :type x_platform_id: str
3254
+ :param customer_id: Filter based of customer ID
3255
+ :type customer_id: str
3256
+ :param statuses: Filter invoices based on invoice status(es)
3257
+ :type statuses: List[str]
3258
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
3259
+ :type workflow_action_execution_statuses: List[str]
3260
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
3261
+ :type invoice_date: str
3262
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
3263
+ :type paid: str
3264
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
3265
+ :type on_hold: str
3266
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
3267
+ :type pricing_plan_subscription_id: str
3268
+ :param product_id: Filter invoices containing a product resource id
3269
+ :type product_id: str
3270
+ :param product_item_id: Filter invoices containing a product item resource id
3271
+ :type product_item_id: str
3272
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
3273
+ :type include_periods: bool
3274
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
3275
+ :type include_lines: bool
3276
+ :param limit: The amount of records shown in the list
3277
+ :type limit: int
3278
+ :param page: The page which is going to be shown
3279
+ :type page: int
3280
+ :param order_by: The parameter by which the response is ordered.
3281
+ :type order_by: str
3282
+ :param order_direction: The order direction by which the response is ordered.
3283
+ :type order_direction: str
3284
+ :param _request_timeout: timeout setting for this request. If one
3285
+ number provided, it will be total request
3286
+ timeout. It can also be a pair (tuple) of
3287
+ (connection, read) timeouts.
3288
+ :type _request_timeout: int, tuple(int, int), optional
3289
+ :param _request_auth: set to override the auth_settings for an a single
3290
+ request; this effectively ignores the
3291
+ authentication in the spec for a single request.
3292
+ :type _request_auth: dict, optional
3293
+ :param _content_type: force content-type for the request.
3294
+ :type _content_type: str, Optional
3295
+ :param _headers: set to override the headers for a single
3296
+ request; this effectively ignores the headers
3297
+ in the spec for a single request.
3298
+ :type _headers: dict, optional
3299
+ :param _host_index: set to override the host_index for a single
3300
+ request; this effectively ignores the host_index
3301
+ in the spec for a single request.
3302
+ :type _host_index: int, optional
3303
+ :return: Returns the result object.
3304
+ """ # noqa: E501
3305
+
3306
+ _param = self._get_reports_invoice_tax_overview_serialize(
3307
+ version=version,
3308
+ x_platform_id=x_platform_id,
3309
+ customer_id=customer_id,
3310
+ statuses=statuses,
3311
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
3312
+ invoice_date=invoice_date,
3313
+ paid=paid,
3314
+ on_hold=on_hold,
3315
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
3316
+ product_id=product_id,
3317
+ product_item_id=product_item_id,
3318
+ include_periods=include_periods,
3319
+ include_lines=include_lines,
3320
+ limit=limit,
3321
+ page=page,
3322
+ order_by=order_by,
3323
+ order_direction=order_direction,
3324
+ _request_auth=_request_auth,
3325
+ _content_type=_content_type,
3326
+ _headers=_headers,
3327
+ _host_index=_host_index
3328
+ )
3329
+
3330
+ _response_types_map: Dict[str, Optional[str]] = {
3331
+ '200': "ReportGenerateRequest",
3332
+ '400': "ApiError",
3333
+ '401': "ApiError",
3334
+ '403': "ApiError",
3335
+ '500': "ApiError",
3336
+ }
3337
+ response_data = self.api_client.call_api(
3338
+ *_param,
3339
+ _request_timeout=_request_timeout
3340
+ )
3341
+ response_data.read()
3342
+ return self.api_client.response_deserialize(
3343
+ response_data=response_data,
3344
+ response_types_map=_response_types_map,
3345
+ )
3346
+
3347
+
3348
+ @validate_call
3349
+ def get_reports_invoice_tax_overview_without_preload_content(
3350
+ self,
3351
+ version: Annotated[StrictStr, Field(description="version")],
3352
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3353
+ customer_id: Annotated[Optional[StrictStr], Field(description="Filter based of customer ID")] = None,
3354
+ statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on invoice status(es)")] = None,
3355
+ workflow_action_execution_statuses: Annotated[Optional[List[StrictStr]], Field(description="Filter invoices based on workflow action execution status(es)")] = None,
3356
+ invoice_date: Annotated[Optional[StrictStr], Field(description="Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).")] = None,
3357
+ paid: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're paid or not (true or false)")] = None,
3358
+ on_hold: Annotated[Optional[StrictStr], Field(description="Filter invoices based on whether they're on hold or not (true or false)")] = None,
3359
+ pricing_plan_subscription_id: Annotated[Optional[StrictStr], Field(description="Filter invoices by the pricing plan subscription id")] = None,
3360
+ product_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product resource id")] = None,
3361
+ product_item_id: Annotated[Optional[StrictStr], Field(description="Filter invoices containing a product item resource id")] = None,
3362
+ include_periods: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include period and group data (true or false)")] = None,
3363
+ include_lines: Annotated[Optional[StrictBool], Field(description="Indicates whether the response should include invoice lines (true or false)")] = None,
3364
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
3365
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
3366
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered.")] = None,
3367
+ order_direction: Annotated[Optional[StrictStr], Field(description="The order direction by which the response is ordered.")] = None,
3368
+ _request_timeout: Union[
3369
+ None,
3370
+ Annotated[StrictFloat, Field(gt=0)],
3371
+ Tuple[
3372
+ Annotated[StrictFloat, Field(gt=0)],
3373
+ Annotated[StrictFloat, Field(gt=0)]
3374
+ ]
3375
+ ] = None,
3376
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3377
+ _content_type: Optional[StrictStr] = None,
3378
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3379
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3380
+ ) -> RESTResponseType:
3381
+ """Get invoice tax report
3382
+
3383
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3384
+
3385
+ :param version: version (required)
3386
+ :type version: str
3387
+ :param x_platform_id: Platform ID.
3388
+ :type x_platform_id: str
3389
+ :param customer_id: Filter based of customer ID
3390
+ :type customer_id: str
3391
+ :param statuses: Filter invoices based on invoice status(es)
3392
+ :type statuses: List[str]
3393
+ :param workflow_action_execution_statuses: Filter invoices based on workflow action execution status(es)
3394
+ :type workflow_action_execution_statuses: List[str]
3395
+ :param invoice_date: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
3396
+ :type invoice_date: str
3397
+ :param paid: Filter invoices based on whether they're paid or not (true or false)
3398
+ :type paid: str
3399
+ :param on_hold: Filter invoices based on whether they're on hold or not (true or false)
3400
+ :type on_hold: str
3401
+ :param pricing_plan_subscription_id: Filter invoices by the pricing plan subscription id
3402
+ :type pricing_plan_subscription_id: str
3403
+ :param product_id: Filter invoices containing a product resource id
3404
+ :type product_id: str
3405
+ :param product_item_id: Filter invoices containing a product item resource id
3406
+ :type product_item_id: str
3407
+ :param include_periods: Indicates whether the response should include period and group data (true or false)
3408
+ :type include_periods: bool
3409
+ :param include_lines: Indicates whether the response should include invoice lines (true or false)
3410
+ :type include_lines: bool
3411
+ :param limit: The amount of records shown in the list
3412
+ :type limit: int
3413
+ :param page: The page which is going to be shown
3414
+ :type page: int
3415
+ :param order_by: The parameter by which the response is ordered.
3416
+ :type order_by: str
3417
+ :param order_direction: The order direction by which the response is ordered.
3418
+ :type order_direction: str
3419
+ :param _request_timeout: timeout setting for this request. If one
3420
+ number provided, it will be total request
3421
+ timeout. It can also be a pair (tuple) of
3422
+ (connection, read) timeouts.
3423
+ :type _request_timeout: int, tuple(int, int), optional
3424
+ :param _request_auth: set to override the auth_settings for an a single
3425
+ request; this effectively ignores the
3426
+ authentication in the spec for a single request.
3427
+ :type _request_auth: dict, optional
3428
+ :param _content_type: force content-type for the request.
3429
+ :type _content_type: str, Optional
3430
+ :param _headers: set to override the headers for a single
3431
+ request; this effectively ignores the headers
3432
+ in the spec for a single request.
3433
+ :type _headers: dict, optional
3434
+ :param _host_index: set to override the host_index for a single
3435
+ request; this effectively ignores the host_index
3436
+ in the spec for a single request.
3437
+ :type _host_index: int, optional
3438
+ :return: Returns the result object.
3439
+ """ # noqa: E501
3440
+
3441
+ _param = self._get_reports_invoice_tax_overview_serialize(
3442
+ version=version,
3443
+ x_platform_id=x_platform_id,
3444
+ customer_id=customer_id,
3445
+ statuses=statuses,
3446
+ workflow_action_execution_statuses=workflow_action_execution_statuses,
3447
+ invoice_date=invoice_date,
3448
+ paid=paid,
3449
+ on_hold=on_hold,
3450
+ pricing_plan_subscription_id=pricing_plan_subscription_id,
3451
+ product_id=product_id,
3452
+ product_item_id=product_item_id,
3453
+ include_periods=include_periods,
3454
+ include_lines=include_lines,
3455
+ limit=limit,
3456
+ page=page,
3457
+ order_by=order_by,
3458
+ order_direction=order_direction,
3459
+ _request_auth=_request_auth,
3460
+ _content_type=_content_type,
3461
+ _headers=_headers,
3462
+ _host_index=_host_index
3463
+ )
3464
+
3465
+ _response_types_map: Dict[str, Optional[str]] = {
3466
+ '200': "ReportGenerateRequest",
3467
+ '400': "ApiError",
3468
+ '401': "ApiError",
3469
+ '403': "ApiError",
3470
+ '500': "ApiError",
3471
+ }
3472
+ response_data = self.api_client.call_api(
3473
+ *_param,
3474
+ _request_timeout=_request_timeout
3475
+ )
3476
+ return response_data.response
3477
+
3478
+
3479
+ def _get_reports_invoice_tax_overview_serialize(
3480
+ self,
3481
+ version,
3482
+ x_platform_id,
3483
+ customer_id,
3484
+ statuses,
3485
+ workflow_action_execution_statuses,
3486
+ invoice_date,
3487
+ paid,
3488
+ on_hold,
3489
+ pricing_plan_subscription_id,
3490
+ product_id,
3491
+ product_item_id,
3492
+ include_periods,
3493
+ include_lines,
3494
+ limit,
3495
+ page,
3496
+ order_by,
3497
+ order_direction,
3498
+ _request_auth,
3499
+ _content_type,
3500
+ _headers,
3501
+ _host_index,
3502
+ ) -> RequestSerialized:
3503
+
3504
+ _host = None
3505
+
3506
+ _collection_formats: Dict[str, str] = {
3507
+ 'statuses[]': 'multi',
3508
+ 'workflow_action_execution_statuses[]': 'multi',
3509
+ }
3510
+
3511
+ _path_params: Dict[str, str] = {}
3512
+ _query_params: List[Tuple[str, str]] = []
3513
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3514
+ _form_params: List[Tuple[str, str]] = []
3515
+ _files: Dict[
3516
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3517
+ ] = {}
3518
+ _body_params: Optional[bytes] = None
3519
+
3520
+ # process the path parameters
3521
+ if version is not None:
3522
+ _path_params['version'] = version
3523
+ # process the query parameters
3524
+ if customer_id is not None:
3525
+
3526
+ _query_params.append(('customer_id', customer_id))
3527
+
3528
+ if statuses is not None:
3529
+
3530
+ _query_params.append(('statuses[]', statuses))
3531
+
3532
+ if workflow_action_execution_statuses is not None:
3533
+
3534
+ _query_params.append(('workflow_action_execution_statuses[]', workflow_action_execution_statuses))
3535
+
3536
+ if invoice_date is not None:
3537
+
3538
+ _query_params.append(('invoice_date', invoice_date))
3539
+
3540
+ if paid is not None:
3541
+
3542
+ _query_params.append(('paid', paid))
3543
+
3544
+ if on_hold is not None:
3545
+
3546
+ _query_params.append(('on_hold', on_hold))
3547
+
3548
+ if pricing_plan_subscription_id is not None:
3549
+
3550
+ _query_params.append(('pricing_plan_subscription_id', pricing_plan_subscription_id))
3551
+
3552
+ if product_id is not None:
3553
+
3554
+ _query_params.append(('product_id', product_id))
3555
+
3556
+ if product_item_id is not None:
3557
+
3558
+ _query_params.append(('product_item_id', product_item_id))
3559
+
3560
+ if include_periods is not None:
3561
+
3562
+ _query_params.append(('include_periods', include_periods))
3563
+
3564
+ if include_lines is not None:
3565
+
3566
+ _query_params.append(('include_lines', include_lines))
3567
+
3568
+ if limit is not None:
3569
+
3570
+ _query_params.append(('limit', limit))
3571
+
3572
+ if page is not None:
3573
+
3574
+ _query_params.append(('page', page))
3575
+
3576
+ if order_by is not None:
3577
+
3578
+ _query_params.append(('order_by', order_by))
3579
+
3580
+ if order_direction is not None:
3581
+
3582
+ _query_params.append(('order_direction', order_direction))
3583
+
3584
+ # process the header parameters
3585
+ if x_platform_id is not None:
3586
+ _header_params['x-platform-id'] = x_platform_id
3587
+ # process the form parameters
3588
+ # process the body parameter
3589
+
3590
+
3591
+ # set the HTTP header `Accept`
3592
+ if 'Accept' not in _header_params:
3593
+ _header_params['Accept'] = self.api_client.select_header_accept(
3594
+ [
3595
+ 'application/json',
3596
+ '*/*'
3597
+ ]
3598
+ )
3599
+
3600
+
3601
+ # authentication setting
3602
+ _auth_settings: List[str] = [
3603
+ 'JWT-Authentication',
3604
+ 'API-Key'
3605
+ ]
3606
+
3607
+ return self.api_client.param_serialize(
3608
+ method='GET',
3609
+ resource_path='/v{version}/reports/invoice-tax-overview',
3610
+ path_params=_path_params,
3611
+ query_params=_query_params,
3612
+ header_params=_header_params,
3613
+ body=_body_params,
3614
+ post_params=_form_params,
3615
+ files=_files,
3616
+ auth_settings=_auth_settings,
3617
+ collection_formats=_collection_formats,
3618
+ _host=_host,
3619
+ _request_auth=_request_auth
3620
+ )
3621
+
3622
+
3623
+
3624
+
3625
+ @validate_call
3626
+ def post_report_generate_requests(
3627
+ self,
3628
+ version: Annotated[StrictStr, Field(description="version")],
3629
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3630
+ report_generate_request_create_request: Optional[ReportGenerateRequestCreateRequest] = None,
3631
+ _request_timeout: Union[
3632
+ None,
3633
+ Annotated[StrictFloat, Field(gt=0)],
3634
+ Tuple[
3635
+ Annotated[StrictFloat, Field(gt=0)],
3636
+ Annotated[StrictFloat, Field(gt=0)]
3637
+ ]
3638
+ ] = None,
3639
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3640
+ _content_type: Optional[StrictStr] = None,
3641
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3642
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3643
+ ) -> ReportGenerateRequest:
3644
+ """Create a ReportGenerateRequest
3645
+
3646
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3647
+
3648
+ :param version: version (required)
3649
+ :type version: str
3650
+ :param x_platform_id: Platform ID.
3651
+ :type x_platform_id: str
3652
+ :param report_generate_request_create_request:
3653
+ :type report_generate_request_create_request: ReportGenerateRequestCreateRequest
3654
+ :param _request_timeout: timeout setting for this request. If one
3655
+ number provided, it will be total request
3656
+ timeout. It can also be a pair (tuple) of
3657
+ (connection, read) timeouts.
3658
+ :type _request_timeout: int, tuple(int, int), optional
3659
+ :param _request_auth: set to override the auth_settings for an a single
3660
+ request; this effectively ignores the
3661
+ authentication in the spec for a single request.
3662
+ :type _request_auth: dict, optional
3663
+ :param _content_type: force content-type for the request.
3664
+ :type _content_type: str, Optional
3665
+ :param _headers: set to override the headers for a single
3666
+ request; this effectively ignores the headers
3667
+ in the spec for a single request.
3668
+ :type _headers: dict, optional
3669
+ :param _host_index: set to override the host_index for a single
3670
+ request; this effectively ignores the host_index
3671
+ in the spec for a single request.
3672
+ :type _host_index: int, optional
3673
+ :return: Returns the result object.
3674
+ """ # noqa: E501
3675
+
3676
+ _param = self._post_report_generate_requests_serialize(
3677
+ version=version,
3678
+ x_platform_id=x_platform_id,
3679
+ report_generate_request_create_request=report_generate_request_create_request,
3680
+ _request_auth=_request_auth,
3681
+ _content_type=_content_type,
3682
+ _headers=_headers,
3683
+ _host_index=_host_index
3684
+ )
3685
+
3686
+ _response_types_map: Dict[str, Optional[str]] = {
3687
+ '201': "ReportGenerateRequest",
3688
+ '400': "ApiError",
3689
+ '401': "ApiError",
3690
+ '403': "ApiError",
3691
+ '409': "ApiError",
3692
+ '500': "ApiError",
3693
+ }
3694
+ response_data = self.api_client.call_api(
3695
+ *_param,
3696
+ _request_timeout=_request_timeout
3697
+ )
3698
+ response_data.read()
3699
+ return self.api_client.response_deserialize(
3700
+ response_data=response_data,
3701
+ response_types_map=_response_types_map,
3702
+ ).data
3703
+
3704
+
3705
+ @validate_call
3706
+ def post_report_generate_requests_with_http_info(
3707
+ self,
3708
+ version: Annotated[StrictStr, Field(description="version")],
3709
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3710
+ report_generate_request_create_request: Optional[ReportGenerateRequestCreateRequest] = None,
3711
+ _request_timeout: Union[
3712
+ None,
3713
+ Annotated[StrictFloat, Field(gt=0)],
3714
+ Tuple[
3715
+ Annotated[StrictFloat, Field(gt=0)],
3716
+ Annotated[StrictFloat, Field(gt=0)]
3717
+ ]
3718
+ ] = None,
3719
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3720
+ _content_type: Optional[StrictStr] = None,
3721
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3722
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3723
+ ) -> ApiResponse[ReportGenerateRequest]:
3724
+ """Create a ReportGenerateRequest
3725
+
3726
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3727
+
3728
+ :param version: version (required)
3729
+ :type version: str
3730
+ :param x_platform_id: Platform ID.
3731
+ :type x_platform_id: str
3732
+ :param report_generate_request_create_request:
3733
+ :type report_generate_request_create_request: ReportGenerateRequestCreateRequest
3734
+ :param _request_timeout: timeout setting for this request. If one
3735
+ number provided, it will be total request
3736
+ timeout. It can also be a pair (tuple) of
3737
+ (connection, read) timeouts.
3738
+ :type _request_timeout: int, tuple(int, int), optional
3739
+ :param _request_auth: set to override the auth_settings for an a single
3740
+ request; this effectively ignores the
3741
+ authentication in the spec for a single request.
3742
+ :type _request_auth: dict, optional
3743
+ :param _content_type: force content-type for the request.
3744
+ :type _content_type: str, Optional
3745
+ :param _headers: set to override the headers for a single
3746
+ request; this effectively ignores the headers
3747
+ in the spec for a single request.
3748
+ :type _headers: dict, optional
3749
+ :param _host_index: set to override the host_index for a single
3750
+ request; this effectively ignores the host_index
3751
+ in the spec for a single request.
3752
+ :type _host_index: int, optional
3753
+ :return: Returns the result object.
3754
+ """ # noqa: E501
3755
+
3756
+ _param = self._post_report_generate_requests_serialize(
3757
+ version=version,
3758
+ x_platform_id=x_platform_id,
3759
+ report_generate_request_create_request=report_generate_request_create_request,
3760
+ _request_auth=_request_auth,
3761
+ _content_type=_content_type,
3762
+ _headers=_headers,
3763
+ _host_index=_host_index
3764
+ )
3765
+
3766
+ _response_types_map: Dict[str, Optional[str]] = {
3767
+ '201': "ReportGenerateRequest",
3768
+ '400': "ApiError",
3769
+ '401': "ApiError",
3770
+ '403': "ApiError",
3771
+ '409': "ApiError",
3772
+ '500': "ApiError",
3773
+ }
3774
+ response_data = self.api_client.call_api(
3775
+ *_param,
3776
+ _request_timeout=_request_timeout
3777
+ )
3778
+ response_data.read()
3779
+ return self.api_client.response_deserialize(
3780
+ response_data=response_data,
3781
+ response_types_map=_response_types_map,
3782
+ )
3783
+
3784
+
3785
+ @validate_call
3786
+ def post_report_generate_requests_without_preload_content(
3787
+ self,
3788
+ version: Annotated[StrictStr, Field(description="version")],
3789
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3790
+ report_generate_request_create_request: Optional[ReportGenerateRequestCreateRequest] = None,
3791
+ _request_timeout: Union[
3792
+ None,
3793
+ Annotated[StrictFloat, Field(gt=0)],
3794
+ Tuple[
3795
+ Annotated[StrictFloat, Field(gt=0)],
3796
+ Annotated[StrictFloat, Field(gt=0)]
3797
+ ]
3798
+ ] = None,
3799
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3800
+ _content_type: Optional[StrictStr] = None,
3801
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3802
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3803
+ ) -> RESTResponseType:
3804
+ """Create a ReportGenerateRequest
3805
+
3806
+ Requires the REPORT_GENERATE_REQUEST.CREATE permission.
3807
+
3808
+ :param version: version (required)
3809
+ :type version: str
3810
+ :param x_platform_id: Platform ID.
3811
+ :type x_platform_id: str
3812
+ :param report_generate_request_create_request:
3813
+ :type report_generate_request_create_request: ReportGenerateRequestCreateRequest
3814
+ :param _request_timeout: timeout setting for this request. If one
3815
+ number provided, it will be total request
3816
+ timeout. It can also be a pair (tuple) of
3817
+ (connection, read) timeouts.
3818
+ :type _request_timeout: int, tuple(int, int), optional
3819
+ :param _request_auth: set to override the auth_settings for an a single
3820
+ request; this effectively ignores the
3821
+ authentication in the spec for a single request.
3822
+ :type _request_auth: dict, optional
3823
+ :param _content_type: force content-type for the request.
3824
+ :type _content_type: str, Optional
3825
+ :param _headers: set to override the headers for a single
3826
+ request; this effectively ignores the headers
3827
+ in the spec for a single request.
3828
+ :type _headers: dict, optional
3829
+ :param _host_index: set to override the host_index for a single
3830
+ request; this effectively ignores the host_index
3831
+ in the spec for a single request.
3832
+ :type _host_index: int, optional
3833
+ :return: Returns the result object.
3834
+ """ # noqa: E501
3835
+
3836
+ _param = self._post_report_generate_requests_serialize(
3837
+ version=version,
3838
+ x_platform_id=x_platform_id,
3839
+ report_generate_request_create_request=report_generate_request_create_request,
3840
+ _request_auth=_request_auth,
3841
+ _content_type=_content_type,
3842
+ _headers=_headers,
3843
+ _host_index=_host_index
3844
+ )
3845
+
3846
+ _response_types_map: Dict[str, Optional[str]] = {
3847
+ '201': "ReportGenerateRequest",
3848
+ '400': "ApiError",
3849
+ '401': "ApiError",
3850
+ '403': "ApiError",
3851
+ '409': "ApiError",
3852
+ '500': "ApiError",
3853
+ }
3854
+ response_data = self.api_client.call_api(
3855
+ *_param,
3856
+ _request_timeout=_request_timeout
3857
+ )
3858
+ return response_data.response
3859
+
3860
+
3861
+ def _post_report_generate_requests_serialize(
3862
+ self,
3863
+ version,
3864
+ x_platform_id,
3865
+ report_generate_request_create_request,
3866
+ _request_auth,
3867
+ _content_type,
3868
+ _headers,
3869
+ _host_index,
3870
+ ) -> RequestSerialized:
3871
+
3872
+ _host = None
3873
+
3874
+ _collection_formats: Dict[str, str] = {
3875
+ }
3876
+
3877
+ _path_params: Dict[str, str] = {}
3878
+ _query_params: List[Tuple[str, str]] = []
3879
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3880
+ _form_params: List[Tuple[str, str]] = []
3881
+ _files: Dict[
3882
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3883
+ ] = {}
3884
+ _body_params: Optional[bytes] = None
3885
+
3886
+ # process the path parameters
3887
+ if version is not None:
3888
+ _path_params['version'] = version
3889
+ # process the query parameters
3890
+ # process the header parameters
3891
+ if x_platform_id is not None:
3892
+ _header_params['x-platform-id'] = x_platform_id
3893
+ # process the form parameters
3894
+ # process the body parameter
3895
+ if report_generate_request_create_request is not None:
3896
+ _body_params = report_generate_request_create_request
3897
+
3898
+
3899
+ # set the HTTP header `Accept`
3900
+ if 'Accept' not in _header_params:
3901
+ _header_params['Accept'] = self.api_client.select_header_accept(
3902
+ [
3903
+ 'application/json',
3904
+ '*/*'
3905
+ ]
3906
+ )
3907
+
3908
+ # set the HTTP header `Content-Type`
3909
+ if _content_type:
3910
+ _header_params['Content-Type'] = _content_type
3911
+ else:
3912
+ _default_content_type = (
3913
+ self.api_client.select_header_content_type(
3914
+ [
3915
+ 'application/json'
3916
+ ]
3917
+ )
3918
+ )
3919
+ if _default_content_type is not None:
3920
+ _header_params['Content-Type'] = _default_content_type
3921
+
3922
+ # authentication setting
3923
+ _auth_settings: List[str] = [
3924
+ 'JWT-Authentication',
3925
+ 'API-Key'
3926
+ ]
3927
+
3928
+ return self.api_client.param_serialize(
3929
+ method='POST',
3930
+ resource_path='/v{version}/report-generate-requests',
3931
+ path_params=_path_params,
3932
+ query_params=_query_params,
3933
+ header_params=_header_params,
3934
+ body=_body_params,
3935
+ post_params=_form_params,
3936
+ files=_files,
3937
+ auth_settings=_auth_settings,
3938
+ collection_formats=_collection_formats,
3939
+ _host=_host,
3940
+ _request_auth=_request_auth
3941
+ )
3942
+
3943
+
3944
+
3945
+
3946
+ @validate_call
3947
+ def post_report_generate_requests_search(
3948
+ self,
3949
+ version: Annotated[StrictStr, Field(description="version")],
3950
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
3951
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
3952
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
3953
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
3954
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
3955
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
3956
+ search_create_request: Optional[SearchCreateRequest] = None,
3957
+ _request_timeout: Union[
3958
+ None,
3959
+ Annotated[StrictFloat, Field(gt=0)],
3960
+ Tuple[
3961
+ Annotated[StrictFloat, Field(gt=0)],
3962
+ Annotated[StrictFloat, Field(gt=0)]
3963
+ ]
3964
+ ] = None,
3965
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3966
+ _content_type: Optional[StrictStr] = None,
3967
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3968
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3969
+ ) -> ReportGenerateRequestResponseWrapper:
3970
+ """Search ReportGenerateRequests
3971
+
3972
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
3973
+
3974
+ :param version: version (required)
3975
+ :type version: str
3976
+ :param x_platform_id: Platform ID.
3977
+ :type x_platform_id: str
3978
+ :param expand: The id fields of the resources that are going to be expanded.
3979
+ :type expand: List[str]
3980
+ :param limit: The amount of records shown in the list
3981
+ :type limit: int
3982
+ :param page: The page which is going to be shown
3983
+ :type page: int
3984
+ :param order_by: The parameter by which the response is ordered. default = name
3985
+ :type order_by: str
3986
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
3987
+ :type order_direction: str
3988
+ :param search_create_request:
3989
+ :type search_create_request: SearchCreateRequest
3990
+ :param _request_timeout: timeout setting for this request. If one
3991
+ number provided, it will be total request
3992
+ timeout. It can also be a pair (tuple) of
3993
+ (connection, read) timeouts.
3994
+ :type _request_timeout: int, tuple(int, int), optional
3995
+ :param _request_auth: set to override the auth_settings for an a single
3996
+ request; this effectively ignores the
3997
+ authentication in the spec for a single request.
3998
+ :type _request_auth: dict, optional
3999
+ :param _content_type: force content-type for the request.
4000
+ :type _content_type: str, Optional
4001
+ :param _headers: set to override the headers for a single
4002
+ request; this effectively ignores the headers
4003
+ in the spec for a single request.
4004
+ :type _headers: dict, optional
4005
+ :param _host_index: set to override the host_index for a single
4006
+ request; this effectively ignores the host_index
4007
+ in the spec for a single request.
4008
+ :type _host_index: int, optional
4009
+ :return: Returns the result object.
4010
+ """ # noqa: E501
4011
+
4012
+ _param = self._post_report_generate_requests_search_serialize(
4013
+ version=version,
4014
+ x_platform_id=x_platform_id,
4015
+ expand=expand,
4016
+ limit=limit,
4017
+ page=page,
4018
+ order_by=order_by,
4019
+ order_direction=order_direction,
4020
+ search_create_request=search_create_request,
4021
+ _request_auth=_request_auth,
4022
+ _content_type=_content_type,
4023
+ _headers=_headers,
4024
+ _host_index=_host_index
4025
+ )
4026
+
4027
+ _response_types_map: Dict[str, Optional[str]] = {
4028
+ '201': "ReportGenerateRequestResponseWrapper",
4029
+ '400': "ApiError",
4030
+ '401': "ApiError",
4031
+ '403': "ApiError",
4032
+ '409': "ApiError",
4033
+ '500': "ApiError",
4034
+ }
4035
+ response_data = self.api_client.call_api(
4036
+ *_param,
4037
+ _request_timeout=_request_timeout
4038
+ )
4039
+ response_data.read()
4040
+ return self.api_client.response_deserialize(
4041
+ response_data=response_data,
4042
+ response_types_map=_response_types_map,
4043
+ ).data
4044
+
4045
+
4046
+ @validate_call
4047
+ def post_report_generate_requests_search_with_http_info(
4048
+ self,
4049
+ version: Annotated[StrictStr, Field(description="version")],
4050
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
4051
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
4052
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
4053
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
4054
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
4055
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
4056
+ search_create_request: Optional[SearchCreateRequest] = None,
4057
+ _request_timeout: Union[
4058
+ None,
4059
+ Annotated[StrictFloat, Field(gt=0)],
4060
+ Tuple[
4061
+ Annotated[StrictFloat, Field(gt=0)],
4062
+ Annotated[StrictFloat, Field(gt=0)]
4063
+ ]
4064
+ ] = None,
4065
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4066
+ _content_type: Optional[StrictStr] = None,
4067
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4068
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4069
+ ) -> ApiResponse[ReportGenerateRequestResponseWrapper]:
4070
+ """Search ReportGenerateRequests
4071
+
4072
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
4073
+
4074
+ :param version: version (required)
4075
+ :type version: str
4076
+ :param x_platform_id: Platform ID.
4077
+ :type x_platform_id: str
4078
+ :param expand: The id fields of the resources that are going to be expanded.
4079
+ :type expand: List[str]
4080
+ :param limit: The amount of records shown in the list
4081
+ :type limit: int
4082
+ :param page: The page which is going to be shown
4083
+ :type page: int
4084
+ :param order_by: The parameter by which the response is ordered. default = name
4085
+ :type order_by: str
4086
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
4087
+ :type order_direction: str
4088
+ :param search_create_request:
4089
+ :type search_create_request: SearchCreateRequest
4090
+ :param _request_timeout: timeout setting for this request. If one
4091
+ number provided, it will be total request
4092
+ timeout. It can also be a pair (tuple) of
4093
+ (connection, read) timeouts.
4094
+ :type _request_timeout: int, tuple(int, int), optional
4095
+ :param _request_auth: set to override the auth_settings for an a single
4096
+ request; this effectively ignores the
4097
+ authentication in the spec for a single request.
4098
+ :type _request_auth: dict, optional
4099
+ :param _content_type: force content-type for the request.
4100
+ :type _content_type: str, Optional
4101
+ :param _headers: set to override the headers for a single
4102
+ request; this effectively ignores the headers
4103
+ in the spec for a single request.
4104
+ :type _headers: dict, optional
4105
+ :param _host_index: set to override the host_index for a single
4106
+ request; this effectively ignores the host_index
4107
+ in the spec for a single request.
4108
+ :type _host_index: int, optional
4109
+ :return: Returns the result object.
4110
+ """ # noqa: E501
4111
+
4112
+ _param = self._post_report_generate_requests_search_serialize(
4113
+ version=version,
4114
+ x_platform_id=x_platform_id,
4115
+ expand=expand,
4116
+ limit=limit,
4117
+ page=page,
4118
+ order_by=order_by,
4119
+ order_direction=order_direction,
4120
+ search_create_request=search_create_request,
4121
+ _request_auth=_request_auth,
4122
+ _content_type=_content_type,
4123
+ _headers=_headers,
4124
+ _host_index=_host_index
4125
+ )
4126
+
4127
+ _response_types_map: Dict[str, Optional[str]] = {
4128
+ '201': "ReportGenerateRequestResponseWrapper",
4129
+ '400': "ApiError",
4130
+ '401': "ApiError",
4131
+ '403': "ApiError",
4132
+ '409': "ApiError",
4133
+ '500': "ApiError",
4134
+ }
4135
+ response_data = self.api_client.call_api(
4136
+ *_param,
4137
+ _request_timeout=_request_timeout
4138
+ )
4139
+ response_data.read()
4140
+ return self.api_client.response_deserialize(
4141
+ response_data=response_data,
4142
+ response_types_map=_response_types_map,
4143
+ )
4144
+
4145
+
4146
+ @validate_call
4147
+ def post_report_generate_requests_search_without_preload_content(
4148
+ self,
4149
+ version: Annotated[StrictStr, Field(description="version")],
4150
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
4151
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
4152
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
4153
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
4154
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
4155
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
4156
+ search_create_request: Optional[SearchCreateRequest] = None,
4157
+ _request_timeout: Union[
4158
+ None,
4159
+ Annotated[StrictFloat, Field(gt=0)],
4160
+ Tuple[
4161
+ Annotated[StrictFloat, Field(gt=0)],
4162
+ Annotated[StrictFloat, Field(gt=0)]
4163
+ ]
4164
+ ] = None,
4165
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4166
+ _content_type: Optional[StrictStr] = None,
4167
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4168
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4169
+ ) -> RESTResponseType:
4170
+ """Search ReportGenerateRequests
4171
+
4172
+ Requires the REPORT_GENERATE_REQUEST.VIEW permission.
4173
+
4174
+ :param version: version (required)
4175
+ :type version: str
4176
+ :param x_platform_id: Platform ID.
4177
+ :type x_platform_id: str
4178
+ :param expand: The id fields of the resources that are going to be expanded.
4179
+ :type expand: List[str]
4180
+ :param limit: The amount of records shown in the list
4181
+ :type limit: int
4182
+ :param page: The page which is going to be shown
4183
+ :type page: int
4184
+ :param order_by: The parameter by which the response is ordered. default = name
4185
+ :type order_by: str
4186
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
4187
+ :type order_direction: str
4188
+ :param search_create_request:
4189
+ :type search_create_request: SearchCreateRequest
4190
+ :param _request_timeout: timeout setting for this request. If one
4191
+ number provided, it will be total request
4192
+ timeout. It can also be a pair (tuple) of
4193
+ (connection, read) timeouts.
4194
+ :type _request_timeout: int, tuple(int, int), optional
4195
+ :param _request_auth: set to override the auth_settings for an a single
4196
+ request; this effectively ignores the
4197
+ authentication in the spec for a single request.
4198
+ :type _request_auth: dict, optional
4199
+ :param _content_type: force content-type for the request.
4200
+ :type _content_type: str, Optional
4201
+ :param _headers: set to override the headers for a single
4202
+ request; this effectively ignores the headers
4203
+ in the spec for a single request.
4204
+ :type _headers: dict, optional
4205
+ :param _host_index: set to override the host_index for a single
4206
+ request; this effectively ignores the host_index
4207
+ in the spec for a single request.
4208
+ :type _host_index: int, optional
4209
+ :return: Returns the result object.
4210
+ """ # noqa: E501
4211
+
4212
+ _param = self._post_report_generate_requests_search_serialize(
4213
+ version=version,
4214
+ x_platform_id=x_platform_id,
4215
+ expand=expand,
4216
+ limit=limit,
4217
+ page=page,
4218
+ order_by=order_by,
4219
+ order_direction=order_direction,
4220
+ search_create_request=search_create_request,
4221
+ _request_auth=_request_auth,
4222
+ _content_type=_content_type,
4223
+ _headers=_headers,
4224
+ _host_index=_host_index
4225
+ )
4226
+
4227
+ _response_types_map: Dict[str, Optional[str]] = {
4228
+ '201': "ReportGenerateRequestResponseWrapper",
4229
+ '400': "ApiError",
4230
+ '401': "ApiError",
4231
+ '403': "ApiError",
4232
+ '409': "ApiError",
4233
+ '500': "ApiError",
4234
+ }
4235
+ response_data = self.api_client.call_api(
4236
+ *_param,
4237
+ _request_timeout=_request_timeout
4238
+ )
4239
+ return response_data.response
4240
+
4241
+
4242
+ def _post_report_generate_requests_search_serialize(
4243
+ self,
4244
+ version,
4245
+ x_platform_id,
4246
+ expand,
4247
+ limit,
4248
+ page,
4249
+ order_by,
4250
+ order_direction,
4251
+ search_create_request,
4252
+ _request_auth,
4253
+ _content_type,
4254
+ _headers,
4255
+ _host_index,
4256
+ ) -> RequestSerialized:
4257
+
4258
+ _host = None
4259
+
4260
+ _collection_formats: Dict[str, str] = {
4261
+ 'expand[]': 'multi',
4262
+ }
4263
+
4264
+ _path_params: Dict[str, str] = {}
4265
+ _query_params: List[Tuple[str, str]] = []
4266
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4267
+ _form_params: List[Tuple[str, str]] = []
4268
+ _files: Dict[
4269
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4270
+ ] = {}
4271
+ _body_params: Optional[bytes] = None
4272
+
4273
+ # process the path parameters
4274
+ if version is not None:
4275
+ _path_params['version'] = version
4276
+ # process the query parameters
4277
+ if expand is not None:
4278
+
4279
+ _query_params.append(('expand[]', expand))
4280
+
4281
+ if limit is not None:
4282
+
4283
+ _query_params.append(('limit', limit))
4284
+
4285
+ if page is not None:
4286
+
4287
+ _query_params.append(('page', page))
4288
+
4289
+ if order_by is not None:
4290
+
4291
+ _query_params.append(('order_by', order_by))
4292
+
4293
+ if order_direction is not None:
4294
+
4295
+ _query_params.append(('order_direction', order_direction))
4296
+
4297
+ # process the header parameters
4298
+ if x_platform_id is not None:
4299
+ _header_params['x-platform-id'] = x_platform_id
4300
+ # process the form parameters
4301
+ # process the body parameter
4302
+ if search_create_request is not None:
4303
+ _body_params = search_create_request
4304
+
4305
+
4306
+ # set the HTTP header `Accept`
4307
+ if 'Accept' not in _header_params:
4308
+ _header_params['Accept'] = self.api_client.select_header_accept(
4309
+ [
4310
+ 'application/json',
4311
+ '*/*'
4312
+ ]
4313
+ )
4314
+
4315
+ # set the HTTP header `Content-Type`
4316
+ if _content_type:
4317
+ _header_params['Content-Type'] = _content_type
4318
+ else:
4319
+ _default_content_type = (
4320
+ self.api_client.select_header_content_type(
4321
+ [
4322
+ 'application/json'
4323
+ ]
4324
+ )
4325
+ )
4326
+ if _default_content_type is not None:
4327
+ _header_params['Content-Type'] = _default_content_type
4328
+
4329
+ # authentication setting
4330
+ _auth_settings: List[str] = [
4331
+ 'JWT-Authentication',
4332
+ 'API-Key'
4333
+ ]
4334
+
4335
+ return self.api_client.param_serialize(
4336
+ method='POST',
4337
+ resource_path='/v{version}/report-generate-requests/search',
4338
+ path_params=_path_params,
4339
+ query_params=_query_params,
4340
+ header_params=_header_params,
4341
+ body=_body_params,
4342
+ post_params=_form_params,
4343
+ files=_files,
4344
+ auth_settings=_auth_settings,
4345
+ collection_formats=_collection_formats,
4346
+ _host=_host,
4347
+ _request_auth=_request_auth
4348
+ )
4349
+
4350
+
4351
+
4352
+
4353
+ @validate_call
4354
+ def post_reports_search(
4355
+ self,
4356
+ version: Annotated[StrictStr, Field(description="version")],
4357
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
4358
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
4359
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
4360
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
4361
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
4362
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
4363
+ search_create_request: Optional[SearchCreateRequest] = None,
4364
+ _request_timeout: Union[
4365
+ None,
4366
+ Annotated[StrictFloat, Field(gt=0)],
4367
+ Tuple[
4368
+ Annotated[StrictFloat, Field(gt=0)],
4369
+ Annotated[StrictFloat, Field(gt=0)]
4370
+ ]
4371
+ ] = None,
4372
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4373
+ _content_type: Optional[StrictStr] = None,
4374
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4375
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4376
+ ) -> ReportResponseWrapper:
4377
+ """Search reports
4378
+
4379
+ Requires the REPORT.VIEW permission.
4380
+
4381
+ :param version: version (required)
4382
+ :type version: str
4383
+ :param x_platform_id: Platform ID.
4384
+ :type x_platform_id: str
4385
+ :param expand: The id fields of the resources that are going to be expanded.
4386
+ :type expand: List[str]
4387
+ :param limit: The amount of records shown in the list
4388
+ :type limit: int
4389
+ :param page: The page which is going to be shown
4390
+ :type page: int
4391
+ :param order_by: The parameter by which the response is ordered. default = name
4392
+ :type order_by: str
4393
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
4394
+ :type order_direction: str
4395
+ :param search_create_request:
4396
+ :type search_create_request: SearchCreateRequest
4397
+ :param _request_timeout: timeout setting for this request. If one
4398
+ number provided, it will be total request
4399
+ timeout. It can also be a pair (tuple) of
4400
+ (connection, read) timeouts.
4401
+ :type _request_timeout: int, tuple(int, int), optional
4402
+ :param _request_auth: set to override the auth_settings for an a single
4403
+ request; this effectively ignores the
4404
+ authentication in the spec for a single request.
4405
+ :type _request_auth: dict, optional
4406
+ :param _content_type: force content-type for the request.
4407
+ :type _content_type: str, Optional
4408
+ :param _headers: set to override the headers for a single
4409
+ request; this effectively ignores the headers
4410
+ in the spec for a single request.
4411
+ :type _headers: dict, optional
4412
+ :param _host_index: set to override the host_index for a single
4413
+ request; this effectively ignores the host_index
4414
+ in the spec for a single request.
4415
+ :type _host_index: int, optional
4416
+ :return: Returns the result object.
4417
+ """ # noqa: E501
4418
+
4419
+ _param = self._post_reports_search_serialize(
4420
+ version=version,
4421
+ x_platform_id=x_platform_id,
4422
+ expand=expand,
4423
+ limit=limit,
4424
+ page=page,
4425
+ order_by=order_by,
4426
+ order_direction=order_direction,
4427
+ search_create_request=search_create_request,
4428
+ _request_auth=_request_auth,
4429
+ _content_type=_content_type,
4430
+ _headers=_headers,
4431
+ _host_index=_host_index
4432
+ )
4433
+
4434
+ _response_types_map: Dict[str, Optional[str]] = {
4435
+ '200': "ReportResponseWrapper",
4436
+ '400': "ApiError",
4437
+ '401': "ApiError",
4438
+ '403': "ApiError",
4439
+ '500': "ApiError",
4440
+ }
4441
+ response_data = self.api_client.call_api(
4442
+ *_param,
4443
+ _request_timeout=_request_timeout
4444
+ )
4445
+ response_data.read()
4446
+ return self.api_client.response_deserialize(
4447
+ response_data=response_data,
4448
+ response_types_map=_response_types_map,
4449
+ ).data
4450
+
4451
+
4452
+ @validate_call
4453
+ def post_reports_search_with_http_info(
4454
+ self,
4455
+ version: Annotated[StrictStr, Field(description="version")],
4456
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
4457
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
4458
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
4459
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
4460
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
4461
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
4462
+ search_create_request: Optional[SearchCreateRequest] = None,
4463
+ _request_timeout: Union[
4464
+ None,
4465
+ Annotated[StrictFloat, Field(gt=0)],
4466
+ Tuple[
4467
+ Annotated[StrictFloat, Field(gt=0)],
4468
+ Annotated[StrictFloat, Field(gt=0)]
4469
+ ]
4470
+ ] = None,
4471
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4472
+ _content_type: Optional[StrictStr] = None,
4473
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4474
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4475
+ ) -> ApiResponse[ReportResponseWrapper]:
4476
+ """Search reports
4477
+
4478
+ Requires the REPORT.VIEW permission.
4479
+
4480
+ :param version: version (required)
4481
+ :type version: str
4482
+ :param x_platform_id: Platform ID.
4483
+ :type x_platform_id: str
4484
+ :param expand: The id fields of the resources that are going to be expanded.
4485
+ :type expand: List[str]
4486
+ :param limit: The amount of records shown in the list
4487
+ :type limit: int
4488
+ :param page: The page which is going to be shown
4489
+ :type page: int
4490
+ :param order_by: The parameter by which the response is ordered. default = name
4491
+ :type order_by: str
4492
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
4493
+ :type order_direction: str
4494
+ :param search_create_request:
4495
+ :type search_create_request: SearchCreateRequest
4496
+ :param _request_timeout: timeout setting for this request. If one
4497
+ number provided, it will be total request
4498
+ timeout. It can also be a pair (tuple) of
4499
+ (connection, read) timeouts.
4500
+ :type _request_timeout: int, tuple(int, int), optional
4501
+ :param _request_auth: set to override the auth_settings for an a single
4502
+ request; this effectively ignores the
4503
+ authentication in the spec for a single request.
4504
+ :type _request_auth: dict, optional
4505
+ :param _content_type: force content-type for the request.
4506
+ :type _content_type: str, Optional
4507
+ :param _headers: set to override the headers for a single
4508
+ request; this effectively ignores the headers
4509
+ in the spec for a single request.
4510
+ :type _headers: dict, optional
4511
+ :param _host_index: set to override the host_index for a single
4512
+ request; this effectively ignores the host_index
4513
+ in the spec for a single request.
4514
+ :type _host_index: int, optional
4515
+ :return: Returns the result object.
4516
+ """ # noqa: E501
4517
+
4518
+ _param = self._post_reports_search_serialize(
4519
+ version=version,
4520
+ x_platform_id=x_platform_id,
4521
+ expand=expand,
4522
+ limit=limit,
4523
+ page=page,
4524
+ order_by=order_by,
4525
+ order_direction=order_direction,
4526
+ search_create_request=search_create_request,
4527
+ _request_auth=_request_auth,
4528
+ _content_type=_content_type,
4529
+ _headers=_headers,
4530
+ _host_index=_host_index
4531
+ )
4532
+
4533
+ _response_types_map: Dict[str, Optional[str]] = {
4534
+ '200': "ReportResponseWrapper",
4535
+ '400': "ApiError",
4536
+ '401': "ApiError",
4537
+ '403': "ApiError",
4538
+ '500': "ApiError",
4539
+ }
4540
+ response_data = self.api_client.call_api(
4541
+ *_param,
4542
+ _request_timeout=_request_timeout
4543
+ )
4544
+ response_data.read()
4545
+ return self.api_client.response_deserialize(
4546
+ response_data=response_data,
4547
+ response_types_map=_response_types_map,
4548
+ )
4549
+
4550
+
4551
+ @validate_call
4552
+ def post_reports_search_without_preload_content(
4553
+ self,
4554
+ version: Annotated[StrictStr, Field(description="version")],
4555
+ x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
4556
+ expand: Annotated[Optional[List[StrictStr]], Field(description="The id fields of the resources that are going to be expanded.")] = None,
4557
+ limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
4558
+ page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
4559
+ order_by: Annotated[Optional[StrictStr], Field(description="The parameter by which the response is ordered. default = name")] = None,
4560
+ order_direction: Annotated[Optional[StrictStr], Field(description="The parameter for the response ordering direction (asc, desc) default asc")] = None,
4561
+ search_create_request: Optional[SearchCreateRequest] = None,
4562
+ _request_timeout: Union[
4563
+ None,
4564
+ Annotated[StrictFloat, Field(gt=0)],
4565
+ Tuple[
4566
+ Annotated[StrictFloat, Field(gt=0)],
4567
+ Annotated[StrictFloat, Field(gt=0)]
4568
+ ]
4569
+ ] = None,
4570
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
4571
+ _content_type: Optional[StrictStr] = None,
4572
+ _headers: Optional[Dict[StrictStr, Any]] = None,
4573
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4574
+ ) -> RESTResponseType:
4575
+ """Search reports
4576
+
4577
+ Requires the REPORT.VIEW permission.
4578
+
4579
+ :param version: version (required)
4580
+ :type version: str
4581
+ :param x_platform_id: Platform ID.
4582
+ :type x_platform_id: str
4583
+ :param expand: The id fields of the resources that are going to be expanded.
4584
+ :type expand: List[str]
4585
+ :param limit: The amount of records shown in the list
4586
+ :type limit: int
4587
+ :param page: The page which is going to be shown
4588
+ :type page: int
4589
+ :param order_by: The parameter by which the response is ordered. default = name
4590
+ :type order_by: str
4591
+ :param order_direction: The parameter for the response ordering direction (asc, desc) default asc
4592
+ :type order_direction: str
4593
+ :param search_create_request:
4594
+ :type search_create_request: SearchCreateRequest
4595
+ :param _request_timeout: timeout setting for this request. If one
4596
+ number provided, it will be total request
4597
+ timeout. It can also be a pair (tuple) of
4598
+ (connection, read) timeouts.
4599
+ :type _request_timeout: int, tuple(int, int), optional
4600
+ :param _request_auth: set to override the auth_settings for an a single
4601
+ request; this effectively ignores the
4602
+ authentication in the spec for a single request.
4603
+ :type _request_auth: dict, optional
4604
+ :param _content_type: force content-type for the request.
4605
+ :type _content_type: str, Optional
4606
+ :param _headers: set to override the headers for a single
4607
+ request; this effectively ignores the headers
4608
+ in the spec for a single request.
4609
+ :type _headers: dict, optional
4610
+ :param _host_index: set to override the host_index for a single
4611
+ request; this effectively ignores the host_index
4612
+ in the spec for a single request.
4613
+ :type _host_index: int, optional
4614
+ :return: Returns the result object.
4615
+ """ # noqa: E501
4616
+
4617
+ _param = self._post_reports_search_serialize(
4618
+ version=version,
4619
+ x_platform_id=x_platform_id,
4620
+ expand=expand,
4621
+ limit=limit,
4622
+ page=page,
4623
+ order_by=order_by,
4624
+ order_direction=order_direction,
4625
+ search_create_request=search_create_request,
4626
+ _request_auth=_request_auth,
4627
+ _content_type=_content_type,
4628
+ _headers=_headers,
4629
+ _host_index=_host_index
4630
+ )
4631
+
4632
+ _response_types_map: Dict[str, Optional[str]] = {
4633
+ '200': "ReportResponseWrapper",
4634
+ '400': "ApiError",
4635
+ '401': "ApiError",
4636
+ '403': "ApiError",
4637
+ '500': "ApiError",
4638
+ }
4639
+ response_data = self.api_client.call_api(
4640
+ *_param,
4641
+ _request_timeout=_request_timeout
4642
+ )
4643
+ return response_data.response
4644
+
4645
+
4646
+ def _post_reports_search_serialize(
4647
+ self,
4648
+ version,
4649
+ x_platform_id,
4650
+ expand,
4651
+ limit,
4652
+ page,
4653
+ order_by,
4654
+ order_direction,
4655
+ search_create_request,
4656
+ _request_auth,
4657
+ _content_type,
4658
+ _headers,
4659
+ _host_index,
4660
+ ) -> RequestSerialized:
4661
+
4662
+ _host = None
4663
+
4664
+ _collection_formats: Dict[str, str] = {
4665
+ 'expand[]': 'multi',
4666
+ }
4667
+
4668
+ _path_params: Dict[str, str] = {}
4669
+ _query_params: List[Tuple[str, str]] = []
4670
+ _header_params: Dict[str, Optional[str]] = _headers or {}
4671
+ _form_params: List[Tuple[str, str]] = []
4672
+ _files: Dict[
4673
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
4674
+ ] = {}
4675
+ _body_params: Optional[bytes] = None
4676
+
4677
+ # process the path parameters
4678
+ if version is not None:
4679
+ _path_params['version'] = version
4680
+ # process the query parameters
4681
+ if expand is not None:
4682
+
4683
+ _query_params.append(('expand[]', expand))
4684
+
4685
+ if limit is not None:
4686
+
4687
+ _query_params.append(('limit', limit))
4688
+
4689
+ if page is not None:
4690
+
4691
+ _query_params.append(('page', page))
4692
+
4693
+ if order_by is not None:
4694
+
4695
+ _query_params.append(('order_by', order_by))
4696
+
4697
+ if order_direction is not None:
4698
+
4699
+ _query_params.append(('order_direction', order_direction))
4700
+
4701
+ # process the header parameters
4702
+ if x_platform_id is not None:
4703
+ _header_params['x-platform-id'] = x_platform_id
4704
+ # process the form parameters
4705
+ # process the body parameter
4706
+ if search_create_request is not None:
4707
+ _body_params = search_create_request
4708
+
4709
+
4710
+ # set the HTTP header `Accept`
4711
+ if 'Accept' not in _header_params:
4712
+ _header_params['Accept'] = self.api_client.select_header_accept(
4713
+ [
4714
+ 'application/json',
4715
+ '*/*'
4716
+ ]
4717
+ )
4718
+
4719
+ # set the HTTP header `Content-Type`
4720
+ if _content_type:
4721
+ _header_params['Content-Type'] = _content_type
4722
+ else:
4723
+ _default_content_type = (
4724
+ self.api_client.select_header_content_type(
4725
+ [
4726
+ 'application/json'
4727
+ ]
4728
+ )
4729
+ )
4730
+ if _default_content_type is not None:
4731
+ _header_params['Content-Type'] = _default_content_type
4732
+
4733
+ # authentication setting
4734
+ _auth_settings: List[str] = [
4735
+ 'JWT-Authentication',
4736
+ 'API-Key'
4737
+ ]
4738
+
4739
+ return self.api_client.param_serialize(
4740
+ method='POST',
4741
+ resource_path='/v{version}/reports/search',
4742
+ path_params=_path_params,
4743
+ query_params=_query_params,
4744
+ header_params=_header_params,
4745
+ body=_body_params,
4746
+ post_params=_form_params,
4747
+ files=_files,
4748
+ auth_settings=_auth_settings,
4749
+ collection_formats=_collection_formats,
4750
+ _host=_host,
4751
+ _request_auth=_request_auth
4752
+ )
4753
+
4754
+