surge_api 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8012d35d6b7aaae2d18541e688d7605e1ee985153b70ebec72790ddb0ba3b28b
-  data.tar.gz: 7051be5e16f4e06b7eafac3c3b8b7554fc06710c5b6a0104e8f4dabe6ba8f448
+  metadata.gz: c36ef735ac45405fb4d5f91cfdd8c6993370f5e130a02aecf8421e4e1158c1e9
+  data.tar.gz: 3af2cc39257fa57acb0a2b42ae74ad17f1159b5e07c73478b98a759e4a02c070
 SHA512:
-  metadata.gz: 50cb8dd9f5162634bb262e93eda01ed24d9af0d8c0c45171d4642969e7824292cea2465ef00d199a85e62e0ad7a38288ed082c44f7a529210c13802e0cfbcf77
-  data.tar.gz: 4b0d24f6c73cfb6b038ac5c9663cbf2c83917770eff0f3d0d36fe9006cfc2adf80892f9c65b693380f3f9e671362af3e2ef93a1cb5743dc3d39e935d57ed12ed
+  metadata.gz: e87b415e0cdb6e142d8e5f438767c715f0ff455a94ca80e6eaf88631f0aefbd91c60eb87e56c18758d6b0bcdd07170d46bae507eb8d4fb71c6118a7f84677973
+  data.tar.gz: 46a8c93de7a473bd99a31ad51cd736312afafdb1a28c2319bdab231c2a96bcd17a748eb484a347d51249ad6f938aaf080720c37ca2fef7af755dc5ecece64ead

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.13.0 (2026-03-24)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/surgeapi/ruby-sdk/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** get and list recordings endpoints ([5c70f53](https://github.com/surgeapi/ruby-sdk/commit/5c70f532acc1a8eea9a2122e8f126f46b4e57d0a))
+* **api:** list users endpoint ([660a12d](https://github.com/surgeapi/ruby-sdk/commit/660a12d464f024ad86cd4c9fd4af250937ac8205))
+
 ## 0.12.0 (2026-03-11)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/surgeapi/ruby-sdk/compare/v0.11.0...v0.12.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.12.0"
+gem "surge_api", "~> 0.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/recording_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#list
+    class RecordingListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for backward pagination. Use the previous_cursor from a previous
+      #   response.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!method initialize(after: nil, before: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::RecordingListParams} for more details.
+      #
+      #   @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/recording_list_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#list
+    class RecordingListResponse < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the recording
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute call
+      #   The call that produced this recording
+      #
+      #   @return [SurgeAPI::Models::RecordingListResponse::Call]
+      required :call, -> { SurgeAPI::Models::RecordingListResponse::Call }
+
+      # @!attribute duration
+      #   The duration of the recording in seconds
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!method initialize(id:, call:, duration:)
+      #   A call recording
+      #
+      #   @param id [String] The unique identifier for the recording
+      #
+      #   @param call [SurgeAPI::Models::RecordingListResponse::Call] The call that produced this recording
+      #
+      #   @param duration [Integer] The duration of the recording in seconds
+
+      # @see SurgeAPI::Models::RecordingListResponse#call
+      class Call < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the call
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute contact
+        #   A contact who has consented to receive messages
+        #
+        #   @return [SurgeAPI::Models::Contact]
+        required :contact, -> { SurgeAPI::Contact }
+
+        # @!attribute duration
+        #   The duration of the call in seconds
+        #
+        #   @return [Integer]
+        required :duration, Integer
+
+        # @!attribute initiated_at
+        #   When the call was initiated
+        #
+        #   @return [Time]
+        required :initiated_at, Time
+
+        # @!attribute status
+        #   The status of the call
+        #
+        #   @return [Symbol, SurgeAPI::Models::RecordingListResponse::Call::Status]
+        required :status, enum: -> { SurgeAPI::Models::RecordingListResponse::Call::Status }
+
+        # @!method initialize(id:, contact:, duration:, initiated_at:, status:)
+        #   The call that produced this recording
+        #
+        #   @param id [String] The unique identifier for the call
+        #
+        #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+        #
+        #   @param duration [Integer] The duration of the call in seconds
+        #
+        #   @param initiated_at [Time] When the call was initiated
+        #
+        #   @param status [Symbol, SurgeAPI::Models::RecordingListResponse::Call::Status] The status of the call
+
+        # The status of the call
+        #
+        # @see SurgeAPI::Models::RecordingListResponse::Call#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          BUSY = :busy
+          CANCELED = :canceled
+          COMPLETED = :completed
+          FAILED = :failed
+          IN_PROGRESS = :in_progress
+          MISSED = :missed
+          NO_ANSWER = :no_answer
+          QUEUED = :queued
+          RINGING = :ringing
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/recording_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#retrieve
+    class RecordingRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/recording_retrieve_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#retrieve
+    class RecordingRetrieveResponse < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the recording
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute call
+      #   The call that produced this recording
+      #
+      #   @return [SurgeAPI::Models::RecordingRetrieveResponse::Call]
+      required :call, -> { SurgeAPI::Models::RecordingRetrieveResponse::Call }
+
+      # @!attribute duration
+      #   The duration of the recording in seconds
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!method initialize(id:, call:, duration:)
+      #   A call recording
+      #
+      #   @param id [String] The unique identifier for the recording
+      #
+      #   @param call [SurgeAPI::Models::RecordingRetrieveResponse::Call] The call that produced this recording
+      #
+      #   @param duration [Integer] The duration of the recording in seconds
+
+      # @see SurgeAPI::Models::RecordingRetrieveResponse#call
+      class Call < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the call
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute contact
+        #   A contact who has consented to receive messages
+        #
+        #   @return [SurgeAPI::Models::Contact]
+        required :contact, -> { SurgeAPI::Contact }
+
+        # @!attribute duration
+        #   The duration of the call in seconds
+        #
+        #   @return [Integer]
+        required :duration, Integer
+
+        # @!attribute initiated_at
+        #   When the call was initiated
+        #
+        #   @return [Time]
+        required :initiated_at, Time
+
+        # @!attribute status
+        #   The status of the call
+        #
+        #   @return [Symbol, SurgeAPI::Models::RecordingRetrieveResponse::Call::Status]
+        required :status, enum: -> { SurgeAPI::Models::RecordingRetrieveResponse::Call::Status }
+
+        # @!method initialize(id:, contact:, duration:, initiated_at:, status:)
+        #   The call that produced this recording
+        #
+        #   @param id [String] The unique identifier for the call
+        #
+        #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+        #
+        #   @param duration [Integer] The duration of the call in seconds
+        #
+        #   @param initiated_at [Time] When the call was initiated
+        #
+        #   @param status [Symbol, SurgeAPI::Models::RecordingRetrieveResponse::Call::Status] The status of the call
+
+        # The status of the call
+        #
+        # @see SurgeAPI::Models::RecordingRetrieveResponse::Call#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          BUSY = :busy
+          CANCELED = :canceled
+          COMPLETED = :completed
+          FAILED = :failed
+          IN_PROGRESS = :in_progress
+          MISSED = :missed
+          NO_ANSWER = :no_answer
+          QUEUED = :queued
+          RINGING = :ringing
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/user_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Users#list
+    class UserListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for backward pagination. Use the previous_cursor from a previous
+      #   response.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!method initialize(after: nil, before: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::UserListParams} for more details.
+      #
+      #   @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -123,6 +123,10 @@ module SurgeAPI
 
   RecordingGetFileParams = SurgeAPI::Models::RecordingGetFileParams
 
+  RecordingListParams = SurgeAPI::Models::RecordingListParams
+
+  RecordingRetrieveParams = SurgeAPI::Models::RecordingRetrieveParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User
@@ -133,6 +137,8 @@ module SurgeAPI
 
   UserDeleteParams = SurgeAPI::Models::UserDeleteParams
 
+  UserListParams = SurgeAPI::Models::UserListParams
+
   UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
 
   UserTokenResponse = SurgeAPI::Models::UserTokenResponse

data/lib/surge_api/resources/recordings.rb

@@ -3,6 +3,57 @@
 module SurgeAPI
   module Resources
     class Recordings
+      # Retrieves a Recording object.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the recording to retrieve.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::RecordingRetrieveResponse]
+      #
+      # @see SurgeAPI::Models::RecordingRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["recordings/%1$s", id],
+          model: SurgeAPI::Models::RecordingRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::RecordingListParams} for more details.
+      #
+      # List all recordings for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list recordings for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::RecordingListResponse>]
+      #
+      # @see SurgeAPI::Models::RecordingListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::RecordingListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/recordings", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Models::RecordingListResponse,
+          options: options
+        )
+      end
+
       # Deletes a recording. The recording file will be removed from storage
       # asynchronously.
       #

data/lib/surge_api/resources/users.rb

@@ -83,6 +83,37 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::UserListParams} for more details.
+      #
+      # List all users for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list users for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::User>]
+      #
+      # @see SurgeAPI::Models::UserListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::UserListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/users", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::User,
+          options: options
+        )
+      end
+
       # Deletes a user.
       #
       # Once a user has been deleted, they will no longer be permitted to access any of

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/surge_api.rb

@@ -97,11 +97,16 @@ require_relative "surge_api/models/recording_delete_params"
 require_relative "surge_api/models/recording_delete_response"
 require_relative "surge_api/models/recording_get_file_params"
 require_relative "surge_api/models/recording_get_file_response"
+require_relative "surge_api/models/recording_list_params"
+require_relative "surge_api/models/recording_list_response"
+require_relative "surge_api/models/recording_retrieve_params"
+require_relative "surge_api/models/recording_retrieve_response"
 require_relative "surge_api/models/unwrap_webhook_event"
 require_relative "surge_api/models/user"
 require_relative "surge_api/models/user_create_params"
 require_relative "surge_api/models/user_create_token_params"
 require_relative "surge_api/models/user_delete_params"
+require_relative "surge_api/models/user_list_params"
 require_relative "surge_api/models/user_retrieve_params"
 require_relative "surge_api/models/user_token_response"
 require_relative "surge_api/models/user_update_params"

data/rbi/surge_api/models/recording_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::RecordingListParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Cursor for forward pagination. Use the next_cursor from a previous response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for backward pagination. Use the previous_cursor from a previous
+      # response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for forward pagination. Use the next_cursor from a previous response.
+        after: nil,
+        # Cursor for backward pagination. Use the previous_cursor from a previous
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end