didww-v3 1.3.1 → 4.0.0

data/lib/didww/resource/identity.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Identity < Base
+      IDENTITY_TYPE_PERSONAL = 'Personal'
+      IDENTITY_TYPE_BUSINESS = 'Business'
+
+      has_one :country, class_name: 'Country'
+      has_many :proofs, class_name: 'Proof'
+      has_many :addresses, class_name: 'Address'
+      has_many :permanent_documents, class_name: 'PermanentSupportingDocument'
+
+      property :first_name, type: :string
+      # Type: String
+      # Description:
+
+      property :last_name, type: :string
+      # Type: String
+      # Description:
+
+      property :phone_number, type: :string
+      # Type: String
+      # Description:
+
+      property :id_number, type: :string
+      # Type: String
+      # Description:
+
+      property :birth_date, type: :date
+      # Type: Date
+      # Description:
+
+      property :company_name, type: :string
+      # Type: String
+      # Description:
+
+      property :company_reg_number, type: :string
+      # Type: String
+      # Description:
+
+      property :vat_id, type: :string
+      # Type: String
+      # Description:
+
+      property :description, type: :string
+      # Type: String
+      # Description:
+
+      property :personal_tax_id, type: :string
+      # Type: String
+      # Description:
+
+      property :identity_type, type: :string
+      # Type: String
+      # Description:
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :external_reference_id, type: :string
+      # Type: String
+      # Description:
+
+      property :verified, type: :boolean
+      # Type: Boolean
+      # Description:
+
+      def personal?
+        identity_type == IDENTITY_TYPE_PERSONAL
+      end
+
+      def business?
+        identity_type == IDENTITY_TYPE_BUSINESS
+      end
+    end
+  end
+end

data/lib/didww/resource/nanpa_prefix.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DIDWW
+  module Resource
+    class NanpaPrefix < Base
+      has_one :country, class_name: Country
+      has_one :region, class_name: Region
+
+      property :npa, type: :string
+      # Type: String
+      # Description: NPA codes, or area codes consisting of three digits
+      property :nxx, type: :string
+      # Type: String
+      # Description: Refer to three-digit code
+      # that forms the second part of a 10-digit North American phone number
+    end
+  end
+end

data/lib/didww/{resources → resource}/order.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/did_order_item'
 require 'didww/complex_objects/capacity_order_item'
+require 'didww/callback/const'
 
 module DIDWW
   module Resource
     class Order < Base
-      module CONST
-        # Possible values for order.status
-        STATUS_PENDING      = 'Pending'                       .freeze
-        STATUS_COMPLETED    = 'Completed'                     .freeze
-        STATUS_CANCELLED    = 'Canceled'                      .freeze
-        STATUSES = [
-          STATUS_PENDING,
-          STATUS_COMPLETED,
-          STATUS_CANCELLED
-        ].freeze
-      end
+      include DIDWW::Callback::CONST
 
-      include CONST
+      # Possible values for order.status
+      STATUS_PENDING      = 'Pending'
+      STATUS_COMPLETED    = 'Completed'
+      STATUS_CANCELLED    = 'Canceled'
+      STATUSES = [
+                   STATUS_PENDING,
+                   STATUS_COMPLETED,
+                   STATUS_CANCELLED
+                 ].freeze
 
       property :reference, type: :string
       # Type: String
@@ -46,6 +46,14 @@ module DIDWW
       # Type: Boolean
       # Description: Allowing back ordering
 
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
       def initialize(*args)
         super
         self.items ||= []

data/lib/didww/resource/permanent_supporting_document.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class PermanentSupportingDocument < Base
+
+      has_many :files, class_name: 'EncryptedFile'
+      has_one :template, class_name: 'SupportingDocumentTemplate'
+      has_one :identity, class_name: 'Identity'
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+    end
+  end
+end

data/lib/didww/{resources → resource}/pop.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Pop < Base

data/lib/didww/resource/proof.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Proof < Base
+
+      has_many :files, class_name: 'EncryptedFile'
+      has_one :proof_type, class_name: 'ProofType'
+      has_one :entity, class_name: 'Entity', polymorphic: true
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :is_expired, type: :boolean
+      # Type: Boolean
+      # Description:
+    end
+  end
+end

data/lib/didww/resource/proof_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class ProofType < Base
+      property :name, type: :string
+      # Type: String
+      # Description:
+
+      property :entity_type, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/resource/public_key.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class PublicKey < Base
+
+      property :key, type: :string
+      # Type: String
+      # Description: Public key for encryption.
+
+    end
+  end
+end

data/lib/didww/{resources → resource}/qty_based_pricing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class QtyBasedPricing < Base

data/lib/didww/{resources → resource}/region.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Region < Base

data/lib/didww/resource/requirement.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Requirement < Base
+
+      has_one :country, class_name: 'Country'
+      has_one :did_group_type, class_name: 'DidGroupType', relation_name: :group_type
+      has_one :personal_permanent_document, class_name: 'SupportingDocumentTemplate'
+      has_one :business_permanent_document, class_name: 'SupportingDocumentTemplate'
+      has_one :personal_onetime_document, class_name: 'SupportingDocumentTemplate'
+      has_one :business_onetime_document, class_name: 'SupportingDocumentTemplate'
+      has_many :personal_proof_types, class_name: 'ProofType'
+      has_many :business_proof_types, class_name: 'ProofType'
+      has_many :address_proof_types, class_name: 'ProofType'
+
+      property :identity_type, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :personal_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :business_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :address_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :personal_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :business_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :address_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :personal_mandatory_fields, type: :array
+      # Type: String[]
+      # Description:
+
+      property :business_mandatory_fields, type: :array
+      # Type: String[]
+      # Description:
+
+      property :service_description_required, type: :boolean
+      # Type: Boolean
+      # Description:
+
+      property :restriction_message, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/resource/requirement_validation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class RequirementValidation < Base
+      has_one :requirement, class_name: 'Requirement'
+      has_one :address, class_name: 'Address'
+      has_one :identity, class_name: 'Identity'
+    end
+  end
+end

data/lib/didww/{resources → resource}/shared_capacity_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class SharedCapacityGroup < Base

data/lib/didww/{resources → resource}/stock_keeping_unit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class StockKeepingUnit < Base

data/lib/didww/resource/supporting_document_template.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class SupportingDocumentTemplate < Base
+      property :name, type: :string
+      # Type: String
+      # Description:
+
+      property :url, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/{resources/trunk.rb → resource/voice_in_trunk.rb}

@@ -1,13 +1,42 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/configurations'
-require 'didww/resources/trunk/const'
 
 module DIDWW
   module Resource
-    class Trunk < Base
-      include CONST
+    class VoiceInTrunk < Base
+      # Allowed values for trunk.cli_format
+      CLI_FORMAT_RAW     = 'raw'
+      CLI_FORMAT_E164    = 'e164'
+      CLI_FORMAT_LOCAL   = 'local'
+
+      CLI_FORMATS = {
+                      CLI_FORMAT_RAW   => 'Raw',
+                      CLI_FORMAT_E164  => 'E.164',
+                      CLI_FORMAT_LOCAL => 'Local'
+                    }.freeze
+
+      # Configuration types
+      CONF_TYPE_SIP     = 'sip_configurations'
+      CONF_TYPE_H323    = 'h323_configurations'
+      CONF_TYPE_IAX2    = 'iax2_configurations'
+      CONF_TYPE_PSTN    = 'pstn_configurations'
+
+      CONF_TYPES = {
+                     CONF_TYPE_SIP   => 'SIP',
+                     CONF_TYPE_H323  => 'H323',
+                     CONF_TYPE_IAX2  => 'IAX2',
+                     CONF_TYPE_PSTN  => 'PSTN'
+                   }.freeze
+
+      CONF_TYPE_CLASSES = {
+                            CONF_TYPE_SIP   => DIDWW::ComplexObject::SipConfiguration,
+                            CONF_TYPE_H323  => DIDWW::ComplexObject::H323Configuration,
+                            CONF_TYPE_IAX2  => DIDWW::ComplexObject::Iax2Configuration,
+                            CONF_TYPE_PSTN  => DIDWW::ComplexObject::PstnConfiguration
+                          }.freeze
 
       has_one :pop
-      has_one :trunk_group
+      has_one :voice_in_trunk_group
 
       property :priority, type: :integer
       # Type: Integer
@@ -62,6 +91,13 @@ module DIDWW
         attribute_will_change!(:configuration) if configuration
       end
 
+      def cli_format_human
+        CLI_FORMATS[cli_format]
+      end
+
+      def configuration_type_human
+        CONF_TYPES[configuration.type] if configuration
+      end
     end
   end
 end

data/lib/didww/{resources/trunk_group.rb → resource/voice_in_trunk_group.rb}

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
-    class TrunkGroup < Base
-      has_many :trunks
+    class VoiceInTrunkGroup < Base
+      has_many :voice_in_trunks
 
       property :name, type: :string
       # Type: String

data/lib/didww/resource/voice_out_trunk.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'didww/callback/const'
+
+module DIDWW
+  module Resource
+    class VoiceOutTrunk < Base
+      include DIDWW::Callback::CONST
+
+      ON_CLI_MISMATCH_ACTION_REJECT_CALL = 'Reject call'
+      ON_CLI_MISMATCH_ACTION_REPLACE_CLI = 'Replace CLI'
+      ON_CLI_MISMATCH_ACTION_SEND_ORIGINAL_CLI = 'Send Original CLI'
+
+      ON_CLI_MISMATCH_ACTIONS = [
+                                  ON_CLI_MISMATCH_ACTION_REJECT_CALL,
+                                  ON_CLI_MISMATCH_ACTION_REPLACE_CLI,
+                                  ON_CLI_MISMATCH_ACTION_SEND_ORIGINAL_CLI
+                                ].freeze
+
+      DEFAULT_DST_ACTION_ALLOW_CALLS = 'Allow Calls'
+      DEFAULT_DST_ACTION_REJECT_CALLS = 'Reject Calls'
+
+      DEFAULT_DST_ACTIONS = [
+                              DEFAULT_DST_ACTION_ALLOW_CALLS,
+                              DEFAULT_DST_ACTION_REJECT_CALLS
+                            ].freeze
+
+      STATUS_ACTIVE = 'Active'
+      STATUS_BLOCKED = 'Blocked'
+
+      STATUSES = [
+                   STATUS_ACTIVE,
+                   STATUS_BLOCKED
+                 ].freeze
+
+      MEDIA_ENCRYPTION_MODE_DISABLE = 'Disable'
+      MEDIA_ENCRYPTION_MODE_SRTP_SDES = 'SRTP SDES'
+      MEDIA_ENCRYPTION_MODE_SRTP_DTLS = 'SRTP DTLS'
+      MEDIA_ENCRYPTION_MODE_ZRTP = 'ZRTP'
+
+      MEDIA_ENCRYPTION_MODES = [
+                                 MEDIA_ENCRYPTION_MODE_DISABLE,
+                                 MEDIA_ENCRYPTION_MODE_SRTP_SDES,
+                                 MEDIA_ENCRYPTION_MODE_SRTP_DTLS,
+                                 MEDIA_ENCRYPTION_MODE_ZRTP
+                               ].freeze
+
+      property :name, type: :string
+      property :allowed_sip_ips, type: :ip_addresses
+      property :on_cli_mismatch_action, type: :string
+      property :capacity_limit, type: :integer
+      property :username, type: :string
+      property :password, type: :string
+      property :created_at, type: :time
+      property :allow_any_did_as_cli, type: :boolean
+      property :status, type: :string
+      property :threshold_reached, type: :boolean
+      property :threshold_amount, type: :decimal
+      property :default_dst_action, type: :string
+      property :dst_prefixes, type: :strings
+      property :media_encryption_mode, type: :string
+      property :callback_url, type: :string
+      property :force_symmetric_rtp, type: :boolean
+      property :allowed_rtp_ips, type: :ip_addresses
+
+      has_many :dids
+
+      def regenerate_credentials
+        resource = DIDWW::Resource::VoiceOutTrunkRegenerateCredential.new
+        resource.relationships[:voice_out_trunk] = self
+        resource.save
+      end
+    end
+  end
+end

data/lib/didww/resource/voice_out_trunk_regenerate_credential.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'didww/callback/const'
+
+module DIDWW
+  module Resource
+    class VoiceOutTrunkRegenerateCredential < Base
+      has_one :voice_out_trunk
+    end
+  end
+end

data/lib/didww/types/ip_addresses.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DIDWW
+  module Types
+    module IpAddresses
+      module_function
+
+      def cast(values, default)
+        return default unless values.is_a?(Array)
+
+        values.map do |value|
+          cast_item(value)
+        end
+      rescue IPAddr::Error
+        default
+      end
+
+      def cast_item(value)
+        value.is_a?(IPAddr) ? value : IPAddr.new(value)
+      end
+    end
+  end
+end

data/lib/didww/types/strings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DIDWW
+  module Types
+    module Strings
+      module_function
+
+      def cast(values, default)
+        return default unless values.is_a?(Array)
+
+        values.map do |value|
+          cast_item(value)
+        end
+      end
+
+      def cast_item(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/didww/types.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'json_api_client/schema'
+require 'didww/types/ip_addresses'
+require 'didww/types/strings'
+require 'didww/complex_objects/base'
+require 'didww/complex_objects/export_filters'
+
+JsonApiClient::Schema.register ip_addresses: DIDWW::Types::IpAddresses,
+                               strings: DIDWW::Types::Strings,
+                               complex_object: DIDWW::ComplexObject::Base,
+                               export_filters: DIDWW::ComplexObject::ExportFilters

data/lib/didww/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
-  VERSION = '1.3.1'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/lib/didww.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
 require 'didww/version'
 require 'didww/client'
-require 'didww/middleware'
+require 'didww/types'
+require 'didww/base_middleware'
+require 'didww/jsonapi_middleware'
+require 'didww/callback/request_validator'
+require 'didww/encrypt'