FXPutPeriod
===========

.. currentmodule:: rateslib.periods

.. autoclass:: FXPutPeriod
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~FXPutPeriod.fx_option_params
      ~FXPutPeriod.index_params
      ~FXPutPeriod.is_indexed
      ~FXPutPeriod.is_non_deliverable
      ~FXPutPeriod.non_deliverable_params
      ~FXPutPeriod.period_params
      ~FXPutPeriod.rate_params
      ~FXPutPeriod.settlement_params

   .. rubric:: Methods Summary

   .. autosummary::

      ~FXPutPeriod.analytic_delta
      ~FXPutPeriod.analytic_greeks
      ~FXPutPeriod.cashflow
      ~FXPutPeriod.cashflows
      ~FXPutPeriod.convert_deliverable
      ~FXPutPeriod.immediate_local_npv
      ~FXPutPeriod.implied_vol
      ~FXPutPeriod.index_up
      ~FXPutPeriod.local_analytic_rate_fixings
      ~FXPutPeriod.local_fixings
      ~FXPutPeriod.local_npv
      ~FXPutPeriod.npv
      ~FXPutPeriod.rate
      ~FXPutPeriod.reference_cashflow
      ~FXPutPeriod.reset_fixings
      ~FXPutPeriod.try_cashflow
      ~FXPutPeriod.try_cashflow_analytic_delta
      ~FXPutPeriod.try_cashflow_analytic_rate_fixings
      ~FXPutPeriod.try_convert_deliverable
      ~FXPutPeriod.try_immediate_analytic_rate_fixings
      ~FXPutPeriod.try_immediate_local_analytic_delta
      ~FXPutPeriod.try_immediate_local_npv
      ~FXPutPeriod.try_index_up
      ~FXPutPeriod.try_local_analytic_delta
      ~FXPutPeriod.try_local_npv
      ~FXPutPeriod.try_rate
      ~FXPutPeriod.try_reference_cashflow
      ~FXPutPeriod.try_reference_cashflow_analytic_delta
      ~FXPutPeriod.try_reference_cashflow_analytic_rate_fixings
      ~FXPutPeriod.try_unindexed_cashflow
      ~FXPutPeriod.try_unindexed_cashflow_analytic_delta
      ~FXPutPeriod.try_unindexed_cashflow_analytic_rate_fixings
      ~FXPutPeriod.try_unindexed_reference_cashflow
      ~FXPutPeriod.try_unindexed_reference_cashflow_analytic_delta
      ~FXPutPeriod.try_unindexed_reference_cashflow_analytic_rate_fixings
      ~FXPutPeriod.unindexed_cashflow
      ~FXPutPeriod.unindexed_reference_cashflow

   .. rubric:: Attributes Documentation

   .. autoattribute:: fx_option_params
   .. autoattribute:: index_params
   .. autoattribute:: is_indexed
   .. autoattribute:: is_non_deliverable
   .. autoattribute:: non_deliverable_params
   .. autoattribute:: period_params
   .. autoattribute:: rate_params
   .. autoattribute:: settlement_params

   .. rubric:: Methods Documentation

   .. automethod:: analytic_delta
   .. automethod:: analytic_greeks
   .. automethod:: cashflow
   .. automethod:: cashflows
   .. automethod:: convert_deliverable
   .. automethod:: immediate_local_npv
   .. automethod:: implied_vol
   .. automethod:: index_up
   .. automethod:: local_analytic_rate_fixings
   .. automethod:: local_fixings
   .. automethod:: local_npv
   .. automethod:: npv
   .. automethod:: rate
   .. automethod:: reference_cashflow
   .. automethod:: reset_fixings
   .. automethod:: try_cashflow
   .. automethod:: try_cashflow_analytic_delta
   .. automethod:: try_cashflow_analytic_rate_fixings
   .. automethod:: try_convert_deliverable
   .. automethod:: try_immediate_analytic_rate_fixings
   .. automethod:: try_immediate_local_analytic_delta
   .. automethod:: try_immediate_local_npv
   .. automethod:: try_index_up
   .. automethod:: try_local_analytic_delta
   .. automethod:: try_local_npv
   .. automethod:: try_rate
   .. automethod:: try_reference_cashflow
   .. automethod:: try_reference_cashflow_analytic_delta
   .. automethod:: try_reference_cashflow_analytic_rate_fixings
   .. automethod:: try_unindexed_cashflow
   .. automethod:: try_unindexed_cashflow_analytic_delta
   .. automethod:: try_unindexed_cashflow_analytic_rate_fixings
   .. automethod:: try_unindexed_reference_cashflow
   .. automethod:: try_unindexed_reference_cashflow_analytic_delta
   .. automethod:: try_unindexed_reference_cashflow_analytic_rate_fixings
   .. automethod:: unindexed_cashflow
   .. automethod:: unindexed_reference_cashflow