osdm_sys/models/
fulfillment.rs

1/*
2 * UIC 90918-10 - OSDM
3 *
4 * Specifications for the OSDM API standard. The OSDM specification supports two modes of operation: Retailer Mode and Distributor Mode. The API works identically in both modes, except that in distributor mode the API also returns fare information.  The following resources are key to get started:    -  [Processes](https://osdm.io/spec/processes/)   -  [Models](https://osdm.io/spec/models/)   -  [Getting started](https://osdm.io/spec/getting-started/) 
5 *
6 * The version of the OpenAPI document: 3.7.0
7 * Contact: osdm@uic.org
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// Fulfillment : A fulfillment is a document (or part of a document in distributor mode) that - allows the passenger to prove its travel right - provides easier access to trains and stations - allows an exchange for other services (voucher) A fulfillment refers to services of one or multiple offer parts or a fare (distributor mode). 
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
17pub struct Fulfillment {
18    #[serde(rename = "id")]
19    pub id: String,
20    #[serde(rename = "status")]
21    pub status: models::FulfillmentStatus,
22    /// the id of the booking the fulfillment is part of 
23    #[serde(rename = "bookingRef")]
24    pub booking_ref: String,
25    /// A human-readable description of the fulfillment. 
26    #[serde(rename = "summary", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
27    pub summary: Option<Option<String>>,
28    #[serde(rename = "createdOn")]
29    pub created_on: String,
30    /// Ticket Control Number. 
31    #[serde(rename = "controlNumber", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
32    pub control_number: Option<Option<String>>,
33    /// reference to all booking parts that contributed to this fulfillment. If the fulfillment is made based on booking parts these references must be provided.
34    #[serde(rename = "bookingParts", skip_serializing_if = "Option::is_none")]
35    pub booking_parts: Option<Vec<models::BookingPartReference>>,
36    #[serde(rename = "availableUsage", skip_serializing_if = "Option::is_none")]
37    pub available_usage: Option<Box<models::FulfillmentUsage>>,
38    /// Identifies a company. For rail, a RICS company code or compatible ERA company code are used.  E.g.: 'urn:uic:rics:1185:000011' 
39    #[serde(rename = "issuer", skip_serializing_if = "Option::is_none")]
40    pub issuer: Option<String>,
41    /// Final document created for fulfillment. 
42    #[serde(rename = "fulfillmentDocuments", skip_serializing_if = "Option::is_none")]
43    pub fulfillment_documents: Option<Vec<models::FulfillmentDocument>>,
44    /// the issuing language (ISO-639-1 language code).
45    #[serde(rename = "issuingLanguage", skip_serializing_if = "Option::is_none")]
46    pub issuing_language: Option<String>,
47    /// Fulfillment items to be integrated into tickets (distributor mode). 
48    #[serde(rename = "fulfillmentParts", skip_serializing_if = "Option::is_none")]
49    pub fulfillment_parts: Option<Vec<models::FulfillmentPart>>,
50    /// Indicates whether the fulfillment has all documents or parts generated (if any needed) or they are still pending generation. 
51    #[serde(rename = "contentComplete", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
52    pub content_complete: Option<Option<bool>>,
53    #[serde(rename = "tripCoverage", skip_serializing_if = "Option::is_none")]
54    pub trip_coverage: Option<Box<models::TripCoverage>>,
55    #[serde(rename = "inboundTripCoverage", skip_serializing_if = "Option::is_none")]
56    pub inbound_trip_coverage: Option<Box<models::TripCoverage>>,
57    #[serde(rename = "continuousServiceUsage", skip_serializing_if = "Option::is_none")]
58    pub continuous_service_usage: Option<Box<models::ContinuousServiceUsage>>,
59    ///  Java Property Name: 'links' 
60    #[serde(rename = "_links", skip_serializing_if = "Option::is_none")]
61    pub _links: Option<Vec<models::Link>>,
62}
63
64impl Fulfillment {
65    /// A fulfillment is a document (or part of a document in distributor mode) that - allows the passenger to prove its travel right - provides easier access to trains and stations - allows an exchange for other services (voucher) A fulfillment refers to services of one or multiple offer parts or a fare (distributor mode). 
66    pub fn new(id: String, status: models::FulfillmentStatus, booking_ref: String, created_on: String) -> Fulfillment {
67        Fulfillment {
68            id,
69            status,
70            booking_ref,
71            summary: None,
72            created_on,
73            control_number: None,
74            booking_parts: None,
75            available_usage: None,
76            issuer: None,
77            fulfillment_documents: None,
78            issuing_language: None,
79            fulfillment_parts: None,
80            content_complete: None,
81            trip_coverage: None,
82            inbound_trip_coverage: None,
83            continuous_service_usage: None,
84            _links: None,
85        }
86    }
87}
88
osdm_sys/models/fulfillment.rs

osdm_sys/models/
fulfillment.rs
