ddx_interactions_api 0.1.0.pre.1

data/lib/ddx_interactions_api/models/who_am_i_api_key_dto.rb

@@ -0,0 +1,286 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DdxInteractionsApi
+  class WhoAmIApiKeyDto
+    # Unique identifier that specifies which API Key is being used
+    attr_accessor :public_key_id
+
+    attr_accessor :source
+
+    attr_accessor :workspace
+
+    # The date and time the API Key is set to expire. The time should be evaluated in Eastern Time.
+    attr_accessor :expire_date
+
+    # The destinations enabled for this API key
+    attr_accessor :destinations
+
+    attr_accessor :van_api_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'public_key_id' => :'publicKeyId',
+        :'source' => :'source',
+        :'workspace' => :'workspace',
+        :'expire_date' => :'expireDate',
+        :'destinations' => :'destinations',
+        :'van_api_key' => :'vanApiKey'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'public_key_id' => :'Integer',
+        :'source' => :'SimpleMovementAppDto',
+        :'workspace' => :'SimpleWorkspaceDto',
+        :'expire_date' => :'Time',
+        :'destinations' => :'Array<SimpleDestinationDto>',
+        :'van_api_key' => :'MercuryDestinationVanApiKeyDto'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expire_date',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DdxInteractionsApi::WhoAmIApiKeyDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DdxInteractionsApi::WhoAmIApiKeyDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'public_key_id')
+        self.public_key_id = attributes[:'public_key_id']
+      else
+        self.public_key_id = nil
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = nil
+      end
+
+      if attributes.key?(:'workspace')
+        self.workspace = attributes[:'workspace']
+      else
+        self.workspace = nil
+      end
+
+      if attributes.key?(:'expire_date')
+        self.expire_date = attributes[:'expire_date']
+      end
+
+      if attributes.key?(:'destinations')
+        if (value = attributes[:'destinations']).is_a?(Array)
+          self.destinations = value
+        end
+      end
+
+      if attributes.key?(:'van_api_key')
+        self.van_api_key = attributes[:'van_api_key']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @public_key_id.nil?
+        invalid_properties.push('invalid value for "public_key_id", public_key_id cannot be nil.')
+      end
+
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
+      end
+
+      if @workspace.nil?
+        invalid_properties.push('invalid value for "workspace", workspace cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @public_key_id.nil?
+      return false if @source.nil?
+      return false if @workspace.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          public_key_id == o.public_key_id &&
+          source == o.source &&
+          workspace == o.workspace &&
+          expire_date == o.expire_date &&
+          destinations == o.destinations &&
+          van_api_key == o.van_api_key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [public_key_id, source, workspace, expire_date, destinations, van_api_key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = DdxInteractionsApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ddx_interactions_api/models/workspace_type_dto.rb

@@ -0,0 +1,40 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DdxInteractionsApi
+  class WorkspaceTypeDto
+    PERSONAL = "Personal".freeze
+    ORGANIZATION = "Organization".freeze
+
+    def self.all_vars
+      @all_vars ||= [PERSONAL, ORGANIZATION].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if WorkspaceTypeDto.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #WorkspaceTypeDto"
+    end
+  end
+end

data/lib/ddx_interactions_api/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+module DdxInteractionsApi
+  VERSION = '0.1.0.pre.1'
+end

data/lib/ddx_interactions_api.rb

@@ -0,0 +1,96 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+# Common files
+require 'ddx_interactions_api/api_client'
+require 'ddx_interactions_api/api_error'
+require 'ddx_interactions_api/version'
+require 'ddx_interactions_api/configuration'
+
+# Models
+require 'ddx_interactions_api/models/accepted_interaction_dto'
+require 'ddx_interactions_api/models/accepted_interactions_dto'
+require 'ddx_interactions_api/models/activist_code'
+require 'ddx_interactions_api/models/activist_code_outcome_details'
+require 'ddx_interactions_api/models/address'
+require 'ddx_interactions_api/models/address_channel_details'
+require 'ddx_interactions_api/models/canvasser_details'
+require 'ddx_interactions_api/models/committee_details'
+require 'ddx_interactions_api/models/communication_consent'
+require 'ddx_interactions_api/models/communication_consent_outcome_details'
+require 'ddx_interactions_api/models/communication_consent_status'
+require 'ddx_interactions_api/models/contact_info'
+require 'ddx_interactions_api/models/contact_method'
+require 'ddx_interactions_api/models/dynamic_channel_details'
+require 'ddx_interactions_api/models/dynamic_outcome_details'
+require 'ddx_interactions_api/models/event_details'
+require 'ddx_interactions_api/models/event_role'
+require 'ddx_interactions_api/models/event_signup'
+require 'ddx_interactions_api/models/event_signup_outcome_details'
+require 'ddx_interactions_api/models/event_signup_status'
+require 'ddx_interactions_api/models/event_signup_status_value'
+require 'ddx_interactions_api/models/exchange_interaction_status'
+require 'ddx_interactions_api/models/exchange_interaction_status_dto'
+require 'ddx_interactions_api/models/exchange_interaction_status_dto_cursor_paginated_response_dto'
+require 'ddx_interactions_api/models/external_api_key_status'
+require 'ddx_interactions_api/models/external_api_key_type'
+require 'ddx_interactions_api/models/external_transaction_status'
+require 'ddx_interactions_api/models/initiative_dto'
+require 'ddx_interactions_api/models/interaction_dto'
+require 'ddx_interactions_api/models/interaction_dto_channel'
+require 'ddx_interactions_api/models/interaction_dto_outcomes_detailed_inner'
+require 'ddx_interactions_api/models/interaction_error_dto'
+require 'ddx_interactions_api/models/interaction_van_fields_dto'
+require 'ddx_interactions_api/models/interactions_batch_result_dto'
+require 'ddx_interactions_api/models/interactions_dto'
+require 'ddx_interactions_api/models/interactions_external_api_transaction_dto'
+require 'ddx_interactions_api/models/interactions_external_api_transaction_dto_get_response_dto'
+require 'ddx_interactions_api/models/interactions_external_api_transaction_log_dto'
+require 'ddx_interactions_api/models/mercury_destination_van_api_key_dto'
+require 'ddx_interactions_api/models/minerva_metadata_dto'
+require 'ddx_interactions_api/models/outcome'
+require 'ddx_interactions_api/models/outcome_detail_operation'
+require 'ddx_interactions_api/models/person_identifier'
+require 'ddx_interactions_api/models/problem_details'
+require 'ddx_interactions_api/models/rejected_interaction_dto'
+require 'ddx_interactions_api/models/rejected_interactions_dto'
+require 'ddx_interactions_api/models/simple_destination_dto'
+require 'ddx_interactions_api/models/simple_movement_app_dto'
+require 'ddx_interactions_api/models/simple_workspace_dto'
+require 'ddx_interactions_api/models/survey_response'
+require 'ddx_interactions_api/models/survey_response_outcome_details'
+require 'ddx_interactions_api/models/van_api_key_dto'
+require 'ddx_interactions_api/models/van_database_mode'
+require 'ddx_interactions_api/models/who_am_i_api_key_dto'
+require 'ddx_interactions_api/models/workspace_type_dto'
+
+# APIs
+require 'ddx_interactions_api/api/authentication_details_api'
+require 'ddx_interactions_api/api/interactions_api'
+
+module DdxInteractionsApi
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DdxInteractionsApi.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: ddx_interactions_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- DDx API Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: Ruby client for the DDx Interactions API, generated from the OpenAPI
+  spec.
+email:
+- api@demexchange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ddx_interactions_api.rb
+- lib/ddx_interactions_api/api/authentication_details_api.rb
+- lib/ddx_interactions_api/api/interactions_api.rb
+- lib/ddx_interactions_api/api_client.rb
+- lib/ddx_interactions_api/api_error.rb
+- lib/ddx_interactions_api/configuration.rb
+- lib/ddx_interactions_api/models/accepted_interaction_dto.rb
+- lib/ddx_interactions_api/models/accepted_interactions_dto.rb
+- lib/ddx_interactions_api/models/activist_code.rb
+- lib/ddx_interactions_api/models/activist_code_outcome_details.rb
+- lib/ddx_interactions_api/models/address.rb
+- lib/ddx_interactions_api/models/address_channel_details.rb
+- lib/ddx_interactions_api/models/canvasser_details.rb
+- lib/ddx_interactions_api/models/committee_details.rb
+- lib/ddx_interactions_api/models/communication_consent.rb
+- lib/ddx_interactions_api/models/communication_consent_outcome_details.rb
+- lib/ddx_interactions_api/models/communication_consent_status.rb
+- lib/ddx_interactions_api/models/contact_info.rb
+- lib/ddx_interactions_api/models/contact_method.rb
+- lib/ddx_interactions_api/models/dynamic_channel_details.rb
+- lib/ddx_interactions_api/models/dynamic_outcome_details.rb
+- lib/ddx_interactions_api/models/event_details.rb
+- lib/ddx_interactions_api/models/event_role.rb
+- lib/ddx_interactions_api/models/event_signup.rb
+- lib/ddx_interactions_api/models/event_signup_outcome_details.rb
+- lib/ddx_interactions_api/models/event_signup_status.rb
+- lib/ddx_interactions_api/models/event_signup_status_value.rb
+- lib/ddx_interactions_api/models/exchange_interaction_status.rb
+- lib/ddx_interactions_api/models/exchange_interaction_status_dto.rb
+- lib/ddx_interactions_api/models/exchange_interaction_status_dto_cursor_paginated_response_dto.rb
+- lib/ddx_interactions_api/models/external_api_key_status.rb
+- lib/ddx_interactions_api/models/external_api_key_type.rb
+- lib/ddx_interactions_api/models/external_transaction_status.rb
+- lib/ddx_interactions_api/models/initiative_dto.rb
+- lib/ddx_interactions_api/models/interaction_dto.rb
+- lib/ddx_interactions_api/models/interaction_dto_channel.rb
+- lib/ddx_interactions_api/models/interaction_dto_outcomes_detailed_inner.rb
+- lib/ddx_interactions_api/models/interaction_error_dto.rb
+- lib/ddx_interactions_api/models/interaction_van_fields_dto.rb
+- lib/ddx_interactions_api/models/interactions_batch_result_dto.rb
+- lib/ddx_interactions_api/models/interactions_dto.rb
+- lib/ddx_interactions_api/models/interactions_external_api_transaction_dto.rb
+- lib/ddx_interactions_api/models/interactions_external_api_transaction_dto_get_response_dto.rb
+- lib/ddx_interactions_api/models/interactions_external_api_transaction_log_dto.rb
+- lib/ddx_interactions_api/models/mercury_destination_van_api_key_dto.rb
+- lib/ddx_interactions_api/models/minerva_metadata_dto.rb
+- lib/ddx_interactions_api/models/outcome.rb
+- lib/ddx_interactions_api/models/outcome_detail_operation.rb
+- lib/ddx_interactions_api/models/person_identifier.rb
+- lib/ddx_interactions_api/models/problem_details.rb
+- lib/ddx_interactions_api/models/rejected_interaction_dto.rb
+- lib/ddx_interactions_api/models/rejected_interactions_dto.rb
+- lib/ddx_interactions_api/models/simple_destination_dto.rb
+- lib/ddx_interactions_api/models/simple_movement_app_dto.rb
+- lib/ddx_interactions_api/models/simple_workspace_dto.rb
+- lib/ddx_interactions_api/models/survey_response.rb
+- lib/ddx_interactions_api/models/survey_response_outcome_details.rb
+- lib/ddx_interactions_api/models/van_api_key_dto.rb
+- lib/ddx_interactions_api/models/van_database_mode.rb
+- lib/ddx_interactions_api/models/who_am_i_api_key_dto.rb
+- lib/ddx_interactions_api/models/workspace_type_dto.rb
+- lib/ddx_interactions_api/version.rb
+homepage: https://github.com/Movement-Infrastructure/interactions-api-sdks
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby client for the DDx Interactions API
+test_files: []