maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/void_invoice_event_data.rb

@@ -87,9 +87,8 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      credit_note_attributes = hash.key?('credit_note_attributes') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes), hash['credit_note_attributes']
-      ) : nil
+      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
+        hash['credit_note_attributes']
       memo = hash.key?('memo') ? hash['memo'] : nil
       applied_amount =
         hash.key?('applied_amount') ? hash['applied_amount'] : nil
@@ -122,8 +121,9 @@ module AdvancedBilling
     def self.validate(value)
       if value.instance_of? self
         return (
-          UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes)
-                         .validate(value.credit_note_attributes) and
+          APIHelper.valid_type?(value.credit_note_attributes,
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true) and
             APIHelper.valid_type?(value.memo,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.applied_amount,
@@ -140,8 +140,9 @@ module AdvancedBilling
       return false unless value.instance_of? Hash
 
       (
-        UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes)
-                       .validate(value['credit_note_attributes']) and
+        APIHelper.valid_type?(value['credit_note_attributes'],
+                              ->(val) { CreditNote.validate(val) },
+                              is_model_hash: true) and
           APIHelper.valid_type?(value['memo'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['applied_amount'],

data/lib/advanced_billing/models/void_remainder_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # VoidRemainderEvent Model.
+  class VoidRemainderEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `void_remainder` event
+    # @return [VoidRemainderEventData]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::VOID_REMAINDER,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::VOID_REMAINDER
+      event_data = VoidRemainderEventData.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      VoidRemainderEvent.new(id,
+                             timestamp,
+                             invoice,
+                             event_type,
+                             event_data,
+                             hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoidRemainderEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { VoidRemainderEventData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { VoidRemainderEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/void_remainder_event_data.rb

@@ -98,7 +98,8 @@ module AdvancedBilling
       if value.instance_of? self
         return (
           APIHelper.valid_type?(value.credit_note_attributes,
-                                ->(val) { CreditNote.validate(val) }) and
+                                ->(val) { CreditNote.validate(val) },
+                                is_model_hash: true) and
             APIHelper.valid_type?(value.memo,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.applied_amount,
@@ -112,7 +113,8 @@ module AdvancedBilling
 
       (
         APIHelper.valid_type?(value['credit_note_attributes'],
-                              ->(val) { CreditNote.validate(val) }) and
+                              ->(val) { CreditNote.validate(val) },
+                              is_model_hash: true) and
           APIHelper.valid_type?(value['memo'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['applied_amount'],

data/lib/advanced_billing/utilities/union_type_lookup.rb

@@ -82,6 +82,75 @@ module AdvancedBilling
           ]
         ),
 
+        :InvoiceEvent => AnyOf.new(
+          [
+            LeafType.new(ApplyCreditNoteEvent, UnionTypeContext.new(
+              discriminator_value: 'apply_credit_note',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(ApplyDebitNoteEvent, UnionTypeContext.new(
+              discriminator_value: 'apply_debit_note',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(ApplyPaymentEvent, UnionTypeContext.new(
+              discriminator_value: 'apply_payment',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(BackportInvoiceEvent, UnionTypeContext.new(
+              discriminator_value: 'backport_invoice',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(ChangeChargebackStatusEvent, UnionTypeContext.new(
+              discriminator_value: 'change_chargeback_status',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(ChangeInvoiceCollectionMethodEvent, UnionTypeContext.new(
+              discriminator_value: 'change_invoice_collection_method',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(ChangeInvoiceStatusEvent, UnionTypeContext.new(
+              discriminator_value: 'change_invoice_status',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(CreateCreditNoteEvent, UnionTypeContext.new(
+              discriminator_value: 'create_credit_note',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(CreateDebitNoteEvent, UnionTypeContext.new(
+              discriminator_value: 'create_debit_note',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(FailedPaymentEvent, UnionTypeContext.new(
+              discriminator_value: 'failed_payment',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(IssueInvoiceEvent, UnionTypeContext.new(
+              discriminator_value: 'issue_invoice',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(RefundInvoiceEvent, UnionTypeContext.new(
+              discriminator_value: 'refund_invoice',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(RemovePaymentEvent, UnionTypeContext.new(
+              discriminator_value: 'remove_payment',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(VoidInvoiceEvent, UnionTypeContext.new(
+              discriminator_value: 'void_invoice',
+              discriminator: 'event_type'
+            )),
+            LeafType.new(VoidRemainderEvent, UnionTypeContext.new(
+              discriminator_value: 'void_remainder',
+              discriminator: 'event_type'
+            ))
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        ),
+
         :AddSubscriptionToAGroupGroup => OneOf.new(
           [
             LeafType.new(GroupSettings),
@@ -112,16 +181,6 @@ module AdvancedBilling
           )
         ),
 
-        :AllocationPayment => OneOf.new(
-          [
-            LeafType.new(PaymentForAllocation)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :AllocationPreviewItemQuantity => OneOf.new(
           [
             LeafType.new(Integer),
@@ -177,16 +236,6 @@ module AdvancedBilling
           )
         ),
 
-        :ComponentPricingScheme => OneOf.new(
-          [
-            LeafType.new(PricingScheme)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :ComponentAllocationChangeAllocatedQuantity => OneOf.new(
           [
             LeafType.new(Integer),
@@ -197,16 +246,6 @@ module AdvancedBilling
           )
         ),
 
-        :ComponentPricePointIntervalUnit => OneOf.new(
-          [
-            LeafType.new(IntervalUnit)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :ComponentPricePointAssignmentPricePoint => OneOf.new(
           [
             LeafType.new(String),
@@ -217,15 +256,6 @@ module AdvancedBilling
           )
         ),
 
-        :CouponCompoundingStrategy => AnyOf.new(
-          [
-            LeafType.new(CompoundingStrategy)
-          ],
-          UnionTypeContext.new(
-            is_optional: true
-          )
-        ),
-
         :CreateAllocationPricePointId => OneOf.new(
           [
             LeafType.new(String),
@@ -502,46 +532,6 @@ module AdvancedBilling
           )
         ),
 
-        :CustomerChangePayer => OneOf.new(
-          [
-            LeafType.new(CustomerPayerChange)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :CustomerChangeShippingAddress => OneOf.new(
-          [
-            LeafType.new(AddressChange)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :CustomerChangeBillingAddress => OneOf.new(
-          [
-            LeafType.new(AddressChange)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :CustomerChangeCustomFields => OneOf.new(
-          [
-            LeafType.new(CustomerCustomFieldsChange)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :CustomerErrorResponseErrors => OneOf.new(
           [
             LeafType.new(CustomerError),
@@ -598,46 +588,6 @@ module AdvancedBilling
           )
         ),
 
-        :InvoiceEventEventData => AnyOf.new(
-          [
-            LeafType.new(ApplyCreditNoteEventData),
-            LeafType.new(ApplyDebitNoteEventData),
-            LeafType.new(ApplyPaymentEventData),
-            LeafType.new(ChangeInvoiceCollectionMethodEventData),
-            LeafType.new(IssueInvoiceEventData),
-            LeafType.new(RefundInvoiceEventData),
-            LeafType.new(RemovePaymentEventData),
-            LeafType.new(VoidInvoiceEventData),
-            LeafType.new(VoidRemainderEventData)
-          ],
-          UnionTypeContext.new(
-            is_optional: true
-          )
-        ),
-
-        :InvoiceEventDataPaymentMethod => AnyOf.new(
-          [
-            LeafType.new(PaymentMethodApplePay),
-            LeafType.new(PaymentMethodBankAccount),
-            LeafType.new(PaymentMethodCreditCard),
-            LeafType.new(PaymentMethodExternal),
-            LeafType.new(PaymentMethodPaypal)
-          ],
-          UnionTypeContext.new(
-            is_optional: true
-          )
-        ),
-
-        :InvoiceLineItemComponentCostData2 => OneOf.new(
-          [
-            LeafType.new(InvoiceLineItemComponentCostData)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :IssueServiceCreditAmount => OneOf.new(
           [
             LeafType.new(Float),
@@ -740,26 +690,6 @@ module AdvancedBilling
           ]
         ),
 
-        :ProductExpirationIntervalUnit => OneOf.new(
-          [
-            LeafType.new(ExtendedIntervalUnit)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :ProductTrialIntervalUnit => OneOf.new(
-          [
-            LeafType.new(IntervalUnit)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :QuantityBasedComponentUnitPrice => OneOf.new(
           [
             LeafType.new(String),
@@ -780,28 +710,6 @@ module AdvancedBilling
           )
         ),
 
-        :RecordPaymentResponsePrepayment => OneOf.new(
-          [
-            LeafType.new(InvoicePrePayment)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :RefundSegmentUids => OneOf.new(
-          [
-            LeafType.new(String, UnionTypeContext.new(
-              is_array: true
-            )),
-            LeafType.new(String)
-          ],
-          UnionTypeContext.new(
-            is_optional: true
-          )
-        ),
-
         :RefundConsolidatedInvoiceSegmentUids => OneOf.new(
           [
             LeafType.new(String, UnionTypeContext.new(
@@ -893,16 +801,6 @@ module AdvancedBilling
           )
         ),
 
-        :SubscriptionGroup2 => OneOf.new(
-          [
-            LeafType.new(NestedSubscriptionGroup)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
         :SubscriptionComponentAllocatedQuantity => OneOf.new(
           [
             LeafType.new(Integer),
@@ -913,25 +811,6 @@ module AdvancedBilling
           )
         ),
 
-        :SubscriptionComponentPricingScheme => OneOf.new(
-          [
-            LeafType.new(PricingScheme)
-          ],
-          UnionTypeContext.new(
-            is_optional: true,
-            is_nullable: true
-          )
-        ),
-
-        :SubscriptionComponentPricePointType => OneOf.new(
-          [
-            LeafType.new(PricePointType)
-          ],
-          UnionTypeContext.new(
-            is_optional: true
-          )
-        ),
-
         :SubscriptionCustomPricePriceInCents => OneOf.new(
           [
             LeafType.new(String),
@@ -1134,15 +1013,6 @@ module AdvancedBilling
           UnionTypeContext.new(
             is_optional: true
           )
-        ),
-
-        :VoidInvoiceEventDataCreditNoteAttributes => OneOf.new(
-          [
-            LeafType.new(CreditNote)
-          ],
-          UnionTypeContext.new(
-            is_nullable: true
-          )
         )
       }
     end