oci 2.126.2__py3-none-any.whl → 2.126.3__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 (323) hide show
  1. oci/__init__.py +2 -2
  2. oci/access_governance_cp/access_governance_cp_client.py +8 -8
  3. oci/adm/application_dependency_management_client.py +36 -36
  4. oci/ai_anomaly_detection/anomaly_detection_client.py +36 -36
  5. oci/ai_document/ai_service_document_client.py +22 -22
  6. oci/ai_language/ai_service_language_client.py +44 -44
  7. oci/ai_speech/ai_service_speech_client.py +10 -10
  8. oci/ai_vision/ai_service_vision_client.py +25 -25
  9. oci/analytics/analytics_client.py +23 -23
  10. oci/announcements_service/announcement_client.py +4 -4
  11. oci/announcements_service/announcement_subscription_client.py +9 -9
  12. oci/announcements_service/announcements_preferences_client.py +4 -4
  13. oci/apigateway/api_gateway_client.py +21 -21
  14. oci/apigateway/deployment_client.py +6 -6
  15. oci/apigateway/gateway_client.py +6 -6
  16. oci/apigateway/subscribers_client.py +6 -6
  17. oci/apigateway/usage_plans_client.py +6 -6
  18. oci/apigateway/work_requests_client.py +5 -5
  19. oci/apm_config/config_client.py +8 -8
  20. oci/apm_control_plane/apm_domain_client.py +14 -14
  21. oci/apm_synthetics/apm_synthetic_client.py +28 -28
  22. oci/apm_traces/attributes_client.py +8 -8
  23. oci/apm_traces/query_client.py +2 -2
  24. oci/apm_traces/trace_client.py +4 -4
  25. oci/appmgmt_control/appmgmt_control_client.py +8 -8
  26. oci/artifacts/artifacts_client.py +32 -32
  27. oci/audit/audit_client.py +3 -3
  28. oci/autoscaling/auto_scaling_client.py +11 -11
  29. oci/bastion/bastion_client.py +15 -15
  30. oci/bds/bds_client.py +51 -51
  31. oci/blockchain/blockchain_platform_client.py +27 -27
  32. oci/budget/budget_client.py +10 -10
  33. oci/capacity_management/capacity_management_client.py +19 -19
  34. oci/certificates/certificates_client.py +5 -5
  35. oci/certificates_management/certificates_management_client.py +32 -32
  36. oci/cims/incident_client.py +8 -8
  37. oci/cims/user_client.py +1 -1
  38. oci/cloud_bridge/common_client.py +5 -5
  39. oci/cloud_bridge/discovery_client.py +14 -14
  40. oci/cloud_bridge/inventory_client.py +16 -16
  41. oci/cloud_bridge/ocb_agent_svc_client.py +23 -23
  42. oci/cloud_guard/cloud_guard_client.py +155 -155
  43. oci/cloud_migrations/migration_client.py +43 -43
  44. oci/cluster_placement_groups/cluster_placement_groups_cp_client.py +13 -13
  45. oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py +12 -12
  46. oci/compute_instance_agent/compute_instance_agent_client.py +6 -6
  47. oci/compute_instance_agent/plugin_client.py +2 -2
  48. oci/compute_instance_agent/pluginconfig_client.py +1 -1
  49. oci/container_engine/container_engine_client.py +44 -44
  50. oci/container_instances/container_instance_client.py +18 -18
  51. oci/core/blockstorage_client.py +60 -60
  52. oci/core/compute_client.py +99 -99
  53. oci/core/compute_management_client.py +32 -32
  54. oci/core/virtual_network_client.py +247 -247
  55. oci/dashboard_service/dashboard_client.py +6 -6
  56. oci/dashboard_service/dashboard_group_client.py +6 -6
  57. oci/data_catalog/data_catalog_client.py +149 -149
  58. oci/data_flow/data_flow_client.py +42 -42
  59. oci/data_integration/data_integration_client.py +163 -163
  60. oci/data_labeling_service/data_labeling_management_client.py +17 -17
  61. oci/data_labeling_service_dataplane/data_labeling_client.py +15 -15
  62. oci/data_safe/data_safe_client.py +278 -278
  63. oci/data_science/data_science_client.py +91 -91
  64. oci/database/database_client.py +333 -333
  65. oci/database/models/create_vm_cluster_details.py +33 -2
  66. oci/database/models/exadata_infrastructure.py +31 -0
  67. oci/database/models/exadata_infrastructure_summary.py +31 -0
  68. oci/database/models/update_vm_cluster_details.py +33 -2
  69. oci/database/models/vm_cluster.py +33 -2
  70. oci/database/models/vm_cluster_summary.py +33 -2
  71. oci/database_management/db_management_client.py +206 -206
  72. oci/database_management/diagnosability_client.py +4 -4
  73. oci/database_management/managed_my_sql_databases_client.py +7 -7
  74. oci/database_management/perfhub_client.py +1 -1
  75. oci/database_management/sql_tuning_client.py +17 -17
  76. oci/database_migration/database_migration_client.py +41 -41
  77. oci/database_tools/database_tools_client.py +23 -23
  78. oci/desktops/desktop_service_client.py +21 -21
  79. oci/devops/devops_client.py +89 -89
  80. oci/disaster_recovery/disaster_recovery_client.py +29 -29
  81. oci/dns/dns_client.py +52 -52
  82. oci/dts/appliance_export_job_client.py +6 -6
  83. oci/dts/shipping_vendors_client.py +1 -1
  84. oci/dts/transfer_appliance_client.py +8 -8
  85. oci/dts/transfer_appliance_entitlement_client.py +3 -3
  86. oci/dts/transfer_device_client.py +5 -5
  87. oci/dts/transfer_job_client.py +6 -6
  88. oci/dts/transfer_package_client.py +7 -7
  89. oci/em_warehouse/em_data_lake_client.py +13 -13
  90. oci/em_warehouse/em_warehouse_client.py +13 -13
  91. oci/email/email_client.py +608 -28
  92. oci/email/email_client_composite_operations.py +132 -0
  93. oci/email/models/__init__.py +10 -0
  94. oci/email/models/create_email_domain_details.py +31 -0
  95. oci/email/models/create_email_return_path_details.py +239 -0
  96. oci/email/models/email_domain.py +82 -0
  97. oci/email/models/email_return_path.py +577 -0
  98. oci/email/models/email_return_path_collection.py +72 -0
  99. oci/email/models/email_return_path_summary.py +444 -0
  100. oci/email/models/sender.py +15 -3
  101. oci/email/models/update_email_domain_details.py +31 -0
  102. oci/email/models/update_email_return_path_details.py +156 -0
  103. oci/email/models/work_request.py +15 -3
  104. oci/email/models/work_request_summary.py +15 -3
  105. oci/email_data_plane/email_dp_client.py +1 -1
  106. oci/events/events_client.py +6 -6
  107. oci/file_storage/file_storage_client.py +50 -50
  108. oci/fleet_software_update/fleet_software_update_client.py +44 -44
  109. oci/functions/functions_invoke_client.py +1 -1
  110. oci/functions/functions_management_client.py +16 -16
  111. oci/fusion_apps/data_masking_activity_client.py +3 -3
  112. oci/fusion_apps/fusion_applications_client.py +39 -39
  113. oci/fusion_apps/fusion_environment_client.py +15 -15
  114. oci/fusion_apps/fusion_environment_family_client.py +8 -8
  115. oci/fusion_apps/refresh_activity_client.py +4 -4
  116. oci/fusion_apps/scheduled_activity_client.py +2 -2
  117. oci/fusion_apps/service_attachment_client.py +2 -2
  118. oci/generative_ai/generative_ai_client.py +22 -22
  119. oci/generative_ai_inference/generative_ai_inference_client.py +4 -4
  120. oci/generic_artifacts_content/generic_artifacts_content_client.py +3 -3
  121. oci/globally_distributed_database/sharded_database_service_client.py +29 -29
  122. oci/golden_gate/golden_gate_client.py +61 -61
  123. oci/governance_rules_control_plane/governance_rule_client.py +15 -15
  124. oci/governance_rules_control_plane/work_request_client.py +5 -5
  125. oci/healthchecks/health_checks_client.py +17 -17
  126. oci/identity/identity_client.py +145 -145
  127. oci/identity_data_plane/dataplane_client.py +2 -2
  128. oci/identity_domains/identity_domains_client.py +300 -300
  129. oci/integration/integration_instance_client.py +15 -15
  130. oci/jms/java_management_service_client.py +66 -66
  131. oci/jms_java_downloads/java_download_client.py +25 -25
  132. oci/key_management/ekm_client.py +5 -5
  133. oci/key_management/kms_crypto_client.py +6 -6
  134. oci/key_management/kms_hsm_cluster_client.py +12 -12
  135. oci/key_management/kms_management_client.py +21 -21
  136. oci/key_management/kms_vault_client.py +14 -14
  137. oci/license_manager/license_manager_client.py +18 -18
  138. oci/limits/limits_client.py +4 -4
  139. oci/limits/quotas_client.py +7 -7
  140. oci/load_balancer/load_balancer_client.py +61 -61
  141. oci/load_balancer/models/ssl_configuration.py +41 -0
  142. oci/load_balancer/models/ssl_configuration_details.py +41 -0
  143. oci/lockbox/lockbox_client.py +24 -24
  144. oci/log_analytics/log_analytics_client.py +193 -193
  145. oci/logging/logging_management_client.py +30 -30
  146. oci/loggingingestion/logging_client.py +1 -1
  147. oci/loggingsearch/log_search_client.py +1 -1
  148. oci/management_agent/management_agent_client.py +28 -28
  149. oci/management_dashboard/dashx_apis_client.py +14 -14
  150. oci/marketplace/account_client.py +2 -2
  151. oci/marketplace/marketplace_client.py +30 -30
  152. oci/marketplace_private_offer/__init__.py +16 -0
  153. oci/marketplace_private_offer/attachment_client.py +719 -0
  154. oci/marketplace_private_offer/attachment_client_composite_operations.py +71 -0
  155. oci/marketplace_private_offer/models/__init__.py +48 -0
  156. oci/marketplace_private_offer/models/attachment.py +446 -0
  157. oci/marketplace_private_offer/models/attachment_collection.py +72 -0
  158. oci/marketplace_private_offer/models/attachment_summary.py +293 -0
  159. oci/marketplace_private_offer/models/buyer_information.py +161 -0
  160. oci/marketplace_private_offer/models/contact.py +134 -0
  161. oci/marketplace_private_offer/models/create_attachment_details.py +134 -0
  162. oci/marketplace_private_offer/models/create_offer_details.py +498 -0
  163. oci/marketplace_private_offer/models/custom_field.py +103 -0
  164. oci/marketplace_private_offer/models/offer.py +787 -0
  165. oci/marketplace_private_offer/models/offer_collection.py +72 -0
  166. oci/marketplace_private_offer/models/offer_internal_detail.py +103 -0
  167. oci/marketplace_private_offer/models/offer_summary.py +591 -0
  168. oci/marketplace_private_offer/models/pricing.py +146 -0
  169. oci/marketplace_private_offer/models/publisher_summary.py +710 -0
  170. oci/marketplace_private_offer/models/resource_bundle.py +205 -0
  171. oci/marketplace_private_offer/models/seller_information.py +99 -0
  172. oci/marketplace_private_offer/models/update_offer_details.py +467 -0
  173. oci/marketplace_private_offer/models/upload_data.py +134 -0
  174. oci/marketplace_private_offer/offer_client.py +789 -0
  175. oci/marketplace_private_offer/offer_client_composite_operations.py +172 -0
  176. oci/marketplace_publisher/__init__.py +5 -1
  177. oci/marketplace_publisher/attachment_client.py +719 -0
  178. oci/marketplace_publisher/attachment_client_composite_operations.py +121 -0
  179. oci/marketplace_publisher/marketplace_publisher_client.py +71 -71
  180. oci/marketplace_publisher/models/__init__.py +32 -0
  181. oci/marketplace_publisher/models/attachment.py +446 -0
  182. oci/marketplace_publisher/models/attachment_collection.py +72 -0
  183. oci/marketplace_publisher/models/attachment_summary.py +293 -0
  184. oci/marketplace_publisher/models/buyer_information.py +161 -0
  185. oci/marketplace_publisher/models/contact.py +134 -0
  186. oci/marketplace_publisher/models/create_attachment_details.py +134 -0
  187. oci/marketplace_publisher/models/create_offer_details.py +498 -0
  188. oci/marketplace_publisher/models/custom_field.py +103 -0
  189. oci/marketplace_publisher/models/offer.py +787 -0
  190. oci/marketplace_publisher/models/offer_collection.py +72 -0
  191. oci/marketplace_publisher/models/offer_internal_detail.py +103 -0
  192. oci/marketplace_publisher/models/offer_summary.py +591 -0
  193. oci/marketplace_publisher/models/pricing.py +146 -0
  194. oci/marketplace_publisher/models/resource_bundle.py +205 -0
  195. oci/marketplace_publisher/models/seller_information.py +99 -0
  196. oci/marketplace_publisher/models/update_offer_details.py +467 -0
  197. oci/marketplace_publisher/models/work_request.py +23 -3
  198. oci/marketplace_publisher/models/work_request_summary.py +23 -3
  199. oci/marketplace_publisher/offer_client.py +789 -0
  200. oci/marketplace_publisher/offer_client_composite_operations.py +160 -0
  201. oci/media_services/media_services_client.py +60 -60
  202. oci/media_services/media_stream_client.py +2 -2
  203. oci/monitoring/monitoring_client.py +18 -18
  204. oci/mysql/channels_client.py +7 -7
  205. oci/mysql/db_backups_client.py +6 -6
  206. oci/mysql/db_system_client.py +17 -17
  207. oci/mysql/mysqlaas_client.py +7 -7
  208. oci/mysql/replicas_client.py +5 -5
  209. oci/mysql/work_requests_client.py +4 -4
  210. oci/network_firewall/network_firewall_client.py +80 -80
  211. oci/network_load_balancer/models/create_listener_details.py +33 -2
  212. oci/network_load_balancer/models/listener.py +33 -2
  213. oci/network_load_balancer/models/listener_details.py +33 -2
  214. oci/network_load_balancer/models/listener_summary.py +33 -2
  215. oci/network_load_balancer/models/update_listener_details.py +33 -2
  216. oci/network_load_balancer/network_load_balancer_client.py +34 -34
  217. oci/nosql/nosql_client.py +24 -24
  218. oci/object_storage/object_storage_client.py +50 -50
  219. oci/oce/oce_instance_client.py +10 -10
  220. oci/oci_control_center/occ_metrics_client.py +3 -3
  221. oci/ocvp/cluster_client.py +5 -5
  222. oci/ocvp/esxi_host_client.py +8 -8
  223. oci/ocvp/sddc_client.py +14 -14
  224. oci/ocvp/work_request_client.py +4 -4
  225. oci/oda/management_client.py +59 -59
  226. oci/oda/oda_client.py +17 -17
  227. oci/oda/odapackage_client.py +7 -7
  228. oci/onesubscription/billing_schedule_client.py +1 -1
  229. oci/onesubscription/commitment_client.py +2 -2
  230. oci/onesubscription/computed_usage_client.py +3 -3
  231. oci/onesubscription/invoice_summary_client.py +2 -2
  232. oci/onesubscription/organization_subscription_client.py +1 -1
  233. oci/onesubscription/ratecard_client.py +1 -1
  234. oci/onesubscription/subscribed_service_client.py +2 -2
  235. oci/onesubscription/subscription_client.py +1 -1
  236. oci/ons/notification_control_plane_client.py +6 -6
  237. oci/ons/notification_data_plane_client.py +10 -10
  238. oci/opa/opa_instance_client.py +13 -13
  239. oci/opensearch/opensearch_cluster_backup_client.py +4 -4
  240. oci/opensearch/opensearch_cluster_client.py +14 -14
  241. oci/operator_access_control/access_requests_client.py +10 -10
  242. oci/operator_access_control/operator_actions_client.py +2 -2
  243. oci/operator_access_control/operator_control_assignment_client.py +8 -8
  244. oci/operator_access_control/operator_control_client.py +6 -6
  245. oci/opsi/operations_insights_client.py +175 -175
  246. oci/optimizer/optimizer_client.py +26 -26
  247. oci/os_management/event_client.py +8 -8
  248. oci/os_management/os_management_client.py +69 -69
  249. oci/os_management_hub/event_client.py +8 -8
  250. oci/os_management_hub/lifecycle_environment_client.py +12 -12
  251. oci/os_management_hub/managed_instance_client.py +31 -31
  252. oci/os_management_hub/managed_instance_group_client.py +25 -25
  253. oci/os_management_hub/management_station_client.py +10 -10
  254. oci/os_management_hub/onboarding_client.py +6 -6
  255. oci/os_management_hub/reporting_managed_instance_client.py +3 -3
  256. oci/os_management_hub/scheduled_job_client.py +7 -7
  257. oci/os_management_hub/software_source_client.py +27 -27
  258. oci/os_management_hub/work_request_client.py +4 -4
  259. oci/osp_gateway/address_rule_service_client.py +1 -1
  260. oci/osp_gateway/address_service_client.py +2 -2
  261. oci/osp_gateway/invoice_service_client.py +5 -5
  262. oci/osp_gateway/subscription_service_client.py +5 -5
  263. oci/osub_billing_schedule/billing_schedule_client.py +1 -1
  264. oci/osub_organization_subscription/organization_subscription_client.py +1 -1
  265. oci/osub_subscription/commitment_client.py +2 -2
  266. oci/osub_subscription/ratecard_client.py +1 -1
  267. oci/osub_subscription/subscription_client.py +1 -1
  268. oci/osub_usage/computed_usage_client.py +3 -3
  269. oci/psql/postgresql_client.py +33 -33
  270. oci/queue/queue_admin_client.py +11 -11
  271. oci/queue/queue_client.py +8 -8
  272. oci/recovery/database_recovery_client.py +25 -25
  273. oci/redis/redis_cluster_client.py +11 -11
  274. oci/resource_manager/resource_manager_client.py +52 -52
  275. oci/resource_search/resource_search_client.py +3 -3
  276. oci/rover/rover_bundle_client.py +8 -8
  277. oci/rover/rover_cluster_client.py +8 -8
  278. oci/rover/rover_entitlement_client.py +6 -6
  279. oci/rover/rover_node_client.py +15 -15
  280. oci/rover/shape_client.py +1 -1
  281. oci/rover/work_requests_client.py +5 -5
  282. oci/sch/connector_plugins_client.py +2 -2
  283. oci/sch/service_connector_client.py +12 -12
  284. oci/secrets/secrets_client.py +3 -3
  285. oci/service_catalog/service_catalog_client.py +26 -26
  286. oci/service_manager_proxy/service_manager_proxy_client.py +2 -2
  287. oci/service_mesh/service_mesh_client.py +48 -48
  288. oci/stack_monitoring/stack_monitoring_client.py +64 -64
  289. oci/streaming/stream_admin_client.py +18 -18
  290. oci/streaming/stream_client.py +8 -8
  291. oci/tenant_manager_control_plane/domain_client.py +5 -5
  292. oci/tenant_manager_control_plane/domain_governance_client.py +5 -5
  293. oci/tenant_manager_control_plane/governance_client.py +2 -2
  294. oci/tenant_manager_control_plane/link_client.py +3 -3
  295. oci/tenant_manager_control_plane/orders_client.py +2 -2
  296. oci/tenant_manager_control_plane/organization_client.py +10 -10
  297. oci/tenant_manager_control_plane/recipient_invitation_client.py +5 -5
  298. oci/tenant_manager_control_plane/sender_invitation_client.py +5 -5
  299. oci/tenant_manager_control_plane/subscription_client.py +11 -11
  300. oci/tenant_manager_control_plane/work_request_client.py +4 -4
  301. oci/threat_intelligence/threatintel_client.py +5 -5
  302. oci/usage/resources_client.py +2 -2
  303. oci/usage/rewards_client.py +6 -6
  304. oci/usage/usagelimits_client.py +1 -1
  305. oci/usage_api/usageapi_client.py +33 -33
  306. oci/vault/vaults_client.py +13 -13
  307. oci/vbs_inst/vbs_instance_client.py +10 -10
  308. oci/version.py +1 -1
  309. oci/visual_builder/vb_instance_client.py +13 -13
  310. oci/vn_monitoring/vn_monitoring_client.py +12 -12
  311. oci/vulnerability_scanning/vulnerability_scanning_client.py +58 -58
  312. oci/waa/waa_client.py +13 -13
  313. oci/waa/work_request_client.py +4 -4
  314. oci/waas/redirect_client.py +6 -6
  315. oci/waas/waas_client.py +66 -66
  316. oci/waf/waf_client.py +24 -24
  317. oci/work_requests/work_request_client.py +4 -4
  318. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/METADATA +1 -1
  319. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/RECORD +323 -274
  320. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/LICENSE.txt +0 -0
  321. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/THIRD_PARTY_LICENSES.txt +0 -0
  322. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/WHEEL +0 -0
  323. {oci-2.126.2.dist-info → oci-2.126.3.dist-info}/top_level.txt +0 -0
oci/email/email_client.py CHANGED
@@ -171,7 +171,7 @@ class EmailClient(object):
171
171
  :rtype: :class:`~oci.response.Response`
172
172
 
173
173
  :example:
174
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/change_email_domain_compartment.py.html>`__ to see an example of how to use change_email_domain_compartment API.
174
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/change_email_domain_compartment.py.html>`__ to see an example of how to use change_email_domain_compartment API.
175
175
  """
176
176
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
177
177
  required_arguments = ['emailDomainId']
@@ -280,7 +280,7 @@ class EmailClient(object):
280
280
  :rtype: :class:`~oci.response.Response`
281
281
 
282
282
  :example:
283
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/change_sender_compartment.py.html>`__ to see an example of how to use change_sender_compartment API.
283
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/change_sender_compartment.py.html>`__ to see an example of how to use change_sender_compartment API.
284
284
  """
285
285
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
286
286
  required_arguments = ['senderId']
@@ -389,7 +389,7 @@ class EmailClient(object):
389
389
  :rtype: :class:`~oci.response.Response`
390
390
 
391
391
  :example:
392
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/create_dkim.py.html>`__ to see an example of how to use create_dkim API.
392
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/create_dkim.py.html>`__ to see an example of how to use create_dkim API.
393
393
  """
394
394
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
395
395
  required_arguments = []
@@ -485,7 +485,7 @@ class EmailClient(object):
485
485
  :rtype: :class:`~oci.response.Response`
486
486
 
487
487
  :example:
488
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/create_email_domain.py.html>`__ to see an example of how to use create_email_domain API.
488
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/create_email_domain.py.html>`__ to see an example of how to use create_email_domain API.
489
489
  """
490
490
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
491
491
  required_arguments = []
@@ -547,6 +547,102 @@ class EmailClient(object):
547
547
  api_reference_link=api_reference_link,
548
548
  required_arguments=required_arguments)
549
549
 
550
+ def create_email_return_path(self, create_email_return_path_details, **kwargs):
551
+ """
552
+ Creates a new email return path. Avoid entering confidential information.
553
+
554
+
555
+ :param oci.email.models.CreateEmailReturnPathDetails create_email_return_path_details: (required)
556
+ The email return path to create.
557
+
558
+ :param str opc_request_id: (optional)
559
+ The request ID for tracing from the system
560
+
561
+ :param str opc_retry_token: (optional)
562
+ A token that uniquely identifies a request so it can be retried in case of a timeout or
563
+ server error without risk of executing that same action again. Retry tokens expire after 24
564
+ hours, but can be invalidated before then due to conflicting operations. For example, if a resource
565
+ has been deleted and purged from the system, then a retry of the original creation request
566
+ might be rejected.
567
+
568
+ :param obj retry_strategy: (optional)
569
+ A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
570
+
571
+ This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
572
+ The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
573
+
574
+ To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
575
+
576
+ :param bool allow_control_chars: (optional)
577
+ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
578
+ By default, the response will not allow control characters in strings
579
+
580
+ :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.EmailReturnPath`
581
+ :rtype: :class:`~oci.response.Response`
582
+
583
+ :example:
584
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/create_email_return_path.py.html>`__ to see an example of how to use create_email_return_path API.
585
+ """
586
+ # Required path and query arguments. These are in camelCase to replace values in service endpoints.
587
+ required_arguments = []
588
+ resource_path = "/emailReturnPaths"
589
+ method = "POST"
590
+ operation_name = "create_email_return_path"
591
+ api_reference_link = "https://docs.oracle.com/iaas/api/#/en/emaildelivery/20170907/EmailReturnPath/CreateEmailReturnPath"
592
+
593
+ # Don't accept unknown kwargs
594
+ expected_kwargs = [
595
+ "allow_control_chars",
596
+ "retry_strategy",
597
+ "opc_request_id",
598
+ "opc_retry_token"
599
+ ]
600
+ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
601
+ if extra_kwargs:
602
+ raise ValueError(
603
+ f"create_email_return_path got unknown kwargs: {extra_kwargs!r}")
604
+
605
+ header_params = {
606
+ "accept": "application/json",
607
+ "content-type": "application/json",
608
+ "opc-request-id": kwargs.get("opc_request_id", missing),
609
+ "opc-retry-token": kwargs.get("opc_retry_token", missing)
610
+ }
611
+ header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
612
+
613
+ retry_strategy = self.base_client.get_preferred_retry_strategy(
614
+ operation_retry_strategy=kwargs.get('retry_strategy'),
615
+ client_retry_strategy=self.retry_strategy
616
+ )
617
+
618
+ if retry_strategy:
619
+ if not isinstance(retry_strategy, retry.NoneRetryStrategy):
620
+ self.base_client.add_opc_retry_token_if_needed(header_params)
621
+ self.base_client.add_opc_client_retries_header(header_params)
622
+ retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
623
+ return retry_strategy.make_retrying_call(
624
+ self.base_client.call_api,
625
+ resource_path=resource_path,
626
+ method=method,
627
+ header_params=header_params,
628
+ body=create_email_return_path_details,
629
+ response_type="EmailReturnPath",
630
+ allow_control_chars=kwargs.get('allow_control_chars'),
631
+ operation_name=operation_name,
632
+ api_reference_link=api_reference_link,
633
+ required_arguments=required_arguments)
634
+ else:
635
+ return self.base_client.call_api(
636
+ resource_path=resource_path,
637
+ method=method,
638
+ header_params=header_params,
639
+ body=create_email_return_path_details,
640
+ response_type="EmailReturnPath",
641
+ allow_control_chars=kwargs.get('allow_control_chars'),
642
+ operation_name=operation_name,
643
+ api_reference_link=api_reference_link,
644
+ required_arguments=required_arguments)
645
+
550
646
  def create_sender(self, create_sender_details, **kwargs):
551
647
  """
552
648
  Creates a sender for a tenancy in a given compartment.
@@ -574,7 +670,7 @@ class EmailClient(object):
574
670
  :rtype: :class:`~oci.response.Response`
575
671
 
576
672
  :example:
577
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/create_sender.py.html>`__ to see an example of how to use create_sender API.
673
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/create_sender.py.html>`__ to see an example of how to use create_sender API.
578
674
  """
579
675
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
580
676
  required_arguments = []
@@ -663,7 +759,7 @@ class EmailClient(object):
663
759
  :rtype: :class:`~oci.response.Response`
664
760
 
665
761
  :example:
666
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/create_suppression.py.html>`__ to see an example of how to use create_suppression API.
762
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/create_suppression.py.html>`__ to see an example of how to use create_suppression API.
667
763
  """
668
764
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
669
765
  required_arguments = []
@@ -761,7 +857,7 @@ class EmailClient(object):
761
857
  :rtype: :class:`~oci.response.Response`
762
858
 
763
859
  :example:
764
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/delete_dkim.py.html>`__ to see an example of how to use delete_dkim API.
860
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/delete_dkim.py.html>`__ to see an example of how to use delete_dkim API.
765
861
  """
766
862
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
767
863
  required_arguments = ['dkimId']
@@ -864,7 +960,7 @@ class EmailClient(object):
864
960
  :rtype: :class:`~oci.response.Response`
865
961
 
866
962
  :example:
867
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/delete_email_domain.py.html>`__ to see an example of how to use delete_email_domain API.
963
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/delete_email_domain.py.html>`__ to see an example of how to use delete_email_domain API.
868
964
  """
869
965
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
870
966
  required_arguments = ['emailDomainId']
@@ -933,6 +1029,109 @@ class EmailClient(object):
933
1029
  api_reference_link=api_reference_link,
934
1030
  required_arguments=required_arguments)
935
1031
 
1032
+ def delete_email_return_path(self, email_return_path_id, **kwargs):
1033
+ """
1034
+ Deletes an email return path.
1035
+
1036
+
1037
+ :param str email_return_path_id: (required)
1038
+ The `OCID`__ of this email return path.
1039
+
1040
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
1041
+
1042
+ :param str if_match: (optional)
1043
+ Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`
1044
+ parameter to the value of the etag from a previous get, create, or update response for that resource. The resource
1045
+ will be updated or deleted only if the etag you provide matches the resource's current etag value.
1046
+
1047
+ :param str opc_request_id: (optional)
1048
+ The request ID for tracing from the system
1049
+
1050
+ :param obj retry_strategy: (optional)
1051
+ A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
1052
+
1053
+ This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
1054
+ The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
1055
+
1056
+ To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
1057
+
1058
+ :param bool allow_control_chars: (optional)
1059
+ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
1060
+ By default, the response will not allow control characters in strings
1061
+
1062
+ :return: A :class:`~oci.response.Response` object with data of type None
1063
+ :rtype: :class:`~oci.response.Response`
1064
+
1065
+ :example:
1066
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/delete_email_return_path.py.html>`__ to see an example of how to use delete_email_return_path API.
1067
+ """
1068
+ # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1069
+ required_arguments = ['emailReturnPathId']
1070
+ resource_path = "/emailReturnPaths/{emailReturnPathId}"
1071
+ method = "DELETE"
1072
+ operation_name = "delete_email_return_path"
1073
+ api_reference_link = "https://docs.oracle.com/iaas/api/#/en/emaildelivery/20170907/EmailReturnPath/DeleteEmailReturnPath"
1074
+
1075
+ # Don't accept unknown kwargs
1076
+ expected_kwargs = [
1077
+ "allow_control_chars",
1078
+ "retry_strategy",
1079
+ "if_match",
1080
+ "opc_request_id"
1081
+ ]
1082
+ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
1083
+ if extra_kwargs:
1084
+ raise ValueError(
1085
+ f"delete_email_return_path got unknown kwargs: {extra_kwargs!r}")
1086
+
1087
+ path_params = {
1088
+ "emailReturnPathId": email_return_path_id
1089
+ }
1090
+
1091
+ path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
1092
+
1093
+ for (k, v) in six.iteritems(path_params):
1094
+ if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
1095
+ raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
1096
+
1097
+ header_params = {
1098
+ "accept": "application/json",
1099
+ "content-type": "application/json",
1100
+ "if-match": kwargs.get("if_match", missing),
1101
+ "opc-request-id": kwargs.get("opc_request_id", missing)
1102
+ }
1103
+ header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
1104
+
1105
+ retry_strategy = self.base_client.get_preferred_retry_strategy(
1106
+ operation_retry_strategy=kwargs.get('retry_strategy'),
1107
+ client_retry_strategy=self.retry_strategy
1108
+ )
1109
+
1110
+ if retry_strategy:
1111
+ if not isinstance(retry_strategy, retry.NoneRetryStrategy):
1112
+ self.base_client.add_opc_client_retries_header(header_params)
1113
+ retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
1114
+ return retry_strategy.make_retrying_call(
1115
+ self.base_client.call_api,
1116
+ resource_path=resource_path,
1117
+ method=method,
1118
+ path_params=path_params,
1119
+ header_params=header_params,
1120
+ allow_control_chars=kwargs.get('allow_control_chars'),
1121
+ operation_name=operation_name,
1122
+ api_reference_link=api_reference_link,
1123
+ required_arguments=required_arguments)
1124
+ else:
1125
+ return self.base_client.call_api(
1126
+ resource_path=resource_path,
1127
+ method=method,
1128
+ path_params=path_params,
1129
+ header_params=header_params,
1130
+ allow_control_chars=kwargs.get('allow_control_chars'),
1131
+ operation_name=operation_name,
1132
+ api_reference_link=api_reference_link,
1133
+ required_arguments=required_arguments)
1134
+
936
1135
  def delete_sender(self, sender_id, **kwargs):
937
1136
  """
938
1137
  Deletes an approved sender for a tenancy in a given compartment for a
@@ -966,7 +1165,7 @@ class EmailClient(object):
966
1165
  :rtype: :class:`~oci.response.Response`
967
1166
 
968
1167
  :example:
969
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/delete_sender.py.html>`__ to see an example of how to use delete_sender API.
1168
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/delete_sender.py.html>`__ to see an example of how to use delete_sender API.
970
1169
  """
971
1170
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
972
1171
  required_arguments = ['senderId']
@@ -1063,7 +1262,7 @@ class EmailClient(object):
1063
1262
  :rtype: :class:`~oci.response.Response`
1064
1263
 
1065
1264
  :example:
1066
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/delete_suppression.py.html>`__ to see an example of how to use delete_suppression API.
1265
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/delete_suppression.py.html>`__ to see an example of how to use delete_suppression API.
1067
1266
  """
1068
1267
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1069
1268
  required_arguments = ['suppressionId']
@@ -1159,7 +1358,7 @@ class EmailClient(object):
1159
1358
  :rtype: :class:`~oci.response.Response`
1160
1359
 
1161
1360
  :example:
1162
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_dkim.py.html>`__ to see an example of how to use get_dkim API.
1361
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_dkim.py.html>`__ to see an example of how to use get_dkim API.
1163
1362
  """
1164
1363
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1165
1364
  required_arguments = ['dkimId']
@@ -1255,7 +1454,7 @@ class EmailClient(object):
1255
1454
  :rtype: :class:`~oci.response.Response`
1256
1455
 
1257
1456
  :example:
1258
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_email_configuration.py.html>`__ to see an example of how to use get_email_configuration API.
1457
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_email_configuration.py.html>`__ to see an example of how to use get_email_configuration API.
1259
1458
  """
1260
1459
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1261
1460
  required_arguments = ['compartmentId']
@@ -1348,7 +1547,7 @@ class EmailClient(object):
1348
1547
  :rtype: :class:`~oci.response.Response`
1349
1548
 
1350
1549
  :example:
1351
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_email_domain.py.html>`__ to see an example of how to use get_email_domain API.
1550
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_email_domain.py.html>`__ to see an example of how to use get_email_domain API.
1352
1551
  """
1353
1552
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1354
1553
  required_arguments = ['emailDomainId']
@@ -1417,6 +1616,104 @@ class EmailClient(object):
1417
1616
  api_reference_link=api_reference_link,
1418
1617
  required_arguments=required_arguments)
1419
1618
 
1619
+ def get_email_return_path(self, email_return_path_id, **kwargs):
1620
+ """
1621
+ Retrieves the specified email return path.
1622
+
1623
+
1624
+ :param str email_return_path_id: (required)
1625
+ The `OCID`__ of this email return path.
1626
+
1627
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
1628
+
1629
+ :param str opc_request_id: (optional)
1630
+ The request ID for tracing from the system
1631
+
1632
+ :param obj retry_strategy: (optional)
1633
+ A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
1634
+
1635
+ This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
1636
+ The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
1637
+
1638
+ To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
1639
+
1640
+ :param bool allow_control_chars: (optional)
1641
+ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
1642
+ By default, the response will not allow control characters in strings
1643
+
1644
+ :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.EmailReturnPath`
1645
+ :rtype: :class:`~oci.response.Response`
1646
+
1647
+ :example:
1648
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_email_return_path.py.html>`__ to see an example of how to use get_email_return_path API.
1649
+ """
1650
+ # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1651
+ required_arguments = ['emailReturnPathId']
1652
+ resource_path = "/emailReturnPaths/{emailReturnPathId}"
1653
+ method = "GET"
1654
+ operation_name = "get_email_return_path"
1655
+ api_reference_link = "https://docs.oracle.com/iaas/api/#/en/emaildelivery/20170907/EmailReturnPath/GetEmailReturnPath"
1656
+
1657
+ # Don't accept unknown kwargs
1658
+ expected_kwargs = [
1659
+ "allow_control_chars",
1660
+ "retry_strategy",
1661
+ "opc_request_id"
1662
+ ]
1663
+ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
1664
+ if extra_kwargs:
1665
+ raise ValueError(
1666
+ f"get_email_return_path got unknown kwargs: {extra_kwargs!r}")
1667
+
1668
+ path_params = {
1669
+ "emailReturnPathId": email_return_path_id
1670
+ }
1671
+
1672
+ path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
1673
+
1674
+ for (k, v) in six.iteritems(path_params):
1675
+ if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
1676
+ raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
1677
+
1678
+ header_params = {
1679
+ "accept": "application/json",
1680
+ "content-type": "application/json",
1681
+ "opc-request-id": kwargs.get("opc_request_id", missing)
1682
+ }
1683
+ header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
1684
+
1685
+ retry_strategy = self.base_client.get_preferred_retry_strategy(
1686
+ operation_retry_strategy=kwargs.get('retry_strategy'),
1687
+ client_retry_strategy=self.retry_strategy
1688
+ )
1689
+
1690
+ if retry_strategy:
1691
+ if not isinstance(retry_strategy, retry.NoneRetryStrategy):
1692
+ self.base_client.add_opc_client_retries_header(header_params)
1693
+ retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
1694
+ return retry_strategy.make_retrying_call(
1695
+ self.base_client.call_api,
1696
+ resource_path=resource_path,
1697
+ method=method,
1698
+ path_params=path_params,
1699
+ header_params=header_params,
1700
+ response_type="EmailReturnPath",
1701
+ allow_control_chars=kwargs.get('allow_control_chars'),
1702
+ operation_name=operation_name,
1703
+ api_reference_link=api_reference_link,
1704
+ required_arguments=required_arguments)
1705
+ else:
1706
+ return self.base_client.call_api(
1707
+ resource_path=resource_path,
1708
+ method=method,
1709
+ path_params=path_params,
1710
+ header_params=header_params,
1711
+ response_type="EmailReturnPath",
1712
+ allow_control_chars=kwargs.get('allow_control_chars'),
1713
+ operation_name=operation_name,
1714
+ api_reference_link=api_reference_link,
1715
+ required_arguments=required_arguments)
1716
+
1420
1717
  def get_sender(self, sender_id, **kwargs):
1421
1718
  """
1422
1719
  Gets an approved sender for a given `senderId`.
@@ -1444,7 +1741,7 @@ class EmailClient(object):
1444
1741
  :rtype: :class:`~oci.response.Response`
1445
1742
 
1446
1743
  :example:
1447
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_sender.py.html>`__ to see an example of how to use get_sender API.
1744
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_sender.py.html>`__ to see an example of how to use get_sender API.
1448
1745
  """
1449
1746
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1450
1747
  required_arguments = ['senderId']
@@ -1541,7 +1838,7 @@ class EmailClient(object):
1541
1838
  :rtype: :class:`~oci.response.Response`
1542
1839
 
1543
1840
  :example:
1544
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_suppression.py.html>`__ to see an example of how to use get_suppression API.
1841
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_suppression.py.html>`__ to see an example of how to use get_suppression API.
1545
1842
  """
1546
1843
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1547
1844
  required_arguments = ['suppressionId']
@@ -1637,7 +1934,7 @@ class EmailClient(object):
1637
1934
  :rtype: :class:`~oci.response.Response`
1638
1935
 
1639
1936
  :example:
1640
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/get_work_request.py.html>`__ to see an example of how to use get_work_request API.
1937
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/get_work_request.py.html>`__ to see an example of how to use get_work_request API.
1641
1938
  """
1642
1939
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1643
1940
  required_arguments = ['workRequestId']
@@ -1776,7 +2073,7 @@ class EmailClient(object):
1776
2073
  :rtype: :class:`~oci.response.Response`
1777
2074
 
1778
2075
  :example:
1779
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_dkims.py.html>`__ to see an example of how to use list_dkims API.
2076
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_dkims.py.html>`__ to see an example of how to use list_dkims API.
1780
2077
  """
1781
2078
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1782
2079
  required_arguments = ['emailDomainId']
@@ -1943,7 +2240,7 @@ class EmailClient(object):
1943
2240
  :rtype: :class:`~oci.response.Response`
1944
2241
 
1945
2242
  :example:
1946
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_email_domains.py.html>`__ to see an example of how to use list_email_domains API.
2243
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_email_domains.py.html>`__ to see an example of how to use list_email_domains API.
1947
2244
  """
1948
2245
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
1949
2246
  required_arguments = ['compartmentId']
@@ -2042,6 +2339,181 @@ class EmailClient(object):
2042
2339
  api_reference_link=api_reference_link,
2043
2340
  required_arguments=required_arguments)
2044
2341
 
2342
+ def list_email_return_paths(self, **kwargs):
2343
+ """
2344
+ Lists email return paths in the specified compartment or emaildomain.
2345
+
2346
+
2347
+ :param str opc_request_id: (optional)
2348
+ The request ID for tracing from the system
2349
+
2350
+ :param str compartment_id: (optional)
2351
+ The OCID for the compartment.
2352
+
2353
+ :param str parent_resource_id: (optional)
2354
+ The `OCID`__ of the Email Domain to which this Email Return Path belongs.
2355
+
2356
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
2357
+
2358
+ :param str id: (optional)
2359
+ A filter to only return resources that match the given id exactly.
2360
+
2361
+ :param str name: (optional)
2362
+ A filter to only return resources that match the given name exactly.
2363
+
2364
+ :param int limit: (optional)
2365
+ For list pagination. The maximum number of results per page, or items to return in a
2366
+ paginated \"List\" call. `1` is the minimum, `1000` is the maximum. For important details about
2367
+ how pagination works, see `List Pagination`__.
2368
+
2369
+ __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
2370
+
2371
+ :param str page: (optional)
2372
+ For list pagination. The value of the opc-next-page response header from the previous \"List\" call.
2373
+ For important details about how pagination works,
2374
+ see `List Pagination`__.
2375
+
2376
+ __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
2377
+
2378
+ :param str sort_order: (optional)
2379
+ The sort order to use, either ascending or descending order.
2380
+
2381
+ Allowed values are: "ASC", "DESC"
2382
+
2383
+ :param str lifecycle_state: (optional)
2384
+ Filter returned list by specified lifecycle state. This parameter is case-insensitive.
2385
+
2386
+ Allowed values are: "ACTIVE", "CREATING", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION", "UPDATING"
2387
+
2388
+ :param str sort_by: (optional)
2389
+ Specifies the attribute with which to sort the return paths.
2390
+
2391
+ Default: `TIMECREATED`
2392
+
2393
+ * **TIMECREATED:** Sorts by timeCreated.
2394
+ * **NAME:** Sorts by name.
2395
+ * **ID:** Sorts by id.
2396
+
2397
+ Allowed values are: "TIMECREATED", "ID", "NAME"
2398
+
2399
+ :param obj retry_strategy: (optional)
2400
+ A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
2401
+
2402
+ This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
2403
+ The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
2404
+
2405
+ To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
2406
+
2407
+ :param bool allow_control_chars: (optional)
2408
+ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
2409
+ By default, the response will not allow control characters in strings
2410
+
2411
+ :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.email.models.EmailReturnPathCollection`
2412
+ :rtype: :class:`~oci.response.Response`
2413
+
2414
+ :example:
2415
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_email_return_paths.py.html>`__ to see an example of how to use list_email_return_paths API.
2416
+ """
2417
+ # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2418
+ required_arguments = []
2419
+ resource_path = "/emailReturnPaths"
2420
+ method = "GET"
2421
+ operation_name = "list_email_return_paths"
2422
+ api_reference_link = "https://docs.oracle.com/iaas/api/#/en/emaildelivery/20170907/EmailReturnPath/ListEmailReturnPaths"
2423
+
2424
+ # Don't accept unknown kwargs
2425
+ expected_kwargs = [
2426
+ "allow_control_chars",
2427
+ "retry_strategy",
2428
+ "opc_request_id",
2429
+ "compartment_id",
2430
+ "parent_resource_id",
2431
+ "id",
2432
+ "name",
2433
+ "limit",
2434
+ "page",
2435
+ "sort_order",
2436
+ "lifecycle_state",
2437
+ "sort_by"
2438
+ ]
2439
+ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
2440
+ if extra_kwargs:
2441
+ raise ValueError(
2442
+ f"list_email_return_paths got unknown kwargs: {extra_kwargs!r}")
2443
+
2444
+ if 'sort_order' in kwargs:
2445
+ sort_order_allowed_values = ["ASC", "DESC"]
2446
+ if kwargs['sort_order'] not in sort_order_allowed_values:
2447
+ raise ValueError(
2448
+ f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }"
2449
+ )
2450
+
2451
+ if 'lifecycle_state' in kwargs:
2452
+ lifecycle_state_allowed_values = ["ACTIVE", "CREATING", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION", "UPDATING"]
2453
+ if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values:
2454
+ raise ValueError(
2455
+ f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }"
2456
+ )
2457
+
2458
+ if 'sort_by' in kwargs:
2459
+ sort_by_allowed_values = ["TIMECREATED", "ID", "NAME"]
2460
+ if kwargs['sort_by'] not in sort_by_allowed_values:
2461
+ raise ValueError(
2462
+ f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }"
2463
+ )
2464
+
2465
+ query_params = {
2466
+ "compartmentId": kwargs.get("compartment_id", missing),
2467
+ "parentResourceId": kwargs.get("parent_resource_id", missing),
2468
+ "id": kwargs.get("id", missing),
2469
+ "name": kwargs.get("name", missing),
2470
+ "limit": kwargs.get("limit", missing),
2471
+ "page": kwargs.get("page", missing),
2472
+ "sortOrder": kwargs.get("sort_order", missing),
2473
+ "lifecycleState": kwargs.get("lifecycle_state", missing),
2474
+ "sortBy": kwargs.get("sort_by", missing)
2475
+ }
2476
+ query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None}
2477
+
2478
+ header_params = {
2479
+ "accept": "application/json",
2480
+ "content-type": "application/json",
2481
+ "opc-request-id": kwargs.get("opc_request_id", missing)
2482
+ }
2483
+ header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
2484
+
2485
+ retry_strategy = self.base_client.get_preferred_retry_strategy(
2486
+ operation_retry_strategy=kwargs.get('retry_strategy'),
2487
+ client_retry_strategy=self.retry_strategy
2488
+ )
2489
+
2490
+ if retry_strategy:
2491
+ if not isinstance(retry_strategy, retry.NoneRetryStrategy):
2492
+ self.base_client.add_opc_client_retries_header(header_params)
2493
+ retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
2494
+ return retry_strategy.make_retrying_call(
2495
+ self.base_client.call_api,
2496
+ resource_path=resource_path,
2497
+ method=method,
2498
+ query_params=query_params,
2499
+ header_params=header_params,
2500
+ response_type="EmailReturnPathCollection",
2501
+ allow_control_chars=kwargs.get('allow_control_chars'),
2502
+ operation_name=operation_name,
2503
+ api_reference_link=api_reference_link,
2504
+ required_arguments=required_arguments)
2505
+ else:
2506
+ return self.base_client.call_api(
2507
+ resource_path=resource_path,
2508
+ method=method,
2509
+ query_params=query_params,
2510
+ header_params=header_params,
2511
+ response_type="EmailReturnPathCollection",
2512
+ allow_control_chars=kwargs.get('allow_control_chars'),
2513
+ operation_name=operation_name,
2514
+ api_reference_link=api_reference_link,
2515
+ required_arguments=required_arguments)
2516
+
2045
2517
  def list_senders(self, compartment_id, **kwargs):
2046
2518
  """
2047
2519
  Gets a collection of approved sender email addresses and sender IDs.
@@ -2056,7 +2528,7 @@ class EmailClient(object):
2056
2528
  :param str lifecycle_state: (optional)
2057
2529
  The current state of a sender.
2058
2530
 
2059
- Allowed values are: "CREATING", "ACTIVE", "DELETING", "DELETED"
2531
+ Allowed values are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "INACTIVE", "FAILED", "DELETING", "DELETED"
2060
2532
 
2061
2533
  :param str domain: (optional)
2062
2534
  A filter to only return resources that match the given domain exactly.
@@ -2107,7 +2579,7 @@ class EmailClient(object):
2107
2579
  :rtype: :class:`~oci.response.Response`
2108
2580
 
2109
2581
  :example:
2110
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_senders.py.html>`__ to see an example of how to use list_senders API.
2582
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_senders.py.html>`__ to see an example of how to use list_senders API.
2111
2583
  """
2112
2584
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2113
2585
  required_arguments = ['compartmentId']
@@ -2135,7 +2607,7 @@ class EmailClient(object):
2135
2607
  f"list_senders got unknown kwargs: {extra_kwargs!r}")
2136
2608
 
2137
2609
  if 'lifecycle_state' in kwargs:
2138
- lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED"]
2610
+ lifecycle_state_allowed_values = ["CREATING", "ACTIVE", "NEEDS_ATTENTION", "INACTIVE", "FAILED", "DELETING", "DELETED"]
2139
2611
  if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values:
2140
2612
  raise ValueError(
2141
2613
  f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }"
@@ -2289,7 +2761,7 @@ class EmailClient(object):
2289
2761
  :rtype: :class:`~oci.response.Response`
2290
2762
 
2291
2763
  :example:
2292
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_suppressions.py.html>`__ to see an example of how to use list_suppressions API.
2764
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_suppressions.py.html>`__ to see an example of how to use list_suppressions API.
2293
2765
  """
2294
2766
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2295
2767
  required_arguments = ['compartmentId']
@@ -2422,7 +2894,7 @@ class EmailClient(object):
2422
2894
  :rtype: :class:`~oci.response.Response`
2423
2895
 
2424
2896
  :example:
2425
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_work_request_errors.py.html>`__ to see an example of how to use list_work_request_errors API.
2897
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_work_request_errors.py.html>`__ to see an example of how to use list_work_request_errors API.
2426
2898
  """
2427
2899
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2428
2900
  required_arguments = ['workRequestId']
@@ -2542,7 +3014,7 @@ class EmailClient(object):
2542
3014
  :rtype: :class:`~oci.response.Response`
2543
3015
 
2544
3016
  :example:
2545
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_work_request_logs.py.html>`__ to see an example of how to use list_work_request_logs API.
3017
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_work_request_logs.py.html>`__ to see an example of how to use list_work_request_logs API.
2546
3018
  """
2547
3019
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2548
3020
  required_arguments = ['workRequestId']
@@ -2665,7 +3137,7 @@ class EmailClient(object):
2665
3137
  :rtype: :class:`~oci.response.Response`
2666
3138
 
2667
3139
  :example:
2668
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/list_work_requests.py.html>`__ to see an example of how to use list_work_requests API.
3140
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/list_work_requests.py.html>`__ to see an example of how to use list_work_requests API.
2669
3141
  """
2670
3142
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2671
3143
  required_arguments = ['compartmentId']
@@ -2772,7 +3244,7 @@ class EmailClient(object):
2772
3244
  :rtype: :class:`~oci.response.Response`
2773
3245
 
2774
3246
  :example:
2775
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/update_dkim.py.html>`__ to see an example of how to use update_dkim API.
3247
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/update_dkim.py.html>`__ to see an example of how to use update_dkim API.
2776
3248
  """
2777
3249
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2778
3250
  required_arguments = ['dkimId']
@@ -2880,7 +3352,7 @@ class EmailClient(object):
2880
3352
  :rtype: :class:`~oci.response.Response`
2881
3353
 
2882
3354
  :example:
2883
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/update_email_domain.py.html>`__ to see an example of how to use update_email_domain API.
3355
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/update_email_domain.py.html>`__ to see an example of how to use update_email_domain API.
2884
3356
  """
2885
3357
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2886
3358
  required_arguments = ['emailDomainId']
@@ -2951,6 +3423,114 @@ class EmailClient(object):
2951
3423
  api_reference_link=api_reference_link,
2952
3424
  required_arguments=required_arguments)
2953
3425
 
3426
+ def update_email_return_path(self, email_return_path_id, update_email_return_path_details, **kwargs):
3427
+ """
3428
+ Modifies an email return path.
3429
+
3430
+
3431
+ :param str email_return_path_id: (required)
3432
+ The `OCID`__ of this email return path.
3433
+
3434
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
3435
+
3436
+ :param oci.email.models.UpdateEmailReturnPathDetails update_email_return_path_details: (required)
3437
+ The new email return path attributes to apply.
3438
+
3439
+ :param str if_match: (optional)
3440
+ Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`
3441
+ parameter to the value of the etag from a previous get, create, or update response for that resource. The resource
3442
+ will be updated or deleted only if the etag you provide matches the resource's current etag value.
3443
+
3444
+ :param str opc_request_id: (optional)
3445
+ The request ID for tracing from the system
3446
+
3447
+ :param obj retry_strategy: (optional)
3448
+ A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
3449
+
3450
+ This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
3451
+ The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
3452
+
3453
+ To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
3454
+
3455
+ :param bool allow_control_chars: (optional)
3456
+ allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
3457
+ By default, the response will not allow control characters in strings
3458
+
3459
+ :return: A :class:`~oci.response.Response` object with data of type None
3460
+ :rtype: :class:`~oci.response.Response`
3461
+
3462
+ :example:
3463
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/update_email_return_path.py.html>`__ to see an example of how to use update_email_return_path API.
3464
+ """
3465
+ # Required path and query arguments. These are in camelCase to replace values in service endpoints.
3466
+ required_arguments = ['emailReturnPathId']
3467
+ resource_path = "/emailReturnPaths/{emailReturnPathId}"
3468
+ method = "PUT"
3469
+ operation_name = "update_email_return_path"
3470
+ api_reference_link = "https://docs.oracle.com/iaas/api/#/en/emaildelivery/20170907/EmailReturnPath/UpdateEmailReturnPath"
3471
+
3472
+ # Don't accept unknown kwargs
3473
+ expected_kwargs = [
3474
+ "allow_control_chars",
3475
+ "retry_strategy",
3476
+ "if_match",
3477
+ "opc_request_id"
3478
+ ]
3479
+ extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
3480
+ if extra_kwargs:
3481
+ raise ValueError(
3482
+ f"update_email_return_path got unknown kwargs: {extra_kwargs!r}")
3483
+
3484
+ path_params = {
3485
+ "emailReturnPathId": email_return_path_id
3486
+ }
3487
+
3488
+ path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
3489
+
3490
+ for (k, v) in six.iteritems(path_params):
3491
+ if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
3492
+ raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
3493
+
3494
+ header_params = {
3495
+ "accept": "application/json",
3496
+ "content-type": "application/json",
3497
+ "if-match": kwargs.get("if_match", missing),
3498
+ "opc-request-id": kwargs.get("opc_request_id", missing)
3499
+ }
3500
+ header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
3501
+
3502
+ retry_strategy = self.base_client.get_preferred_retry_strategy(
3503
+ operation_retry_strategy=kwargs.get('retry_strategy'),
3504
+ client_retry_strategy=self.retry_strategy
3505
+ )
3506
+
3507
+ if retry_strategy:
3508
+ if not isinstance(retry_strategy, retry.NoneRetryStrategy):
3509
+ self.base_client.add_opc_client_retries_header(header_params)
3510
+ retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
3511
+ return retry_strategy.make_retrying_call(
3512
+ self.base_client.call_api,
3513
+ resource_path=resource_path,
3514
+ method=method,
3515
+ path_params=path_params,
3516
+ header_params=header_params,
3517
+ body=update_email_return_path_details,
3518
+ allow_control_chars=kwargs.get('allow_control_chars'),
3519
+ operation_name=operation_name,
3520
+ api_reference_link=api_reference_link,
3521
+ required_arguments=required_arguments)
3522
+ else:
3523
+ return self.base_client.call_api(
3524
+ resource_path=resource_path,
3525
+ method=method,
3526
+ path_params=path_params,
3527
+ header_params=header_params,
3528
+ body=update_email_return_path_details,
3529
+ allow_control_chars=kwargs.get('allow_control_chars'),
3530
+ operation_name=operation_name,
3531
+ api_reference_link=api_reference_link,
3532
+ required_arguments=required_arguments)
3533
+
2954
3534
  def update_sender(self, sender_id, update_sender_details, **kwargs):
2955
3535
  """
2956
3536
  Replaces the set of tags for a sender with the tags provided. If either freeform
@@ -2991,7 +3571,7 @@ class EmailClient(object):
2991
3571
  :rtype: :class:`~oci.response.Response`
2992
3572
 
2993
3573
  :example:
2994
- Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.2/email/update_sender.py.html>`__ to see an example of how to use update_sender API.
3574
+ Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.126.3/email/update_sender.py.html>`__ to see an example of how to use update_sender API.
2995
3575
  """
2996
3576
  # Required path and query arguments. These are in camelCase to replace values in service endpoints.
2997
3577
  required_arguments = ['senderId']