Class: CyberSourceMergedSpec::CreateSubscriptionRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/create_subscription_request.rb

Overview

CreateSubscriptionRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(client_reference_information: SKIP, processing_information: SKIP, plan_information: SKIP, subscription_information: SKIP, payment_information: SKIP, order_information: SKIP, additional_properties: nil) ⇒ CreateSubscriptionRequest

Returns a new instance of CreateSubscriptionRequest.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 65

def initialize(client_reference_information: SKIP,
               processing_information: SKIP, plan_information: SKIP,
               subscription_information: SKIP, payment_information: SKIP,
               order_information: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  unless client_reference_information == SKIP
    @client_reference_information =
      client_reference_information
  end
  @processing_information = processing_information unless processing_information == SKIP
  @plan_information = plan_information unless plan_information == SKIP
  @subscription_information = subscription_information unless subscription_information == SKIP
  @payment_information = payment_information unless payment_information == SKIP
  @order_information = order_information unless order_information == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_reference_informationClientReferenceInformation3

TODO: Write general description for this method



14
15
16
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 14

def client_reference_information
  @client_reference_information
end

#order_informationOrderInformation52

TODO: Write general description for this method

Returns:



34
35
36
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 34

def order_information
  @order_information
end

#payment_informationPaymentInformation39

TODO: Write general description for this method



30
31
32
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 30

def payment_information
  @payment_information
end

#plan_informationPlanInformation8

TODO: Write general description for this method

Returns:



22
23
24
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 22

def plan_information
  @plan_information
end

#processing_informationProcessingInformation65

TODO: Write general description for this method



18
19
20
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 18

def processing_information
  @processing_information
end

#subscription_informationSubscriptionInformation

TODO: Write general description for this method



26
27
28
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 26

def subscription_information
  @subscription_information
end

Class Method Details

.from_element(root) ⇒ Object



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 121

def self.from_element(root)
  client_reference_information = XmlUtilities.from_element(
    root, 'ClientReferenceInformation3',
    ClientReferenceInformation3
  )
  processing_information = XmlUtilities.from_element(
    root, 'ProcessingInformation65', ProcessingInformation65
  )
  plan_information = XmlUtilities.from_element(root, 'PlanInformation8',
                                               PlanInformation8)
  subscription_information = XmlUtilities.from_element(
    root, 'SubscriptionInformation', SubscriptionInformation
  )
  payment_information = XmlUtilities.from_element(root,
                                                  'PaymentInformation39',
                                                  PaymentInformation39)
  order_information = XmlUtilities.from_element(root, 'OrderInformation52',
                                                OrderInformation52)

  new(client_reference_information: client_reference_information,
      processing_information: processing_information,
      plan_information: plan_information,
      subscription_information: subscription_information,
      payment_information: payment_information,
      order_information: order_information,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 85

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  if hash['clientReferenceInformation']
    client_reference_information = ClientReferenceInformation3.from_hash(hash['clientReferenceInformation'])
  end
  processing_information = ProcessingInformation65.from_hash(hash['processingInformation']) if
    hash['processingInformation']
  plan_information = PlanInformation8.from_hash(hash['planInformation']) if
    hash['planInformation']
  if hash['subscriptionInformation']
    subscription_information = SubscriptionInformation.from_hash(hash['subscriptionInformation'])
  end
  payment_information = PaymentInformation39.from_hash(hash['paymentInformation']) if
    hash['paymentInformation']
  order_information = OrderInformation52.from_hash(hash['orderInformation']) if
    hash['orderInformation']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  CreateSubscriptionRequest.new(client_reference_information: client_reference_information,
                                processing_information: processing_information,
                                plan_information: plan_information,
                                subscription_information: subscription_information,
                                payment_information: payment_information,
                                order_information: order_information,
                                additional_properties: additional_properties)
end

.namesObject

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_reference_information'] = 'clientReferenceInformation'
  @_hash['processing_information'] = 'processingInformation'
  @_hash['plan_information'] = 'planInformation'
  @_hash['subscription_information'] = 'subscriptionInformation'
  @_hash['payment_information'] = 'paymentInformation'
  @_hash['order_information'] = 'orderInformation'
  @_hash
end

.nullablesObject

An array for nullable fields



61
62
63
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 61

def self.nullables
  []
end

.optionalsObject

An array for optional fields



49
50
51
52
53
54
55
56
57
58
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 49

def self.optionals
  %w[
    client_reference_information
    processing_information
    plan_information
    subscription_information
    payment_information
    order_information
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



181
182
183
184
185
186
187
188
189
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 181

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_reference_information: #{@client_reference_information.inspect},"\
  " processing_information: #{@processing_information.inspect}, plan_information:"\
  " #{@plan_information.inspect}, subscription_information:"\
  " #{@subscription_information.inspect}, payment_information:"\
  " #{@payment_information.inspect}, order_information: #{@order_information.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_sObject

Provides a human-readable string representation of the object.



171
172
173
174
175
176
177
178
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 171

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_reference_information: #{@client_reference_information},"\
  " processing_information: #{@processing_information}, plan_information:"\
  " #{@plan_information}, subscription_information: #{@subscription_information},"\
  " payment_information: #{@payment_information}, order_information: #{@order_information},"\
  " additional_properties: #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/cyber_source_merged_spec/models/create_subscription_request.rb', line 149

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'ClientReferenceInformation3',
                                 client_reference_information)
  XmlUtilities.add_as_subelement(doc, root, 'ProcessingInformation65',
                                 processing_information)
  XmlUtilities.add_as_subelement(doc, root, 'PlanInformation8',
                                 plan_information)
  XmlUtilities.add_as_subelement(doc, root, 'SubscriptionInformation',
                                 subscription_information)
  XmlUtilities.add_as_subelement(doc, root, 'PaymentInformation39',
                                 payment_information)
  XmlUtilities.add_as_subelement(doc, root, 'OrderInformation52',
                                 order_information)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end