didww-v3 1.2.0 → 3.0.0

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Did < Base
-      has_one :trunk
-      has_one :trunk_group
+      has_one :voice_in_trunk
+      has_one :voice_in_trunk_group
+      has_one :capacity_pool
+      has_one :shared_capacity_group
+      has_one :address_verification
 
       property :blocked, type: :boolean
       # Type: Boolean
@@ -16,7 +20,7 @@ module DIDWW
       # Type: Boolean
       # Description: Identifier for terminated DIDs that will be removed from service at the end of the billing cycle.
 
-      property :pending_removal, type: :boolean
+      property :billing_cycles_count, type: :integer
       # Type: Boolean
       # Description: Identifier for DIDs that are pending removal from your account.
 
@@ -36,6 +40,10 @@ module DIDWW
       # Type: Integer
       # Description: The number of channels included with this DID.
 
+      property :dedicated_channels_count, type: :integer
+      # Type: Integer
+      # Description: The number of channels included with this DID.
+
       property :expires_at, type: :time
       # Type: DateTime
       # Description: DateTime when the DID expired or will expire. DateTime is in the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", where "SSS" are milliseconds and 'Z' denotes Zulu time (UTC).

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

@@ -1,23 +1,16 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class DidGroup < Base
-      module CONST
-        # Possible values for did_group.features array
-        FEATURE_VOICE    = 'voice'                           .freeze
-        FEATURE_T38      = 't38'                             .freeze
-        FEATURE_SMS      = 'sms'                             .freeze
-        FEATURES = {
-          FEATURE_VOICE => 'Voice'                           .freeze,
-          FEATURE_T38   => 'T.38 Fax'                        .freeze,
-          FEATURE_SMS   => 'SMS'                             .freeze
-        }.freeze
-
-        def features_human
-          Array.wrap(features).map { |f| FEATURES[f] }
-        end
-      end
-
-      include CONST
+      # Possible values for did_group.features array
+      FEATURE_VOICE    = 'voice'                           .freeze
+      FEATURE_T38      = 't38'                             .freeze
+      FEATURE_SMS      = 'sms'                             .freeze
+      FEATURES = {
+                   FEATURE_VOICE => 'Voice'                           .freeze,
+                   FEATURE_T38   => 'T.38 Fax'                        .freeze,
+                   FEATURE_SMS   => 'SMS'                             .freeze
+                 }.freeze
 
       has_one :country, class: Country
       has_one :city,    class: City
@@ -60,11 +53,10 @@ module DIDWW
       # is_available
       # Type: Boolean
       # Description: Defines if numbers in this DID Group are currently in stock.
-      #
-      # restrictions
-      # Type: String
-      # Description: Describes possible restrictions for the DID Group, such as "End User Registration is Required".
 
+      def features_human
+        Array.wrap(features).map { |f| FEATURES[f] }
+      end
     end
   end
 end

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

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

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

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

data/lib/didww/resource/encrypted_file.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class EncryptedFile < Base
+      class UploadError < StandardError
+      end
+
+      property :description, type: :string
+      # Type: String
+      # Description:
+
+      property :expire_at, type: :date
+      # Type: Date
+      # Description:
+
+      # @return [Faraday::Connection]
+      def self.upload_connection
+        Faraday.new(url: site) do |connection|
+          connection.request :multipart
+          connection.request :url_encoded
+          connection.adapter Faraday.default_adapter
+          connection.use DIDWW::BaseMiddleware
+        end
+      end
+
+      # @param files [Rack::Multipart::UploadedFile,(#tempfile,#content_type,#original_filename)]
+      # @return [Array<String>]
+      # @raise [DIDWW::Resource::EncryptedFile::UploadError]
+      def self.upload_files(files, fingerprint)
+        items = files.map do |file|
+          {
+            file: Faraday::UploadIO.new(file.tempfile, file.content_type),
+            description: file.original_filename
+          }
+        end
+        payload = { encryption_fingerprint: fingerprint, items: items }
+        upload(payload)
+      end
+
+      # @param payload [Hash]
+      #   encryption_fingerprint [String] DIDWW::Encrypt#encryption_fingerprint
+      #   items [Array]
+      #     file [Faraday::UploadIO] upload io
+      #     description [String,nil] optional description
+      # @return [Array<String>]
+      # @raise [DIDWW::Resource::EncryptedFile::UploadError]
+      def self.upload(payload)
+        connection = upload_connection
+        response = connection.post('/v3/encrypted_files', encrypted_files: payload)
+        if response.status == 201
+          JSON.parse(response.body, symbolize_names: true)[:ids]
+        else
+          raise UploadError, "Code: #{response.status} #{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/didww/{resources/cdr_export.rb → resource/export.rb}

@@ -1,13 +1,24 @@
+# frozen_string_literal: true
 require 'forwardable'
-require 'didww/complex_objects/cdr_export_filter'
 require 'down/http'
+require 'didww/callback/const'
 
 module DIDWW
   module Resource
-    class CdrExport < Base
+    class Export < Base
+      include DIDWW::Callback::CONST
       extend Forwardable
 
-      property :filters, type: :cdr_export_filter
+      STATUS_COMPLETED = 'Completed'
+
+      EXPORT_TYPE_CDR_IN = 'cdr_in'
+      EXPORT_TYPE_CDR_OUT = 'cdr_out'
+      EXPORT_TYPES = [
+        EXPORT_TYPE_CDR_IN,
+        EXPORT_TYPE_CDR_OUT
+      ].freeze
+
+      property :filters, type: :export_filters
       # Type: CDR Export Filters Object
       # Nullable: No
       # Description: Filters
@@ -27,7 +38,15 @@ module DIDWW
       # Nullable: true
       # Description: url of csv file for downloading. available only when status is "Completed"
 
-      def_delegators :filters, :year, :month, :did_number, :year=, :month=, :did_number=
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
+      property :export_type, type: :string
 
       def initialize(params = {})
         super params.reverse_merge(filters: {})
@@ -39,7 +58,7 @@ module DIDWW
       end
 
       def complete?
-        status == 'Completed'
+        status == STATUS_COMPLETED
       end
       alias_method :completed?, :complete?
     end

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/{resources → resource}/order.rb

@@ -1,21 +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
@@ -45,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/resource/qty_based_pricing.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class QtyBasedPricing < Base
+      belongs_to :capacity_pool
+
+      property :qty, type: :integer
+      # Type: Integer
+      # Description: A treshold starting at which provided prices per channel apply
+
+      property :setup_price, type: :decimal
+      # Type: String
+      # Description: Non-recurring price per channel
+
+      property :monthly_price, type: :decimal
+      # Type: String
+      # Description: Monthly recurring price per channel
+    end
+  end
+end

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/resource/shared_capacity_group.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class SharedCapacityGroup < Base
+      has_one :capacity_pool, class: 'CapacityPool'
+
+      has_many :dids, class: 'Did'
+
+      property :name, type: :string
+      # Type: String
+      # Description: Shared capacity group name
+
+      property :shared_channels_count, type: :integer
+      # Type: Integer
+      # Description: Channels count assigned to this Group and shared among its DIDs
+
+      property :metered_channels_count, type: :integer
+      # Type: Integer
+      # Description: Maximum amount of Metered channels used by this Group DIDs
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: Shared capacity group created at DateTime
+
+    end
+  end
+end

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