Struct carapax::types::InvoiceParameters
source · pub struct InvoiceParameters {Show 14 fields
pub is_flexible: Option<bool>,
pub max_tip_amount: Option<i64>,
pub need_email: Option<bool>,
pub need_name: Option<bool>,
pub need_phone_number: Option<bool>,
pub need_shipping_address: Option<bool>,
pub photo_height: Option<i64>,
pub photo_size: Option<i64>,
pub photo_url: Option<String>,
pub photo_width: Option<i64>,
pub provider_data: Option<String>,
pub send_phone_number_to_provider: Option<bool>,
pub send_email_to_provider: Option<bool>,
pub suggested_tip_amounts: Option<Vec<i64>>,
}
Expand description
Represents an invoice parameters used in CreateInvoiceLink
and SendInvoice
.
Fields§
§is_flexible: Option<bool>
Indicates whether the final price depends on the shipping method.
max_tip_amount: Option<i64>
The maximum accepted amount for tips in the smallest units of the currency.
For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
Defaults to 0.
need_email: Option<bool>
Indicates whether the user’s email address is required to complete the order.
need_name: Option<bool>
Indicates whether the user’s full name is required to complete the order.
need_phone_number: Option<bool>
Indicates whether the user’s phone number is required to complete the order.
need_shipping_address: Option<bool>
Indicates whether the user’s shipping address is required to complete the order.
photo_height: Option<i64>
Photo height.
photo_size: Option<i64>
Photo size in bytes.
photo_url: Option<String>
URL of the product photo for the invoice.
Can be a photo of the goods or a marketing image for a service.
photo_width: Option<i64>
Photo width.
provider_data: Option<String>
Data about the invoice, which will be shared with the payment provider.
A detailed description of required fields should be provided by the payment provider.
send_phone_number_to_provider: Option<bool>
Indicates whether the user’s phone number should be sent to the provider.
send_email_to_provider: Option<bool>
Indicates whether the user’s email address should be sent to the provider.
suggested_tip_amounts: Option<Vec<i64>>
An array of suggested amounts of tips in the smallest units of the currency.
At most 4 suggested tip amounts can be specified.
The suggested tip amounts must be positive,
passed in a strictly increased order and must not exceed max_tip_amount
.
Implementations§
source§impl InvoiceParameters
impl InvoiceParameters
sourcepub fn with_flexible(self, value: bool) -> InvoiceParameters
pub fn with_flexible(self, value: bool) -> InvoiceParameters
Sets a new value for an is_flexible
flag.
§Arguments
value
- Indicates whether the final price depends on the shipping method.
sourcepub fn with_max_tip_amount(self, value: i64) -> InvoiceParameters
pub fn with_max_tip_amount(self, value: i64) -> InvoiceParameters
Sets a new max tip amount.
§Arguments
value
- The maximum accepted amount for tips in the smallest units of the currency.
sourcepub fn with_need_email(self, value: bool) -> InvoiceParameters
pub fn with_need_email(self, value: bool) -> InvoiceParameters
Sets a new value for a need_email
flag.
§Arguments
value
- Indicates whether the user’s email address is required to complete the order.
sourcepub fn with_need_name(self, value: bool) -> InvoiceParameters
pub fn with_need_name(self, value: bool) -> InvoiceParameters
Sets a new value for a need_name
flag.
§Arguments
value
- Indicates whether the user’s full name is required to complete the order.
sourcepub fn with_need_phone_number(self, value: bool) -> InvoiceParameters
pub fn with_need_phone_number(self, value: bool) -> InvoiceParameters
Sets a new value for a need_phone_number
flag.
§Arguments
value
- Indicates whether the user’s phone number is required to complete the order.
sourcepub fn with_need_shipping_address(self, value: bool) -> InvoiceParameters
pub fn with_need_shipping_address(self, value: bool) -> InvoiceParameters
Sets a new value for a need_shipping_address
flag.
§Arguments
value
- Indicates whether the user’s shipping address is required to complete the order.
sourcepub fn with_photo_height(self, value: i64) -> InvoiceParameters
pub fn with_photo_height(self, value: i64) -> InvoiceParameters
sourcepub fn with_photo_size(self, value: i64) -> InvoiceParameters
pub fn with_photo_size(self, value: i64) -> InvoiceParameters
sourcepub fn with_photo_url<T>(self, value: T) -> InvoiceParameters
pub fn with_photo_url<T>(self, value: T) -> InvoiceParameters
sourcepub fn with_photo_width(self, value: i64) -> InvoiceParameters
pub fn with_photo_width(self, value: i64) -> InvoiceParameters
sourcepub fn with_provider_data<T>(
self,
value: &T
) -> Result<InvoiceParameters, Error>where
T: Serialize,
pub fn with_provider_data<T>(
self,
value: &T
) -> Result<InvoiceParameters, Error>where
T: Serialize,
Sets a new provider data.
§Arguments
value
- Data about the invoice, which will be shared with the payment provider.
sourcepub fn with_send_phone_number_to_provider(
self,
value: bool
) -> InvoiceParameters
pub fn with_send_phone_number_to_provider( self, value: bool ) -> InvoiceParameters
Sets a new value for a send_phone_number_to_provider
flag.
§Arguments
value
- Indicates whether the user’s phone number should be sent to the provider.
sourcepub fn with_send_email_to_provider(self, value: bool) -> InvoiceParameters
pub fn with_send_email_to_provider(self, value: bool) -> InvoiceParameters
Sets a new value for a send_email_to_provider
flag.
§Arguments
value
- Indicates whether the user’s email address should be sent to the provider.
sourcepub fn with_suggested_tip_amounts<T>(self, value: T) -> InvoiceParameterswhere
T: IntoIterator<Item = i64>,
pub fn with_suggested_tip_amounts<T>(self, value: T) -> InvoiceParameterswhere
T: IntoIterator<Item = i64>,
Sets a new list of max tip amounts.
§Arguments
value
- An array of suggested amounts of tips in the smallest units of the currency.
Trait Implementations§
source§impl Clone for InvoiceParameters
impl Clone for InvoiceParameters
source§fn clone(&self) -> InvoiceParameters
fn clone(&self) -> InvoiceParameters
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InvoiceParameters
impl Debug for InvoiceParameters
source§impl Default for InvoiceParameters
impl Default for InvoiceParameters
source§fn default() -> InvoiceParameters
fn default() -> InvoiceParameters
source§impl<'de> Deserialize<'de> for InvoiceParameters
impl<'de> Deserialize<'de> for InvoiceParameters
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<InvoiceParameters, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<InvoiceParameters, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl PartialEq for InvoiceParameters
impl PartialEq for InvoiceParameters
source§fn eq(&self, other: &InvoiceParameters) -> bool
fn eq(&self, other: &InvoiceParameters) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for InvoiceParameters
impl PartialOrd for InvoiceParameters
source§fn partial_cmp(&self, other: &InvoiceParameters) -> Option<Ordering>
fn partial_cmp(&self, other: &InvoiceParameters) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for InvoiceParameters
impl Serialize for InvoiceParameters
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for InvoiceParameters
Auto Trait Implementations§
impl Freeze for InvoiceParameters
impl RefUnwindSafe for InvoiceParameters
impl Send for InvoiceParameters
impl Sync for InvoiceParameters
impl Unpin for InvoiceParameters
impl UnwindSafe for InvoiceParameters
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more