Skip to main content

BrandingAsset

Struct BrandingAsset 

Source
pub struct BrandingAsset {
Show 36 fields pub timeout: i32, pub test: bool, pub success: bool, pub error: String, pub response_description: String, pub id: String, pub owner_id: String, pub terminal_id: String, pub terminal_group_id: String, pub merchant_id: String, pub organization_id: String, pub partner_id: String, pub slide_show_id: String, pub media_id: String, pub padded: bool, pub start_date: String, pub end_date: String, pub days_of_week: Option<Vec<i8>>, pub start_time: String, pub end_time: String, pub ordinal: i32, pub enabled: bool, pub preview: bool, pub user_id: String, pub user_name: String, pub thumbnail: String, pub last_modified: String, pub notes: String, pub editable: bool, pub asset_type: String, pub owner_type: String, pub owner_type_caption: String, pub owner_name: String, pub preview_image: String, pub narrative_effective_dates: String, pub narrative_display_period: String,
}
Expand description

Models the priority and display settings for terminal media.

Fields§

§timeout: i32

The request timeout in seconds.

§test: bool

Whether or not to route transaction to the test gateway.

§success: bool

Whether or not the request succeeded.

§error: String

The error, if an error occurred.

§response_description: String

A narrative description of the transaction result.

§id: String

Id used to track a branding asset.

§owner_id: String

The id owner of the tenant who owns the branding asset.

§terminal_id: String

The terminal id if this branding asset is specific to a single terminal.

§terminal_group_id: String

The terminal group id if this branding asset is specific to a terminal group.

§merchant_id: String

The merchant id associated with this branding asset.

§organization_id: String

The organization id associated with this branding asset.

§partner_id: String

The partner id associated with this branding asset.

§slide_show_id: String

The slide show associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

§media_id: String

The media id associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

§padded: bool

Applies standard margins to images displayed on terminals. Usually the best option for logos.

§start_date: String

The start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

§end_date: String

The end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

§days_of_week: Option<Vec<i8>>

An array of days of the week during which a branding asset should be enabled. Days of the week are coded as integers starting with Sunday (0) and ending with Saturday (6).

§start_time: String

The start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

§end_time: String

The end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

§ordinal: i32

The ordinal number marking the position of this asset within the branding stack.

§enabled: bool

Enables the asset for display.

§preview: bool

If true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware. Developers will usually want this to always be false.

§user_id: String

Id of the user who created this branding asset, if applicable.

§user_name: String

Name of the user who created this branding asset, if applicable.

§thumbnail: String

The fully qualified URL of the thumbnail image for this branding asset.

§last_modified: String

The time and date this asset was last modified.

§notes: String

A field for notes related to a branding asset.

§editable: bool

If true, the API credentials used to retrieve the branding asset record can be used to update it.

§asset_type: String

The type of branding asset.

§owner_type: String

The type of user or tenant that owns this asset.

§owner_type_caption: String

A recommended caption for displaying the owner. Takes into account multiple organization types.

§owner_name: String

The name of the tenant or entity that owns the branding asset.

§preview_image: String

The recommended image to be displayed when rendering a preview of this branding asset.

§narrative_effective_dates: String

A compact narrative string explaining the effective date and time rules for a branding asset.

§narrative_display_period: String

A compact narrative string explaining the display period for a branding asset.

Trait Implementations§

Source§

impl Clone for BrandingAsset

Source§

fn clone(&self) -> BrandingAsset

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BrandingAsset

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BrandingAsset

Source§

fn default() -> BrandingAsset

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BrandingAsset

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for BrandingAsset

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,