<?php
namespace Chargebee\Actions\Contracts;
    
use Chargebee\Responses\ItemPriceResponse\CreateItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\FindApplicableItemsItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\DeleteItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\UpdateItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\RetrieveItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\FindApplicableItemPricesItemPriceResponse;
use Chargebee\Responses\ItemPriceResponse\ListItemPriceResponse;
use Exception;
use Chargebee\Exceptions\PaymentException;
use Chargebee\Exceptions\OperationFailedException;
use Chargebee\Exceptions\APIError;
use Chargebee\Exceptions\InvalidRequestException;

Interface ItemPriceActionsInterface
{

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#list_applicable_items_for_a_plan-item_price
    *   @param array{
    *     limit?: int,
    *     offset?: string,
    *     sort_by?: array{
    *     asc?: string,
    *     desc?: string,
    *     },
    * } $params Description of the parameters
    *   @param string $id  
    *   @param array<string, string> $headers
    *   @return FindApplicableItemsItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function findApplicableItems(string $id, array $params = [], array $headers = []): FindApplicableItemsItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#retrieve_an_item_price
    *   
    *   @param string $id  
    *   @param array<string, string> $headers
    *   @return RetrieveItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function retrieve(string $id, array $headers = []): RetrieveItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#update_an_item_price
    *   @param array{
    *     tax_detail?: array{
    *     tax_profile_id?: string,
    *     avalara_tax_code?: string,
    *     hsn_code?: string,
    *     avalara_sale_type?: string,
    *     avalara_transaction_type?: int,
    *     avalara_service_type?: int,
    *     taxjar_product_code?: string,
    *     },
    * accounting_detail?: array{
    *     sku?: string,
    *     accounting_code?: string,
    *     accounting_category1?: string,
    *     accounting_category2?: string,
    *     accounting_category3?: string,
    *     accounting_category4?: string,
    *     },
    * tiers?: array<array{
    *     starting_unit?: int,
    *     ending_unit?: int,
    *     price?: int,
    *     starting_unit_in_decimal?: string,
    *     ending_unit_in_decimal?: string,
    *     price_in_decimal?: string,
    *     pricing_type?: string,
    *     package_size?: int,
    *     }>,
    *     tax_providers_fields?: array<array{
    *     provider_name?: string,
    *     field_id?: string,
    *     field_value?: string,
    *     }>,
    *     name?: string,
    *     description?: string,
    *     proration_type?: string,
    *     price_variant_id?: string,
    *     status?: string,
    *     external_name?: string,
    *     usage_accumulation_reset_frequency?: string,
    *     currency_code?: string,
    *     invoice_notes?: string,
    *     is_taxable?: bool,
    *     free_quantity?: int,
    *     free_quantity_in_decimal?: string,
    *     metadata?: mixed,
    *     pricing_model?: string,
    *     price?: int,
    *     price_in_decimal?: string,
    *     period_unit?: string,
    *     period?: int,
    *     trial_period_unit?: string,
    *     trial_period?: int,
    *     shipping_period?: int,
    *     shipping_period_unit?: string,
    *     billing_cycles?: int,
    *     trial_end_action?: string,
    *     show_description_in_invoices?: bool,
    *     show_description_in_quotes?: bool,
    *     } $params Description of the parameters
    *   @param string $id  
    *   @param array<string, string> $headers
    *   @return UpdateItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function update(string $id, array $params, array $headers = []): UpdateItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#delete_an_item_price
    *   
    *   @param string $id  
    *   @param array<string, string> $headers
    *   @return DeleteItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function delete(string $id, array $headers = []): DeleteItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#list_applicable_item_prices_for_a_plan-item_price
    *   @param array{
    *     limit?: int,
    *     offset?: string,
    *     item_id?: string,
    *     sort_by?: array{
    *     asc?: string,
    *     desc?: string,
    *     },
    * } $params Description of the parameters
    *   @param string $id  
    *   @param array<string, string> $headers
    *   @return FindApplicableItemPricesItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function findApplicableItemPrices(string $id, array $params = [], array $headers = []): FindApplicableItemPricesItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#list_item_prices
    *   @param array{
    *     limit?: int,
    *     offset?: string,
    *     id?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * name?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * pricing_model?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * item_id?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * item_family_id?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * item_type?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * currency_code?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * price_variant_id?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     starts_with?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * trial_period?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     lt?: mixed,
    *     lte?: mixed,
    *     gt?: mixed,
    *     gte?: mixed,
    *     between?: mixed,
    *     },
    * trial_period_unit?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * status?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * updated_at?: array{
    *     after?: mixed,
    *     before?: mixed,
    *     on?: mixed,
    *     between?: mixed,
    *     },
    * business_entity_id?: array{
    *     is?: mixed,
    *     is_present?: mixed,
    *     },
    * include_site_level_resources?: array{
    *     is?: mixed,
    *     },
    * period_unit?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * period?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     lt?: mixed,
    *     lte?: mixed,
    *     gt?: mixed,
    *     gte?: mixed,
    *     between?: mixed,
    *     },
    * channel?: array{
    *     is?: mixed,
    *     is_not?: mixed,
    *     in?: mixed,
    *     not_in?: mixed,
    *     },
    * sort_by?: array{
    *     asc?: string,
    *     desc?: string,
    *     },
    * } $params Description of the parameters
    *   
    *   @param array<string, string> $headers
    *   @return ListItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function all(array $params = [], array $headers = []): ListItemPriceResponse;

    /**
    *   @see https://apidocs.chargebee.com/docs/api/item_prices?lang=php#create_an_item_price
    *   @param array{
    *     tax_detail?: array{
    *     tax_profile_id?: string,
    *     avalara_tax_code?: string,
    *     hsn_code?: string,
    *     avalara_sale_type?: string,
    *     avalara_transaction_type?: int,
    *     avalara_service_type?: int,
    *     taxjar_product_code?: string,
    *     },
    * accounting_detail?: array{
    *     sku?: string,
    *     accounting_code?: string,
    *     accounting_category1?: string,
    *     accounting_category2?: string,
    *     accounting_category3?: string,
    *     accounting_category4?: string,
    *     },
    * tiers?: array<array{
    *     starting_unit?: int,
    *     ending_unit?: int,
    *     price?: int,
    *     starting_unit_in_decimal?: string,
    *     ending_unit_in_decimal?: string,
    *     price_in_decimal?: string,
    *     pricing_type?: string,
    *     package_size?: int,
    *     }>,
    *     tax_providers_fields?: array<array{
    *     provider_name?: string,
    *     field_id?: string,
    *     field_value?: string,
    *     }>,
    *     id?: string,
    *     name?: string,
    *     description?: string,
    *     item_id?: string,
    *     invoice_notes?: string,
    *     proration_type?: string,
    *     external_name?: string,
    *     currency_code?: string,
    *     price_variant_id?: string,
    *     is_taxable?: bool,
    *     free_quantity?: int,
    *     free_quantity_in_decimal?: string,
    *     metadata?: mixed,
    *     show_description_in_invoices?: bool,
    *     show_description_in_quotes?: bool,
    *     usage_accumulation_reset_frequency?: string,
    *     business_entity_id?: string,
    *     pricing_model?: string,
    *     price?: int,
    *     price_in_decimal?: string,
    *     period_unit?: string,
    *     period?: int,
    *     trial_period_unit?: string,
    *     trial_period?: int,
    *     shipping_period?: int,
    *     shipping_period_unit?: string,
    *     billing_cycles?: int,
    *     trial_end_action?: string,
    *     } $params Description of the parameters
    *   
    *   @param array<string, string> $headers
    *   @return CreateItemPriceResponse
    *   @throws PaymentException
    *   @throws OperationFailedException
    *   @throws APIError
    *   @throws InvalidRequestException
    *   @throws Exception
    */
    public function create(array $params, array $headers = []): CreateItemPriceResponse;

}
?>