plainrouter-sdk 0.1.0

data/lib/plainrouter/openapi/models/validation_error.rb

@@ -0,0 +1,192 @@
+=begin
+#PlainRouter Conversion API
+
+#PlainRouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class ValidationError < ApiModelBase
+    attr_accessor :message
+
+    attr_accessor :errors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message',
+        :'errors' => :'errors'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'message' => :'String',
+        :'errors' => :'Hash<String, Array<String>>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `PlainRouter::OpenAPI::ValidationError` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::ValidationError`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Hash)
+          self.errors = value
+        end
+      else
+        self.errors = nil
+      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 @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      if @errors.nil?
+        invalid_properties.push('invalid value for "errors", errors 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 @message.nil?
+      return false if @errors.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] errors Value to be assigned
+    def errors=(errors)
+      if errors.nil?
+        fail ArgumentError, 'errors cannot be nil'
+      end
+
+      @errors = errors
+    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 &&
+          message == o.message &&
+          errors == o.errors
+    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
+      [message, errors].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
+
+    # 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
+
+  end
+
+end

data/lib/plainrouter/openapi/version.rb

@@ -0,0 +1,15 @@
+=begin
+#PlainRouter Conversion API
+
+#PlainRouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+module PlainRouter::OpenAPI
+  VERSION = '0.1.0'
+end

data/lib/plainrouter/openapi.rb

@@ -0,0 +1,102 @@
+=begin
+#PlainRouter Conversion API
+
+#PlainRouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+# Common files
+require 'plainrouter/openapi/api_client'
+require 'plainrouter/openapi/api_error'
+require 'plainrouter/openapi/api_model_base'
+require 'plainrouter/openapi/version'
+require 'plainrouter/openapi/configuration'
+
+# Models
+require 'plainrouter/openapi/models/create_event200_response'
+require 'plainrouter/openapi/models/create_event_request'
+require 'plainrouter/openapi/models/create_event_request_any_of'
+require 'plainrouter/openapi/models/create_event_request_any_of1'
+require 'plainrouter/openapi/models/create_event_request_any_of_event_time'
+require 'plainrouter/openapi/models/create_event_request_any_of_value_data'
+require 'plainrouter/openapi/models/create_sandbox_key201_response'
+require 'plainrouter/openapi/models/create_sandbox_key201_response_use'
+require 'plainrouter/openapi/models/delete_user_data200_response'
+require 'plainrouter/openapi/models/delete_user_data_request'
+require 'plainrouter/openapi/models/delivery_status'
+require 'plainrouter/openapi/models/destination'
+require 'plainrouter/openapi/models/destination_credential_source'
+require 'plainrouter/openapi/models/destination_status'
+require 'plainrouter/openapi/models/destination_type'
+require 'plainrouter/openapi/models/emq_snapshot'
+require 'plainrouter/openapi/models/error_message'
+require 'plainrouter/openapi/models/event'
+require 'plainrouter/openapi/models/get_emq_report200_response'
+require 'plainrouter/openapi/models/get_emq_report200_response_snapshots_inner'
+require 'plainrouter/openapi/models/get_event200_response'
+require 'plainrouter/openapi/models/get_event200_response_deliveries_inner'
+require 'plainrouter/openapi/models/get_event200_response_event'
+require 'plainrouter/openapi/models/get_event200_response_event_consent'
+require 'plainrouter/openapi/models/get_event200_response_event_deliveries_inner'
+require 'plainrouter/openapi/models/get_event200_response_lineage'
+require 'plainrouter/openapi/models/get_event200_response_lineage_children_inner'
+require 'plainrouter/openapi/models/get_event200_response_lineage_parent'
+require 'plainrouter/openapi/models/get_reconciliation_report200_response'
+require 'plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner'
+require 'plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_buckets_value'
+require 'plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts'
+require 'plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts_accepted'
+require 'plainrouter/openapi/models/get_sandbox200_response'
+require 'plainrouter/openapi/models/get_sandbox200_response_self_serve_key'
+require 'plainrouter/openapi/models/get_sandbox200_response_try'
+require 'plainrouter/openapi/models/get_sandbox200_response_try_body'
+require 'plainrouter/openapi/models/get_sandbox200_response_try_body_value_data'
+require 'plainrouter/openapi/models/jurisdiction_policy_class'
+require 'plainrouter/openapi/models/list_events200_response'
+require 'plainrouter/openapi/models/list_events200_response_events'
+require 'plainrouter/openapi/models/list_events200_response_events_links_inner'
+require 'plainrouter/openapi/models/list_events200_response_metrics'
+require 'plainrouter/openapi/models/list_events_by_cursor200_response'
+require 'plainrouter/openapi/models/list_events_by_cursor200_response_events'
+require 'plainrouter/openapi/models/reconciliation_report'
+require 'plainrouter/openapi/models/replay_deliveries202_response'
+require 'plainrouter/openapi/models/replay_deliveries_request'
+require 'plainrouter/openapi/models/send_test_purchase200_response'
+require 'plainrouter/openapi/models/send_test_purchase422_response'
+require 'plainrouter/openapi/models/send_test_purchase_request'
+require 'plainrouter/openapi/models/set_destination_test_mode200_response'
+require 'plainrouter/openapi/models/set_destination_test_mode200_response_destination'
+require 'plainrouter/openapi/models/set_destination_test_mode_request'
+require 'plainrouter/openapi/models/traffic_class'
+require 'plainrouter/openapi/models/validate_sandbox_event200_response'
+require 'plainrouter/openapi/models/validate_sandbox_event_request'
+require 'plainrouter/openapi/models/validate_sandbox_event_request_value_data'
+require 'plainrouter/openapi/models/validation_error'
+
+# APIs
+require 'plainrouter/openapi/api/event_api'
+require 'plainrouter/openapi/api/operations_api'
+require 'plainrouter/openapi/api/sandbox_api'
+
+module PlainRouter::OpenAPI
+  class << self
+    # Customize default settings for the SDK using block.
+    #   PlainRouter::OpenAPI.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

data/lib/plainrouter/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PlainRouter
+  VERSION = "0.1.0"
+  CONTRACT_VERSION = "0.5.0"
+end

data/lib/plainrouter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "plainrouter/version"
+
+module PlainRouter
+  DEFAULT_BASE_URL = "https://plainrouter.com/api/v1"
+end
+
+require_relative "plainrouter/openapi"
+require_relative "plainrouter/client"

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: plainrouter-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PlainRouter
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A compact Ruby client generated from PlainRouter's signed OpenAPI contract.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/plainrouter.rb
+- lib/plainrouter/client.rb
+- lib/plainrouter/openapi.rb
+- lib/plainrouter/openapi/api/event_api.rb
+- lib/plainrouter/openapi/api/operations_api.rb
+- lib/plainrouter/openapi/api/sandbox_api.rb
+- lib/plainrouter/openapi/api_client.rb
+- lib/plainrouter/openapi/api_error.rb
+- lib/plainrouter/openapi/api_model_base.rb
+- lib/plainrouter/openapi/configuration.rb
+- lib/plainrouter/openapi/models/create_event200_response.rb
+- lib/plainrouter/openapi/models/create_event_request.rb
+- lib/plainrouter/openapi/models/create_event_request_any_of.rb
+- lib/plainrouter/openapi/models/create_event_request_any_of1.rb
+- lib/plainrouter/openapi/models/create_event_request_any_of_event_time.rb
+- lib/plainrouter/openapi/models/create_event_request_any_of_value_data.rb
+- lib/plainrouter/openapi/models/create_sandbox_key201_response.rb
+- lib/plainrouter/openapi/models/create_sandbox_key201_response_use.rb
+- lib/plainrouter/openapi/models/delete_user_data200_response.rb
+- lib/plainrouter/openapi/models/delete_user_data_request.rb
+- lib/plainrouter/openapi/models/delivery_status.rb
+- lib/plainrouter/openapi/models/destination.rb
+- lib/plainrouter/openapi/models/destination_credential_source.rb
+- lib/plainrouter/openapi/models/destination_status.rb
+- lib/plainrouter/openapi/models/destination_type.rb
+- lib/plainrouter/openapi/models/emq_snapshot.rb
+- lib/plainrouter/openapi/models/error_message.rb
+- lib/plainrouter/openapi/models/event.rb
+- lib/plainrouter/openapi/models/get_emq_report200_response.rb
+- lib/plainrouter/openapi/models/get_emq_report200_response_snapshots_inner.rb
+- lib/plainrouter/openapi/models/get_event200_response.rb
+- lib/plainrouter/openapi/models/get_event200_response_deliveries_inner.rb
+- lib/plainrouter/openapi/models/get_event200_response_event.rb
+- lib/plainrouter/openapi/models/get_event200_response_event_consent.rb
+- lib/plainrouter/openapi/models/get_event200_response_event_deliveries_inner.rb
+- lib/plainrouter/openapi/models/get_event200_response_lineage.rb
+- lib/plainrouter/openapi/models/get_event200_response_lineage_children_inner.rb
+- lib/plainrouter/openapi/models/get_event200_response_lineage_parent.rb
+- lib/plainrouter/openapi/models/get_reconciliation_report200_response.rb
+- lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner.rb
+- lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_buckets_value.rb
+- lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts.rb
+- lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts_accepted.rb
+- lib/plainrouter/openapi/models/get_sandbox200_response.rb
+- lib/plainrouter/openapi/models/get_sandbox200_response_self_serve_key.rb
+- lib/plainrouter/openapi/models/get_sandbox200_response_try.rb
+- lib/plainrouter/openapi/models/get_sandbox200_response_try_body.rb
+- lib/plainrouter/openapi/models/get_sandbox200_response_try_body_value_data.rb
+- lib/plainrouter/openapi/models/jurisdiction_policy_class.rb
+- lib/plainrouter/openapi/models/list_events200_response.rb
+- lib/plainrouter/openapi/models/list_events200_response_events.rb
+- lib/plainrouter/openapi/models/list_events200_response_events_links_inner.rb
+- lib/plainrouter/openapi/models/list_events200_response_metrics.rb
+- lib/plainrouter/openapi/models/list_events_by_cursor200_response.rb
+- lib/plainrouter/openapi/models/list_events_by_cursor200_response_events.rb
+- lib/plainrouter/openapi/models/reconciliation_report.rb
+- lib/plainrouter/openapi/models/replay_deliveries202_response.rb
+- lib/plainrouter/openapi/models/replay_deliveries_request.rb
+- lib/plainrouter/openapi/models/send_test_purchase200_response.rb
+- lib/plainrouter/openapi/models/send_test_purchase422_response.rb
+- lib/plainrouter/openapi/models/send_test_purchase_request.rb
+- lib/plainrouter/openapi/models/set_destination_test_mode200_response.rb
+- lib/plainrouter/openapi/models/set_destination_test_mode200_response_destination.rb
+- lib/plainrouter/openapi/models/set_destination_test_mode_request.rb
+- lib/plainrouter/openapi/models/traffic_class.rb
+- lib/plainrouter/openapi/models/validate_sandbox_event200_response.rb
+- lib/plainrouter/openapi/models/validate_sandbox_event_request.rb
+- lib/plainrouter/openapi/models/validate_sandbox_event_request_value_data.rb
+- lib/plainrouter/openapi/models/validation_error.rb
+- lib/plainrouter/openapi/version.rb
+- lib/plainrouter/version.rb
+homepage: https://github.com/plainrouter/sdk
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/plainrouter/sdk/issues
+  documentation_uri: https://github.com/plainrouter/sdk/tree/main/packages/ruby
+  homepage_uri: https://github.com/plainrouter/sdk
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/plainrouter/sdk/tree/ruby-v0.1.0/packages/ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Official Ruby SDK for the PlainRouter Signals Conversion API
+test_files: []