voicetel 2.2.10 → 2.2.14

data/lib/voicetel/models/i_numbering.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module VoiceTel
+  module Models
+    # ------------------------------------------------------------- requests ---
+    # Body for POST /v2.2/orders. numbers holds up to 100 entries — plain
+    # 10-digit strings or OrderNumberSpec objects for per-number routing.
+    OrderCreateRequest = Data.define(:numbers) do
+      include Request
+    end
+
+    # Per-number routing override inside OrderCreateRequest.
+    OrderNumberSpec = Data.define(:number, :route) do
+      include Request
+    end
+
+    # LIDB feature for a port-in TN.
+    PortFeatureLidb = Data.define(:name) do
+      include Request
+    end
+
+    # Routing feature for a port-in TN.
+    PortFeatureRouting = Data.define(:gateway_id) do
+      include Request
+    end
+
+    # SMS feature for a port-in TN.
+    PortFeatureSms = Data.define(:campaign_id) do
+      include Request
+    end
+
+    # Per-TN feature configuration applied after a port completes. routing,
+    # lidb, and sms may be the matching feature objects or plain hashes.
+    PortFeature = Data.define(:number, :routing, :lidb, :sms) do
+      include Request
+    end
+
+    # Body for POST /v2.2/ports — submit a port-in order.
+    PortSubmitRequest = Data.define(
+      :did, :name, :name_type, :lc_btn, :lc_account_number, :street_number, :street,
+      :street_type, :city, :state, :zip, :country, :auth_person, :street_prefix,
+      :street_suffix, :floor, :room, :building, :unit_value, :desired_due_date, :pin,
+      :features
+    ) do
+      include Request
+    end
+
+    # ------------------------------------------------- entities & data ---
+    # A single TN available for assignment.
+    InventoryItem = Data.define(:number, :rate_center, :city, :province, :lata) do
+      extend Base
+    end
+
+    # One aggregated availability bucket. Which members are populated
+    # depends on the countBy of the query.
+    InventoryCoverageItem = Data.define(
+      :count, :npa, :nxx, :block, :city, :rc_abbre, :lata, :loc_state
+    ) do
+      extend Base
+    end
+
+    # One row in the customer port-status list.
+    PortSummary = Data.define(:status, :id, :pid, :foc, :created_at, :message) do
+      extend Base
+    end
+
+    # Full detail for a single port-in record.
+    PortDetail = Data.define(
+      :status, :id, :pid, :name, :email, :foc, :created_at, :numbers, :message
+    ) do
+      extend Base
+    end
+
+    # ------------------------------------------------------ response data ---
+    # Data payload from GET /v2.2/inventory.
+    InventorySearchData = Data.define(:numbers) do
+      extend Base
+
+      def self.nested
+        { numbers: InventoryItem }
+      end
+    end
+
+    # Data payload from GET /v2.2/inventory/coverage.
+    InventoryCoverageData = Data.define(:coverage) do
+      extend Base
+
+      def self.nested
+        { coverage: InventoryCoverageItem }
+      end
+    end
+
+    # One row in OrderCreateData.failed.
+    OrderFailedEntry = Data.define(:number, :reason) do
+      extend Base
+    end
+
+    # Data payload from POST /v2.2/orders. amount_charged is the amount
+    # deducted from the account balance.
+    OrderCreateData = Data.define(:order_id, :amount_charged, :numbers_ordered, :failed) do
+      extend Base
+
+      def self.nested
+        { failed: OrderFailedEntry }
+      end
+    end
+
+    # Data payload from GET /v2.2/ports.
+    PortListData = Data.define(:ports) do
+      extend Base
+
+      def self.nested
+        { ports: PortSummary }
+      end
+    end
+
+    # Data payload from GET /v2.2/ports/{id}.
+    PortDetailData = Data.define(:port) do
+      extend Base
+
+      def self.nested
+        { port: PortDetail }
+      end
+    end
+
+    # Data payload from POST /v2.2/ports.
+    PortSubmitData = Data.define(:pid, :ticket, :message, :loa_url, :port_url) do
+      extend Base
+    end
+
+    # Data payload from GET /v2.2/ports/availability/{number}.
+    PortAvailabilityData = Data.define(
+      :number, :portable, :losing_carrier, :local_routing_number, :rate_center_tier, :reason
+    ) do
+      extend Base
+    end
+  end
+end

data/lib/voicetel/models/lookups.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module VoiceTel
+  module Models
+    # Data payload from GET /v2.2/cnam/{number}.
+    CnamData = Data.define(:cnam, :number) do
+      extend Base
+    end
+
+    # LRN dip result. Returned nested inside LrnLookupData for the full
+    # /v2.2/lrn/{n}/{ani} form.
+    LrnData = Data.define(
+      :lrn, :state, :city, :rc, :lata, :ocn, :lec, :lec_type, :jurisdiction, :local
+    ) do
+      extend Base
+    end
+
+    # Data payload from GET /v2.2/lrn/{number}/{ani}.
+    LrnLookupData = Data.define(:ani, :destination, :lrn) do
+      extend Base
+
+      def self.nested
+        { lrn: LrnData }
+      end
+    end
+  end
+end

data/lib/voicetel/models/messaging.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module VoiceTel
+  module Models
+    # ------------------------------------------------------------- requests ---
+    # Body for POST /v2.2/messages — send an SMS or MMS. media_urls switches
+    # the message type to MMS (and unlocks subject). Note the wire field
+    # names fromNumber / toNumber.
+    MessageSendRequest = Data.define(
+      :from_number, :to_number, :text, :subject, :media_urls
+    ) do
+      include Request
+    end
+
+    # Body for POST /v2.2/messaging/brands.
+    MessagingBrandCreateRequest = Data.define(
+      :messaging_brand_id, :messaging_brand_name, :messaging_brand_description
+    ) do
+      include Request
+    end
+
+    # Body for POST /v2.2/messaging/campaigns. Passed through to the
+    # campaign registration service; campaign_class_name (from the campaign
+    # registry) and campaign_start_date (today) are auto-populated if
+    # omitted.
+    MessagingCampaignCreateRequest = Data.define(
+      :messaging_brand_id, :external_campaign_id, :campaign_description,
+      :campaign_class_name, :campaign_start_date
+    ) do
+      include Request
+    end
+
+    # ------------------------------------------------------ response data ---
+    # Per-record fields inside MessageRecord. Shape varies by type:
+    # sms/mms populate source_number, destination_number, direction, rate,
+    # message; dlr populates source_number and destination_number only.
+    MessageRecordValue = Data.define(
+      :source_number, :destination_number, :direction, :rate, :number, :message
+    ) do
+      extend Base
+    end
+
+    # One row in MessageHistoryData.messages. key is a composite range key —
+    # for sms/mms [destinationNumber, timestamp]; for dlr
+    # [accountId, fromNumberWithCountryCode, timestamp] — with mixed types.
+    MessageRecord = Data.define(:id, :key, :value) do
+      extend Base
+
+      def self.nested
+        { value: MessageRecordValue }
+      end
+    end
+
+    # Data payload from GET /v2.2/messages.
+    MessageHistoryData = Data.define(:number, :type, :from_ts, :to_ts, :messages) do
+      extend Base
+
+      def self.nested
+        { messages: MessageRecord }
+      end
+    end
+
+    # Data payload from POST /v2.2/messages.
+    MessageSendData = Data.define(
+      :id, :type, :from_number, :to_number, :parts, :subject, :media_urls
+    ) do
+      extend Base
+    end
+
+    # Status payload for brand registration. status_code is the HTTP status
+    # as a string; "200" on success.
+    BrandRegistrationResult = Data.define(:status_code, :status) do
+      extend Base
+    end
+
+    # Data payload from POST /v2.2/messaging/brands.
+    MessagingBrandCreateData = Data.define(:result) do
+      extend Base
+
+      def self.nested
+        { result: BrandRegistrationResult }
+      end
+    end
+
+    # Status payload for campaign registration.
+    CampaignRegistrationResult = Data.define(:status_code, :status) do
+      extend Base
+    end
+
+    # Data payload from POST /v2.2/messaging/campaigns.
+    MessagingCampaignCreateData = Data.define(:result) do
+      extend Base
+
+      def self.nested
+        { result: CampaignRegistrationResult }
+      end
+    end
+
+    # One carrier's latest DCA decision in CampaignDca. status is one of
+    # ACTIVE, REJECTED, SUSPENDED, UNSUNSPENDED or TERMINATED; detail is the
+    # reviewer's note, as given.
+    CampaignDcaCarrier = Data.define(:carrier, :status, :detail, :updated_at) do
+      extend Base
+    end
+
+    # Carrier (DCA) review progress for a campaign. nil for
+    # CAMPAIGN_INVALID_ID statuses.
+    CampaignDca = Data.define(:election_complete, :elected_carriers, :carriers) do
+      extend Base
+
+      def self.nested
+        { carriers: CampaignDcaCarrier }
+      end
+    end
+
+    # A single campaign and its current numbers. status is one of
+    # CAMPAIGN_DCA_COMPLETE (ready: carrier review finished, numbers
+    # assigned), CAMPAIGN_DCA_COMPLETE_NO_NUMBERS_ASSIGNED,
+    # CAMPAIGN_PENDING_DCA (active at the campaign registry, but carrier
+    # (DCA) review is not finished yet; numbers cannot be enabled until it
+    # is), CAMPAIGN_DCA_REJECTED (a carrier's DCA rejected or suspended the
+    # campaign; see dca.carriers), CAMPAIGN_<registry status>, or
+    # CAMPAIGN_INVALID_ID.
+    CampaignStatusItem = Data.define(:id, :status, :numbers, :dca) do
+      extend Base
+
+      def self.nested
+        { dca: CampaignDca }
+      end
+    end
+
+    # Data payload from GET /v2.2/messaging/campaigns.
+    MessagingCampaignStatusData = Data.define(:campaigns) do
+      extend Base
+
+      def self.nested
+        { campaigns: CampaignStatusItem }
+      end
+    end
+  end
+end

data/lib/voicetel/models/numbers.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module VoiceTel
+  module Models
+    # ------------------------------------------------------------- requests ---
+    # Body for POST /v2.2/numbers.
+    NumberAddRequest = Data.define(:number, :route) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/route.
+    NumberRouteRequest = Data.define(:route) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/cnam — inbound CNAM toggle.
+    NumberCnamRequest = Data.define(:enabled) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/lidb — outbound caller name.
+    NumberLidbRequest = Data.define(:cnam, :customer_order_reference) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/fax.
+    NumberFaxRequest = Data.define(:email) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/forward.
+    NumberForwardRequest = Data.define(:destination) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/translation.
+    NumberTranslationRequest = Data.define(:translation) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/sms. type is "email", "webhook",
+    # or "sip"; resource is the matching destination.
+    NumberSmsRequest = Data.define(:type, :resource) do
+      include Request
+    end
+
+    # Body for PATCH /v2.2/numbers/{number}/messaging — update inbound
+    # and/or outbound routing. route_in must be a numbers_sms row id owned
+    # by the authenticated account, or 0 to detach. route_out is the
+    # outbound carrier id — 0 (outbound off) or the route the number is
+    # enabled on; to move a number to another campaign or messaging path
+    # use PUT /v2.2/numbers/{number}/messaging-campaign.
+    NumberMessagingPatchRequest = Data.define(:route_in, :route_out) do
+      include Request
+    end
+
+    # Body for PUT /v2.2/numbers/{number}/messaging-campaign.
+    NumberCampaignAssignRequest = Data.define(:campaign_id) do
+      include Request
+    end
+
+    # Body for PATCH /v2.2/numbers/{number} — move to another account.
+    NumberMoveRequest = Data.define(:account_id, :route) do
+      include Request
+    end
+
+    # Body for PATCH /v2.2/numbers/{number}/port-out-pin.
+    PortOutPinUpdateRequest = Data.define(:pin) do
+      include Request
+    end
+
+    # ------------------------------------------------- entities & data ---
+    # Per-number routing / feature state. Returned by GET /v2.2/numbers and
+    # GET /v2.2/numbers/{number}.
+    NumberDetail = Data.define(
+      :number, :translated, :route, :gateway, :cnam, :forward, :forward_to, :carrier,
+      :sms_enabled, :fax_enabled
+    ) do
+      extend Base
+    end
+
+    # The campaign bound to a number, with its CSP-side status.
+    CampaignBinding = Data.define(:id, :network, :status, :upstream_cnp_id) do
+      extend Base
+    end
+
+    # State of an asynchronous (path C) enablement. Attached to a campaign
+    # assignment (status "pending") or surfaced by
+    # GET /v2.2/numbers/{number}/messaging while provisioning is in flight.
+    # state is one of queued, hosting, assigning, routing, done, or failed
+    # (queued -> hosting -> assigning -> routing -> done, or failed — see
+    # message; the number keeps its previous routing until done).
+    MessagingEnablementJob = Data.define(
+      :campaign_id, :state, :message, :created_at, :updated_at
+    ) do
+      extend Base
+    end
+
+    # Current messaging routing state for one number.
+    #
+    # network — messaging path the number is currently on ("A", "B", or
+    # "C"); nil when carrier is 0 or any non-messaging carrier. pending —
+    # async path-C enablement in progress, nil when none.
+    NumberMessagingState = Data.define(
+      :number, :on_account, :enabled, :carrier, :route_in, :resource, :network, :campaign,
+      :pending
+    ) do
+      extend Base
+
+      def self.nested
+        { campaign: CampaignBinding, pending: MessagingEnablementJob }
+      end
+    end
+
+    # Data payload from POST /v2.2/numbers.
+    NumberAddData = Data.define(:number, :route) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/cnam.
+    NumberCnamData = Data.define(:number, :cnam) do
+      extend Base
+    end
+
+    # Data payload from GET/PUT /v2.2/numbers/{number}/fax.
+    NumberFaxData = Data.define(:number, :email) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/forward.
+    NumberForwardData = Data.define(:number, :forward_to) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/lidb.
+    NumberLidbData = Data.define(:number, :cnam, :customer_order_reference, :carrier_status) do
+      extend Base
+    end
+
+    # Data payload from PATCH /v2.2/numbers/{number}/messaging. updated is
+    # the subset of {routeIn, routeOut} the request changed.
+    NumberMessagingPatchData = Data.define(:number, :updated) do
+      extend Base
+    end
+
+    # Data payload from PATCH /v2.2/numbers/{number}.
+    NumberMoveData = Data.define(:number, :account_id, :route) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/route.
+    NumberRouteData = Data.define(:number, :route) do
+      extend Base
+    end
+
+    # Data payload from GET/PUT /v2.2/numbers/{number}/sms.
+    NumberSmsData = Data.define(:number, :type, :resource) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/translation.
+    NumberTranslationData = Data.define(:number, :translation) do
+      extend Base
+    end
+
+    # Data payload from PUT /v2.2/numbers/{number}/messaging-campaign —
+    # the result of binding a single number to a 10DLC campaign.
+    #
+    # status — "enabled" = bound now (path B); "already" = the number was
+    # already bound to this campaign (records reconciled, no new order);
+    # "pending" = accepted and being provisioned (path C) — poll
+    # GET /v2.2/numbers/{number}/messaging (pending) until state is done or
+    # failed.
+    #
+    # network — messaging path the campaign resolves to (from the CSP
+    # sharing record): "B" (assigned synchronously) or "C" (provisioned
+    # asynchronously, status "pending").
+    #
+    # upstream_cnp_id — CNP ID from the CSP sharing record: SB8TWLO = path
+    # B, BANDW = path C. (Campaigns on path A, SFL9UTQ, are being migrated
+    # and take no new numbers.)
+    #
+    # carrier — outbound carrier id the number routes through once enabled
+    # (19 = path B, 1 = path C). For a pending path-C enablement the number
+    # keeps its current routing until provisioning completes.
+    #
+    # already_assigned — true when the number was already bound to this
+    # campaign on the target messaging path; records are reconciled and no
+    # new network order is placed.
+    #
+    # order_id — network order id created for a path-B assignment. nil for
+    # path C (see job), idempotent no-ops, and assignments confirmed without
+    # a new order.
+    #
+    # previous_network — messaging path the number was bound to before this
+    # call ("A" or "B"), nil if there was no prior binding.
+    #
+    # warning — non-fatal condition detected during the assignment (for
+    # example a stale registration on the other messaging path whose removal
+    # has been requested).
+    #
+    # message — human-readable note for a pending enablement.
+    #
+    # job — async path-C enablement job, nil otherwise.
+    NumberMessagingCampaignAssignData = Data.define(
+      :number, :campaign_id, :status, :network, :upstream_cnp_id, :carrier,
+      :already_assigned, :order_id, :previous_network, :previous_network_cleared,
+      :warning, :message, :job
+    ) do
+      extend Base
+
+      def self.nested
+        { job: MessagingEnablementJob }
+      end
+    end
+
+    # Data payload from DELETE /v2.2/numbers/{number}/messaging-campaign.
+    NumberMessagingCampaignUnassignData = Data.define(
+      :number, :campaign_id, :network, :upstream_cnp_id, :unassigned
+    ) do
+      extend Base
+    end
+
+    # One row in the failure list returned by bulk unassign.
+    CampaignUnassignFailure = Data.define(:number, :reason) do
+      extend Base
+    end
+
+    # Data payload from DELETE /v2.2/numbers/messaging-campaign (bulk).
+    NumbersMessagingCampaignUnassignData = Data.define(
+      :campaign_id, :network, :upstream_cnp_id, :unassigned_numbers, :failed
+    ) do
+      extend Base
+
+      def self.nested
+        { failed: CampaignUnassignFailure }
+      end
+    end
+
+    # Data payload from GET /v2.2/numbers.
+    NumbersListData = Data.define(:numbers) do
+      extend Base
+
+      def self.nested
+        { numbers: NumberDetail }
+      end
+    end
+
+    # Data payload from GET /v2.2/numbers/messaging.
+    NumbersMessagingListData = Data.define(:numbers) do
+      extend Base
+
+      def self.nested
+        { numbers: NumberMessagingState }
+      end
+    end
+
+    # Data payload from PATCH /v2.2/numbers/{number}/port-out-pin.
+    #
+    # The call is idempotent: a PIN is locked for 30 days once set, so a
+    # number that already has one returns it unchanged with changed=false;
+    # both cases return HTTP 200.
+    #
+    # number — ten-digit telephone number whose PIN is reported.
+    # port_out_pin — the port-out PIN now on file for this number (the value
+    # just set, or the existing value if the number was already locked).
+    # changed — true if this request set the PIN; false if the number
+    # already had one, which is locked for 30 days once set and is returned
+    # unchanged.
+    PortOutPinUpdateData = Data.define(:number, :port_out_pin, :changed) do
+      extend Base
+    end
+  end
+end