univapay-client-sdk 1.0.0

data/lib/univapay_client_sdk/models/webhook.rb

@@ -0,0 +1,191 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Represents a webhook subscription. Webhooks send event notifications to a
+  # specified URL when triggered by payment events.
+  class Webhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the webhook.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # ID of the store this webhook belongs to (null for merchant-level
+    # webhooks).
+    # @return [UUID | String]
+    attr_accessor :store_id
+
+    # ID of the merchant this webhook belongs to.
+    # @return [UUID | String]
+    attr_accessor :merchant_id
+
+    # List of event types that trigger this webhook.
+    # @return [Array[WebhookTrigger]]
+    attr_accessor :triggers
+
+    # The endpoint URL that receives webhook POST requests.
+    # @return [String]
+    attr_accessor :url
+
+    # Optional bearer token included in the `Authorization` header of webhook
+    # requests. Used to authenticate the webhook receiver.
+    # @return [String]
+    attr_accessor :auth_token
+
+    # Whether this webhook is currently active and receiving events.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # Admin-only flag. Indicates this webhook is used for platform integration
+    # purposes. Not settable by merchants.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_integration
+
+    # Timestamp when the webhook was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Timestamp when the webhook was last updated.
+    # @return [DateTime]
+    attr_accessor :updated_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['merchant_id'] = 'merchant_id'
+      @_hash['triggers'] = 'triggers'
+      @_hash['url'] = 'url'
+      @_hash['auth_token'] = 'auth_token'
+      @_hash['active'] = 'active'
+      @_hash['is_integration'] = 'is_integration'
+      @_hash['created_on'] = 'created_on'
+      @_hash['updated_on'] = 'updated_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        store_id
+        merchant_id
+        triggers
+        url
+        auth_token
+        active
+        is_integration
+        created_on
+        updated_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        store_id
+        merchant_id
+        auth_token
+      ]
+    end
+
+    def initialize(id: SKIP, store_id: SKIP, merchant_id: SKIP, triggers: SKIP,
+                   url: SKIP, auth_token: SKIP, active: SKIP,
+                   is_integration: SKIP, created_on: SKIP, updated_on: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @triggers = triggers unless triggers == SKIP
+      @url = url unless url == SKIP
+      @auth_token = auth_token unless auth_token == SKIP
+      @active = active unless active == SKIP
+      @is_integration = is_integration unless is_integration == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @updated_on = updated_on unless updated_on == SKIP
+      @additional_properties = additional_properties
+    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'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      merchant_id = hash.key?('merchant_id') ? hash['merchant_id'] : SKIP
+      triggers = hash.key?('triggers') ? hash['triggers'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      auth_token = hash.key?('auth_token') ? hash['auth_token'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      is_integration =
+        hash.key?('is_integration') ? hash['is_integration'] : SKIP
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      updated_on = if hash.key?('updated_on')
+                     (DateTimeHelper.from_rfc3339(hash['updated_on']) if hash['updated_on'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      Webhook.new(id: id,
+                  store_id: store_id,
+                  merchant_id: merchant_id,
+                  triggers: triggers,
+                  url: url,
+                  auth_token: auth_token,
+                  active: active,
+                  is_integration: is_integration,
+                  created_on: created_on,
+                  updated_on: updated_on,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_updated_on
+      DateTimeHelper.to_rfc3339(updated_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, store_id: #{@store_id}, merchant_id: #{@merchant_id}, triggers:"\
+      " #{@triggers}, url: #{@url}, auth_token: #{@auth_token}, active: #{@active},"\
+      " is_integration: #{@is_integration}, created_on: #{@created_on}, updated_on:"\
+      " #{@updated_on}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, store_id: #{@store_id.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, triggers: #{@triggers.inspect}, url: #{@url.inspect}, auth_token:"\
+      " #{@auth_token.inspect}, active: #{@active.inspect}, is_integration:"\
+      " #{@is_integration.inspect}, created_on: #{@created_on.inspect}, updated_on:"\
+      " #{@updated_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/webhook_callback_envelope.rb

@@ -0,0 +1,98 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Common wrapper POSTed to your webhook URL for every event. The `data` field
+  # contains the domain object relevant to the event type.
+  class WebhookCallbackEnvelope < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Event type that triggers a webhook notification.
+    # @return [WebhookTrigger]
+    attr_accessor :event
+
+    # Timestamp when the event was fired.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['event'] = 'event'
+      @_hash['created_on'] = 'created_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, event:, created_on:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @event = event
+      @created_on = created_on
+      @additional_properties = additional_properties
+    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
+      event = hash.key?('event') ? hash['event'] : nil
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   end
+
+      # 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.
+      WebhookCallbackEnvelope.new(id: id,
+                                  event: event,
+                                  created_on: created_on,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, event: #{@event}, created_on: #{@created_on},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, event: #{@event.inspect}, created_on:"\
+      " #{@created_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/webhook_create_request.rb

@@ -0,0 +1,97 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Request body to create a new store-level webhook subscription.
+  class WebhookCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of event types that trigger this webhook. Must be non-empty and
+    # contain only events valid for the store level.
+    # @return [Array[WebhookTrigger]]
+    attr_accessor :triggers
+
+    # The URL to POST webhook payloads to.
+    # @return [String]
+    attr_accessor :url
+
+    # Optional bearer token sent in the `Authorization` header of webhook
+    # requests.
+    # @return [String]
+    attr_accessor :auth_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['triggers'] = 'triggers'
+      @_hash['url'] = 'url'
+      @_hash['auth_token'] = 'auth_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auth_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        auth_token
+      ]
+    end
+
+    def initialize(triggers:, url:, auth_token: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @triggers = triggers
+      @url = url
+      @auth_token = auth_token unless auth_token == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      triggers = hash.key?('triggers') ? hash['triggers'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      auth_token = hash.key?('auth_token') ? hash['auth_token'] : SKIP
+
+      # 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.
+      WebhookCreateRequest.new(triggers: triggers,
+                               url: url,
+                               auth_token: auth_token,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} triggers: #{@triggers}, url: #{@url}, auth_token: #{@auth_token},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} triggers: #{@triggers.inspect}, url: #{@url.inspect}, auth_token:"\
+      " #{@auth_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/webhook_event.rb

@@ -0,0 +1,166 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Represents a single delivery attempt of a webhook event, including the
+  # payload sent and the delivery outcome.
+  class WebhookEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the webhook event.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # ID of the parent webhook.
+    # @return [UUID | String]
+    attr_accessor :webhook_id
+
+    # Event type that triggers a webhook notification.
+    # @return [WebhookTrigger]
+    attr_accessor :event
+
+    # Domain object payload for webhook deliveries. The actual structure depends
+    # on the event type — see each webhook callback schema for the specific
+    # payload shape.
+    # @return [Object]
+    attr_accessor :data
+
+    # Whether the webhook delivery was acknowledged (HTTP 2xx).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :successful
+
+    # Timestamp when the webhook was dispatched.
+    # @return [DateTime]
+    attr_accessor :fired_on
+
+    # Error message if delivery failed.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Timestamp when the event was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['webhook_id'] = 'webhook_id'
+      @_hash['event'] = 'event'
+      @_hash['data'] = 'data'
+      @_hash['successful'] = 'successful'
+      @_hash['fired_on'] = 'fired_on'
+      @_hash['error_message'] = 'error_message'
+      @_hash['created_on'] = 'created_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        webhook_id
+        event
+        data
+        successful
+        fired_on
+        error_message
+        created_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error_message
+      ]
+    end
+
+    def initialize(id: SKIP, webhook_id: SKIP, event: SKIP, data: SKIP,
+                   successful: SKIP, fired_on: SKIP, error_message: SKIP,
+                   created_on: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @webhook_id = webhook_id unless webhook_id == SKIP
+      @event = event unless event == SKIP
+      @data = data unless data == SKIP
+      @successful = successful unless successful == SKIP
+      @fired_on = fired_on unless fired_on == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @additional_properties = additional_properties
+    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'] : SKIP
+      webhook_id = hash.key?('webhook_id') ? hash['webhook_id'] : SKIP
+      event = hash.key?('event') ? hash['event'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+      successful = hash.key?('successful') ? hash['successful'] : SKIP
+      fired_on = if hash.key?('fired_on')
+                   (DateTimeHelper.from_rfc3339(hash['fired_on']) if hash['fired_on'])
+                 else
+                   SKIP
+                 end
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      WebhookEvent.new(id: id,
+                       webhook_id: webhook_id,
+                       event: event,
+                       data: data,
+                       successful: successful,
+                       fired_on: fired_on,
+                       error_message: error_message,
+                       created_on: created_on,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_fired_on
+      DateTimeHelper.to_rfc3339(fired_on)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, webhook_id: #{@webhook_id}, event: #{@event}, data: #{@data},"\
+      " successful: #{@successful}, fired_on: #{@fired_on}, error_message: #{@error_message},"\
+      " created_on: #{@created_on}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, webhook_id: #{@webhook_id.inspect}, event:"\
+      " #{@event.inspect}, data: #{@data.inspect}, successful: #{@successful.inspect}, fired_on:"\
+      " #{@fired_on.inspect}, error_message: #{@error_message.inspect}, created_on:"\
+      " #{@created_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/webhook_event_list.rb

@@ -0,0 +1,94 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Paginated list of webhook events.
+  class WebhookEventList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[WebhookEvent]]
+    attr_accessor :items
+
+    # Whether more results are available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['has_more'] = 'has_more'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        has_more
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items: SKIP, has_more: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @items = items unless items == SKIP
+      @has_more = has_more unless has_more == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (WebhookEvent.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      has_more = hash.key?('has_more') ? hash['has_more'] : SKIP
+
+      # 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.
+      WebhookEventList.new(items: items,
+                           has_more: has_more,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}, has_more: #{@has_more}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}, has_more: #{@has_more.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end