voicetel 2.2.10 → 2.2.14

data/lib/voicetel/resources/numbers.rb

@@ -12,108 +12,201 @@ module VoiceTel
     # DELETE /v2.2/numbers/messaging-campaign — return 200 with a body and
     # are exposed via #unassign_campaign and #bulk_unassign_campaign.
     class Numbers < Base
+      # GET /v2.2/numbers — every TN on the account.
+      #
+      # @return [Models::NumbersListData]
       def list
-        @transport.request(:get, "/v2.2/numbers")
+        Models::NumbersListData.build(@transport.request(:get, "/v2.2/numbers"))
       end
 
+      # POST /v2.2/numbers — attach a TN to the account.
+      #
+      # @return [Models::NumberAddData]
       def add(body)
-        @transport.request(:post, "/v2.2/numbers", body: body)
+        Models::NumberAddData.build(@transport.request(:post, "/v2.2/numbers", body: payload(body)))
       end
 
+      # GET /v2.2/numbers/{number} — routing/feature state for one TN.
+      #
+      # @return [Models::NumberDetail]
       def get(number)
-        @transport.request(:get, "/v2.2/numbers/#{number}")
+        Models::NumberDetail.build(@transport.request(:get, "/v2.2/numbers/#{number}"))
       end
 
-      # Returns nil on 204 No Content.
+      # DELETE /v2.2/numbers/{number}. Returns nil on 204 No Content.
       def remove(number)
         @transport.request(:delete, "/v2.2/numbers/#{number}")
       end
 
       # PATCH /v2.2/numbers/{number} — move a TN to another account.
+      #
+      # @return [Models::NumberMoveData]
       def move(number, body)
-        @transport.request(:patch, "/v2.2/numbers/#{number}", body: body)
+        Models::NumberMoveData.build(@transport.request(:patch, "/v2.2/numbers/#{number}", body: payload(body)))
       end
 
-      # POST /v2.2/numbers/{number}/release — release a TN back to the network.
+      # POST /v2.2/numbers/{number}/release — release a TN back to the
+      # network. Returns nil on 204 No Content.
       def release(number)
         @transport.request(:post, "/v2.2/numbers/#{number}/release")
       end
 
+      # PUT /v2.2/numbers/{number}/route.
+      #
+      # @return [Models::NumberRouteData]
       def set_route(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/route", body: body)
+        Models::NumberRouteData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/route", body: payload(body))
+        )
       end
 
+      # PUT /v2.2/numbers/{number}/translation.
+      #
+      # @return [Models::NumberTranslationData]
       def set_translation(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/translation", body: body)
+        Models::NumberTranslationData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/translation", body: payload(body))
+        )
       end
 
+      # PUT /v2.2/numbers/{number}/cnam — inbound CNAM toggle.
+      #
+      # @return [Models::NumberCnamData]
       def set_cnam(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/cnam", body: body)
+        Models::NumberCnamData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/cnam", body: payload(body))
+        )
       end
 
+      # PUT /v2.2/numbers/{number}/lidb — outbound caller name.
+      #
+      # @return [Models::NumberLidbData]
       def set_lidb(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/lidb", body: body)
+        Models::NumberLidbData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/lidb", body: payload(body))
+        )
       end
 
+      # GET /v2.2/numbers/{number}/fax.
+      #
+      # @return [Models::NumberFaxData]
       def get_fax(number)
-        @transport.request(:get, "/v2.2/numbers/#{number}/fax")
+        Models::NumberFaxData.build(@transport.request(:get, "/v2.2/numbers/#{number}/fax"))
       end
 
+      # PUT /v2.2/numbers/{number}/fax.
+      #
+      # @return [Models::NumberFaxData]
       def set_fax(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/fax", body: body)
+        Models::NumberFaxData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/fax", body: payload(body))
+        )
       end
 
-      # Returns nil on 204 No Content.
+      # DELETE /v2.2/numbers/{number}/fax. Returns nil on 204 No Content.
       def remove_fax(number)
         @transport.request(:delete, "/v2.2/numbers/#{number}/fax")
       end
 
+      # PUT /v2.2/numbers/{number}/forward.
+      #
+      # @return [Models::NumberForwardData]
       def set_forward(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/forward", body: body)
+        Models::NumberForwardData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/forward", body: payload(body))
+        )
       end
 
-      # Returns nil on 204 No Content.
+      # DELETE /v2.2/numbers/{number}/forward. Returns nil on 204 No Content.
       def remove_forward(number)
         @transport.request(:delete, "/v2.2/numbers/#{number}/forward")
       end
 
+      # GET /v2.2/numbers/{number}/sms.
+      #
+      # @return [Models::NumberSmsData]
       def get_sms(number)
-        @transport.request(:get, "/v2.2/numbers/#{number}/sms")
+        Models::NumberSmsData.build(@transport.request(:get, "/v2.2/numbers/#{number}/sms"))
       end
 
+      # PUT /v2.2/numbers/{number}/sms.
+      #
+      # @return [Models::NumberSmsData]
       def set_sms(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/sms", body: body)
+        Models::NumberSmsData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/sms", body: payload(body))
+        )
       end
 
-      # Returns nil on 204 No Content.
+      # DELETE /v2.2/numbers/{number}/sms. Returns nil on 204 No Content.
       def remove_sms(number)
         @transport.request(:delete, "/v2.2/numbers/#{number}/sms")
       end
 
+      # GET /v2.2/numbers/{number}/messaging — current messaging routing
+      # state, including an async path-C enablement job in `pending` while
+      # one is in flight.
+      #
+      # @return [Models::NumberMessagingState]
       def get_messaging(number)
-        @transport.request(:get, "/v2.2/numbers/#{number}/messaging")
+        Models::NumberMessagingState.build(@transport.request(:get, "/v2.2/numbers/#{number}/messaging"))
       end
 
+      # PATCH /v2.2/numbers/{number}/messaging — update inbound and/or
+      # outbound routing.
+      #
+      # @return [Models::NumberMessagingPatchData]
       def patch_messaging(number, body)
-        @transport.request(:patch, "/v2.2/numbers/#{number}/messaging", body: body)
-      end
-
+        Models::NumberMessagingPatchData.build(
+          @transport.request(:patch, "/v2.2/numbers/#{number}/messaging", body: payload(body))
+        )
+      end
+
+      # PUT /v2.2/numbers/{number}/messaging-campaign — bind a number to a
+      # 10DLC campaign. The campaign must be available to the account and
+      # ACTIVE; the number is enabled on the messaging path the campaign
+      # lives on. Idempotent: a number already bound to the campaign reports
+      # status "already". Path-B assignments complete synchronously (status
+      # "enabled"); path-C assignments are provisioned asynchronously
+      # (status "pending" — poll #get_messaging until pending.state is
+      # "done" or "failed").
+      #
+      # @return [Models::NumberMessagingCampaignAssignData]
       def assign_campaign(number, body)
-        @transport.request(:put, "/v2.2/numbers/#{number}/messaging-campaign", body: body)
+        Models::NumberMessagingCampaignAssignData.build(
+          @transport.request(:put, "/v2.2/numbers/#{number}/messaging-campaign", body: payload(body))
+        )
       end
 
-      # Returns response data (200 with body, not 204).
+      # DELETE /v2.2/numbers/{number}/messaging-campaign — returns 200 with
+      # a body, not 204.
+      #
+      # @return [Models::NumberMessagingCampaignUnassignData]
       def unassign_campaign(number)
-        @transport.request(:delete, "/v2.2/numbers/#{number}/messaging-campaign")
+        Models::NumberMessagingCampaignUnassignData.build(
+          @transport.request(:delete, "/v2.2/numbers/#{number}/messaging-campaign")
+        )
       end
 
-      # Returns response data (200 with body, not 204).
+      # DELETE /v2.2/numbers/messaging-campaign — bulk unassign; returns 200
+      # with a body, not 204.
+      #
+      # @return [Models::NumbersMessagingCampaignUnassignData]
       def bulk_unassign_campaign(numbers)
-        @transport.request(:delete, "/v2.2/numbers/messaging-campaign", body: { numbers: numbers })
+        Models::NumbersMessagingCampaignUnassignData.build(
+          @transport.request(:delete, "/v2.2/numbers/messaging-campaign", body: { numbers: numbers })
+        )
       end
 
+      # PATCH /v2.2/numbers/{number}/port-out-pin — set the port-out PIN.
+      # Idempotent: a PIN already on file is locked for 30 days and returned
+      # unchanged with changed=false.
+      #
+      # @return [Models::PortOutPinUpdateData]
       def set_port_out_pin(number, body)
-        @transport.request(:patch, "/v2.2/numbers/#{number}/port-out-pin", body: body)
+        Models::PortOutPinUpdateData.build(
+          @transport.request(:patch, "/v2.2/numbers/#{number}/port-out-pin", body: payload(body))
+        )
       end
     end
   end

data/lib/voicetel/resources/support.rb

@@ -6,37 +6,63 @@ module VoiceTel
   module Resources
     # SupportService — support tickets (create, read, update, delete, reply).
     #
-    # On the wire, SupportConversation.number is a ticket sequence integer
-    # (1015, 2114, ...), NOT a phone number. When the spec uses `number`
-    # in this context, that's the ticket id.
+    # On the wire, SupportConversation's `number` field is the ticket
+    # sequence integer (1015, 2114, ...), NOT a phone number; the model
+    # exposes it as Models::SupportConversation#ticket_number.
     class Support < Base
+      # GET /v2.2/support/tickets — every ticket on the account.
+      #
+      # @return [Models::TicketsListData]
       def list
-        @transport.request(:get, "/v2.2/support/tickets")
+        Models::TicketsListData.build(@transport.request(:get, "/v2.2/support/tickets"))
       end
 
+      # POST /v2.2/support/tickets — open a ticket.
+      #
+      # @return [Models::TicketData]
       def create(body)
-        @transport.request(:post, "/v2.2/support/tickets", body: body)
+        Models::TicketData.build(
+          @transport.request(:post, "/v2.2/support/tickets", body: payload(body))
+        )
       end
 
+      # GET /v2.2/support/tickets/{id} — one ticket.
+      #
+      # @return [Models::TicketData]
       def get(id)
-        @transport.request(:get, "/v2.2/support/tickets/#{id}")
+        Models::TicketData.build(@transport.request(:get, "/v2.2/support/tickets/#{id}"))
       end
 
+      # PUT /v2.2/support/tickets/{id} — update a ticket.
+      #
+      # @return [Models::TicketUpdateData]
       def update(id, body)
-        @transport.request(:put, "/v2.2/support/tickets/#{id}", body: body)
+        Models::TicketUpdateData.build(
+          @transport.request(:put, "/v2.2/support/tickets/#{id}", body: payload(body))
+        )
       end
 
-      # Returns nil on 204 No Content.
+      # DELETE /v2.2/support/tickets/{id}. Returns nil on 204 No Content.
       def delete(id)
         @transport.request(:delete, "/v2.2/support/tickets/#{id}")
       end
 
+      # GET /v2.2/support/tickets/{id}/messages — the ticket's threads.
+      #
+      # @return [Models::TicketThreadsData]
       def messages(id)
-        @transport.request(:get, "/v2.2/support/tickets/#{id}/messages")
+        Models::TicketThreadsData.build(
+          @transport.request(:get, "/v2.2/support/tickets/#{id}/messages")
+        )
       end
 
+      # POST /v2.2/support/tickets/{id}/replies — reply to a ticket.
+      #
+      # @return [Models::TicketReplyData]
       def reply(id, body)
-        @transport.request(:post, "/v2.2/support/tickets/#{id}/replies", body: body)
+        Models::TicketReplyData.build(
+          @transport.request(:post, "/v2.2/support/tickets/#{id}/replies", body: payload(body))
+        )
       end
     end
   end

data/lib/voicetel/version.rb

@@ -2,11 +2,11 @@
 
 module VoiceTel
   # The semantic version of the VoiceTel Ruby SDK. This tracks the API version
-  # it targets (currently v2.2.10).
-  VERSION = "2.2.10"
+  # it targets (currently v2.2.14).
+  VERSION = "2.2.14"
 
   # The VoiceTel REST API version this SDK targets.
-  API_VERSION = "v2.2.10"
+  API_VERSION = "v2.2.14"
 
   # Default production API endpoint.
   DEFAULT_BASE_URL = "https://api.voicetel.com"

data/lib/voicetel.rb

@@ -2,6 +2,7 @@
 
 require_relative "voicetel/version"
 require_relative "voicetel/api_error"
+require_relative "voicetel/models"
 require_relative "voicetel/internal/transport"
 require_relative "voicetel/resources/account"
 require_relative "voicetel/resources/acl"