subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/void_invoice_event_data.rb

@@ -0,0 +1,111 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `void_invoice` event
+  class VoidInvoiceEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreditNote]
+    attr_accessor :credit_note_attributes
+
+    # The memo provided during invoice voiding.
+    # @return [String]
+    attr_accessor :memo
+
+    # The amount of the void.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the refund was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # If true, the invoice is an advance invoice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_advance_invoice
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_note_attributes'] = 'credit_note_attributes'
+      @_hash['memo'] = 'memo'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['is_advance_invoice'] = 'is_advance_invoice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_note_attributes
+        memo
+        applied_amount
+        transaction_time
+        is_advance_invoice
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_note_attributes = SKIP, memo = SKIP,
+                   applied_amount = SKIP, transaction_time = SKIP,
+                   is_advance_invoice = SKIP)
+      @credit_note_attributes = credit_note_attributes unless credit_note_attributes == SKIP
+      @memo = memo unless memo == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @is_advance_invoice = is_advance_invoice unless is_advance_invoice == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
+        hash['credit_note_attributes']
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
+      is_advance_invoice =
+        hash.key?('is_advance_invoice') ? hash['is_advance_invoice'] : SKIP
+
+      # Create object from extracted values.
+      VoidInvoiceEventData.new(credit_note_attributes,
+                               memo,
+                               applied_amount,
+                               transaction_time,
+                               is_advance_invoice)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoidInvoiceEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/void_invoice_event_data1.rb

@@ -0,0 +1,100 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `void_invoice` event
+  class VoidInvoiceEventData1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreditNote]
+    attr_accessor :credit_note_attributes
+
+    # The memo provided during invoice remainder voiding.
+    # @return [String]
+    attr_accessor :memo
+
+    # The amount of the void.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the refund was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_note_attributes'] = 'credit_note_attributes'
+      @_hash['memo'] = 'memo'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_note_attributes
+        memo
+        applied_amount
+        transaction_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_note_attributes = SKIP, memo = SKIP,
+                   applied_amount = SKIP, transaction_time = SKIP)
+      @credit_note_attributes = credit_note_attributes unless credit_note_attributes == SKIP
+      @memo = memo unless memo == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
+        hash['credit_note_attributes']
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
+
+      # Create object from extracted values.
+      VoidInvoiceEventData1.new(credit_note_attributes,
+                                memo,
+                                applied_amount,
+                                transaction_time)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoidInvoiceEventData1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/void_invoice_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # VoidInvoiceRequest Model.
+  class VoidInvoiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [VoidInvoice]
+    attr_accessor :void
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['void'] = 'void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(void = nil)
+      @void = void
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      void = VoidInvoice.from_hash(hash['void']) if hash['void']
+
+      # Create object from extracted values.
+      VoidInvoiceRequest.new(void)
+    end
+  end
+end

data/lib/advanced_billing/models/webhook.rb

@@ -0,0 +1,165 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Webhook Model.
+  class Webhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A string describing which event type produced the given webhook
+    # @return [String]
+    attr_accessor :event
+
+    # The unique identifier for the webhooks (unique across all of Chargify).
+    # This is not changed on a retry/replay of the same webhook, so it may be
+    # used to avoid duplicate action for the same event.
+    # @return [Integer]
+    attr_accessor :id
+
+    # Timestamp indicating when the webhook was created
+    # @return [String]
+    attr_accessor :created_at
+
+    # Text describing the status code and/or error from the last failed attempt
+    # to send the Webhook. When a webhook is retried and accepted, this field
+    # will be cleared.
+    # @return [String]
+    attr_accessor :last_error
+
+    # Timestamp indicating when the last non-acceptance occurred. If a webhook
+    # is later resent and accepted, this field will be cleared.
+    # @return [String]
+    attr_accessor :last_error_at
+
+    # Timestamp indicating when the webhook was accepted by the merchant
+    # endpoint. When a webhook is explicitly replayed by the merchant, this
+    # value will be cleared until it is accepted again.
+    # @return [String]
+    attr_accessor :accepted_at
+
+    # Timestamp indicating when the most recent attempt was made to send the
+    # webhook
+    # @return [String]
+    attr_accessor :last_sent_at
+
+    # The url that the endpoint was last sent to.
+    # @return [String]
+    attr_accessor :last_sent_url
+
+    # A boolean flag describing whether the webhook was accepted by the webhook
+    # endpoint for the most recent attempt. (Acceptance is defined by receiving
+    # a “200 OK” HTTP response within a reasonable timeframe, i.e. 15 seconds)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :successful
+
+    # The data sent within the webhook post
+    # @return [String]
+    attr_accessor :body
+
+    # The calculated webhook signature
+    # @return [String]
+    attr_accessor :signature
+
+    # The calculated HMAC-SHA-256 webhook signature
+    # @return [String]
+    attr_accessor :signature_hmac_sha_256
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event'] = 'event'
+      @_hash['id'] = 'id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['last_error'] = 'last_error'
+      @_hash['last_error_at'] = 'last_error_at'
+      @_hash['accepted_at'] = 'accepted_at'
+      @_hash['last_sent_at'] = 'last_sent_at'
+      @_hash['last_sent_url'] = 'last_sent_url'
+      @_hash['successful'] = 'successful'
+      @_hash['body'] = 'body'
+      @_hash['signature'] = 'signature'
+      @_hash['signature_hmac_sha_256'] = 'signature_hmac_sha_256'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        event
+        id
+        created_at
+        last_error
+        last_error_at
+        accepted_at
+        last_sent_at
+        last_sent_url
+        successful
+        body
+        signature
+        signature_hmac_sha_256
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        accepted_at
+      ]
+    end
+
+    def initialize(event = SKIP, id = SKIP, created_at = SKIP,
+                   last_error = SKIP, last_error_at = SKIP, accepted_at = SKIP,
+                   last_sent_at = SKIP, last_sent_url = SKIP, successful = SKIP,
+                   body = SKIP, signature = SKIP, signature_hmac_sha_256 = SKIP)
+      @event = event unless event == SKIP
+      @id = id unless id == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @last_error = last_error unless last_error == SKIP
+      @last_error_at = last_error_at unless last_error_at == SKIP
+      @accepted_at = accepted_at unless accepted_at == SKIP
+      @last_sent_at = last_sent_at unless last_sent_at == SKIP
+      @last_sent_url = last_sent_url unless last_sent_url == SKIP
+      @successful = successful unless successful == SKIP
+      @body = body unless body == SKIP
+      @signature = signature unless signature == SKIP
+      @signature_hmac_sha_256 = signature_hmac_sha_256 unless signature_hmac_sha_256 == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      event = hash.key?('event') ? hash['event'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      last_error = hash.key?('last_error') ? hash['last_error'] : SKIP
+      last_error_at = hash.key?('last_error_at') ? hash['last_error_at'] : SKIP
+      accepted_at = hash.key?('accepted_at') ? hash['accepted_at'] : SKIP
+      last_sent_at = hash.key?('last_sent_at') ? hash['last_sent_at'] : SKIP
+      last_sent_url = hash.key?('last_sent_url') ? hash['last_sent_url'] : SKIP
+      successful = hash.key?('successful') ? hash['successful'] : SKIP
+      body = hash.key?('body') ? hash['body'] : SKIP
+      signature = hash.key?('signature') ? hash['signature'] : SKIP
+      signature_hmac_sha_256 =
+        hash.key?('signature_hmac_sha_256') ? hash['signature_hmac_sha_256'] : SKIP
+
+      # Create object from extracted values.
+      Webhook.new(event,
+                  id,
+                  created_at,
+                  last_error,
+                  last_error_at,
+                  accepted_at,
+                  last_sent_at,
+                  last_sent_url,
+                  successful,
+                  body,
+                  signature,
+                  signature_hmac_sha_256)
+    end
+  end
+end

data/lib/advanced_billing/models/webhook_order.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Webhook Order.
+  class WebhookOrder
+    WEBHOOK_ORDER = [
+      # TODO: Write general description for NEWEST_FIRST
+      NEWEST_FIRST = 'newest_first'.freeze,
+
+      # TODO: Write general description for OLDEST_FIRST
+      OLDEST_FIRST = 'oldest_first'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_ORDER.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/webhook_response.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # WebhookResponse Model.
+  class WebhookResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Webhook]
+    attr_accessor :webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook'] = 'webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook = SKIP)
+      @webhook = webhook unless webhook == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      webhook = Webhook.from_hash(hash['webhook']) if hash['webhook']
+
+      # Create object from extracted values.
+      WebhookResponse.new(webhook)
+    end
+  end
+end

data/lib/advanced_billing/models/webhook_status.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Webhook Status.
+  class WebhookStatus
+    WEBHOOK_STATUS = [
+      # TODO: Write general description for SUCCESSFUL
+      SUCCESSFUL = 'successful'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for PAUSED
+      PAUSED = 'paused'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/webhook_subscription.rb

@@ -0,0 +1,124 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Webhook Subscription.
+  class WebhookSubscription
+    WEBHOOK_SUBSCRIPTION = [
+      # TODO: Write general description for BILLING_DATE_CHANGE
+      BILLING_DATE_CHANGE = 'billing_date_change'.freeze,
+
+      # TODO: Write general description for COMPONENT_ALLOCATION_CHANGE
+      COMPONENT_ALLOCATION_CHANGE = 'component_allocation_change'.freeze,
+
+      # TODO: Write general description for CUSTOMER_CREATE
+      CUSTOMER_CREATE = 'customer_create'.freeze,
+
+      # TODO: Write general description for CUSTOMER_UPDATE
+      CUSTOMER_UPDATE = 'customer_update'.freeze,
+
+      # TODO: Write general description for DUNNING_STEP_REACHED
+      DUNNING_STEP_REACHED = 'dunning_step_reached'.freeze,
+
+      # TODO: Write general description for EXPIRING_CARD
+      EXPIRING_CARD = 'expiring_card'.freeze,
+
+      # TODO: Write general description for EXPIRATION_DATE_CHANGE
+      EXPIRATION_DATE_CHANGE = 'expiration_date_change'.freeze,
+
+      # TODO: Write general description for INVOICE_ISSUED
+      INVOICE_ISSUED = 'invoice_issued'.freeze,
+
+      # TODO: Write general description for METERED_USAGE
+      METERED_USAGE = 'metered_usage'.freeze,
+
+      # TODO: Write general description for PAYMENT_FAILURE
+      PAYMENT_FAILURE = 'payment_failure'.freeze,
+
+      # TODO: Write general description for PAYMENT_SUCCESS
+      PAYMENT_SUCCESS = 'payment_success'.freeze,
+
+      # TODO: Write general description for DIRECT_DEBIT_PAYMENT_PENDING
+      DIRECT_DEBIT_PAYMENT_PENDING = 'direct_debit_payment_pending'.freeze,
+
+      # TODO: Write general description for DIRECT_DEBIT_PAYMENT_PAID_OUT
+      DIRECT_DEBIT_PAYMENT_PAID_OUT = 'direct_debit_payment_paid_out'.freeze,
+
+      # TODO: Write general description for DIRECT_DEBIT_PAYMENT_REJECTED
+      DIRECT_DEBIT_PAYMENT_REJECTED = 'direct_debit_payment_rejected'.freeze,
+
+      # TODO: Write general description for PREPAID_SUBSCRIPTION_BALANCE_CHANGED
+      PREPAID_SUBSCRIPTION_BALANCE_CHANGED = 'prepaid_subscription_balance_changed'.freeze,
+
+      # TODO: Write general description for PREPAID_USAGE
+      PREPAID_USAGE = 'prepaid_usage'.freeze,
+
+      # TODO: Write general description for REFUND_FAILURE
+      REFUND_FAILURE = 'refund_failure'.freeze,
+
+      # TODO: Write general description for REFUND_SUCCESS
+      REFUND_SUCCESS = 'refund_success'.freeze,
+
+      # TODO: Write general description for RENEWAL_FAILURE
+      RENEWAL_FAILURE = 'renewal_failure'.freeze,
+
+      # TODO: Write general description for RENEWAL_SUCCESS
+      RENEWAL_SUCCESS = 'renewal_success'.freeze,
+
+      # TODO: Write general description for SIGNUP_FAILURE
+      SIGNUP_FAILURE = 'signup_failure'.freeze,
+
+      # TODO: Write general description for SIGNUP_SUCCESS
+      SIGNUP_SUCCESS = 'signup_success'.freeze,
+
+      # TODO: Write general description for STATEMENT_CLOSED
+      STATEMENT_CLOSED = 'statement_closed'.freeze,
+
+      # TODO: Write general description for STATEMENT_SETTLED
+      STATEMENT_SETTLED = 'statement_settled'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_CARD_UPDATE
+      SUBSCRIPTION_CARD_UPDATE = 'subscription_card_update'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_GROUP_CARD_UPDATE
+      SUBSCRIPTION_GROUP_CARD_UPDATE = 'subscription_group_card_update'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_PRODUCT_CHANGE
+      SUBSCRIPTION_PRODUCT_CHANGE = 'subscription_product_change'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION_STATE_CHANGE
+      SUBSCRIPTION_STATE_CHANGE = 'subscription_state_change'.freeze,
+
+      # TODO: Write general description for TRIAL_END_NOTICE
+      TRIAL_END_NOTICE = 'trial_end_notice'.freeze,
+
+      # TODO: Write general description for UPCOMING_RENEWAL_NOTICE
+      UPCOMING_RENEWAL_NOTICE = 'upcoming_renewal_notice'.freeze,
+
+      # TODO: Write general description for UPGRADE_DOWNGRADE_FAILURE
+      UPGRADE_DOWNGRADE_FAILURE = 'upgrade_downgrade_failure'.freeze,
+
+      # TODO: Write general description for UPGRADE_DOWNGRADE_SUCCESS
+      UPGRADE_DOWNGRADE_SUCCESS = 'upgrade_downgrade_success'.freeze,
+
+      # TODO: Write general description for PENDING_CANCELLATION_CHANGE
+      PENDING_CANCELLATION_CHANGE = 'pending_cancellation_change'.freeze,
+
+      # TODO: Write general description for
+      # SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED
+      SUBSCRIPTION_PREPAYMENT_ACCOUNT_BALANCE_CHANGED = 'subscription_prepayment_account_balance_changed'.freeze,
+
+      # TODO: Write general description for
+      # SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED
+      SUBSCRIPTION_SERVICE_CREDIT_ACCOUNT_BALANCE_CHANGED = 'subscription_service_credit_account_balance_changed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_SUBSCRIPTION.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/advanced_billing/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end