telnyx 4.0.0 → 4.2.0

data/rbi/telnyx/models/legacy/reporting/filter.rbi

@@ -0,0 +1,252 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Legacy
+      module Reporting
+        class Filter < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Legacy::Reporting::Filter,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Billing group UUID to filter by
+          sig { returns(T.nilable(String)) }
+          attr_reader :billing_group
+
+          sig { params(billing_group: String).void }
+          attr_writer :billing_group
+
+          # Called line identification (destination number)
+          sig { returns(T.nilable(String)) }
+          attr_reader :cld
+
+          sig { params(cld: String).void }
+          attr_writer :cld
+
+          # Filter type for CLD matching
+          sig do
+            returns(
+              T.nilable(Telnyx::Legacy::Reporting::Filter::CldFilter::OrSymbol)
+            )
+          end
+          attr_reader :cld_filter
+
+          sig do
+            params(
+              cld_filter: Telnyx::Legacy::Reporting::Filter::CldFilter::OrSymbol
+            ).void
+          end
+          attr_writer :cld_filter
+
+          # Calling line identification (caller ID)
+          sig { returns(T.nilable(String)) }
+          attr_reader :cli
+
+          sig { params(cli: String).void }
+          attr_writer :cli
+
+          # Filter type for CLI matching
+          sig do
+            returns(
+              T.nilable(Telnyx::Legacy::Reporting::Filter::CliFilter::OrSymbol)
+            )
+          end
+          attr_reader :cli_filter
+
+          sig do
+            params(
+              cli_filter: Telnyx::Legacy::Reporting::Filter::CliFilter::OrSymbol
+            ).void
+          end
+          attr_writer :cli_filter
+
+          # Logical operator for combining filters
+          sig do
+            returns(
+              T.nilable(Telnyx::Legacy::Reporting::Filter::FilterType::OrSymbol)
+            )
+          end
+          attr_reader :filter_type
+
+          sig do
+            params(
+              filter_type:
+                Telnyx::Legacy::Reporting::Filter::FilterType::OrSymbol
+            ).void
+          end
+          attr_writer :filter_type
+
+          # Tag name to filter by
+          sig { returns(T.nilable(String)) }
+          attr_reader :tags_list
+
+          sig { params(tags_list: String).void }
+          attr_writer :tags_list
+
+          # Query filter criteria. Note: The first filter object must specify filter_type as
+          # 'and'. You cannot follow an 'or' with another 'and'.
+          sig do
+            params(
+              billing_group: String,
+              cld: String,
+              cld_filter:
+                Telnyx::Legacy::Reporting::Filter::CldFilter::OrSymbol,
+              cli: String,
+              cli_filter:
+                Telnyx::Legacy::Reporting::Filter::CliFilter::OrSymbol,
+              filter_type:
+                Telnyx::Legacy::Reporting::Filter::FilterType::OrSymbol,
+              tags_list: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Billing group UUID to filter by
+            billing_group: nil,
+            # Called line identification (destination number)
+            cld: nil,
+            # Filter type for CLD matching
+            cld_filter: nil,
+            # Calling line identification (caller ID)
+            cli: nil,
+            # Filter type for CLI matching
+            cli_filter: nil,
+            # Logical operator for combining filters
+            filter_type: nil,
+            # Tag name to filter by
+            tags_list: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                billing_group: String,
+                cld: String,
+                cld_filter:
+                  Telnyx::Legacy::Reporting::Filter::CldFilter::OrSymbol,
+                cli: String,
+                cli_filter:
+                  Telnyx::Legacy::Reporting::Filter::CliFilter::OrSymbol,
+                filter_type:
+                  Telnyx::Legacy::Reporting::Filter::FilterType::OrSymbol,
+                tags_list: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Filter type for CLD matching
+          module CldFilter
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::Legacy::Reporting::Filter::CldFilter)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONTAINS =
+              T.let(
+                :contains,
+                Telnyx::Legacy::Reporting::Filter::CldFilter::TaggedSymbol
+              )
+            STARTS_WITH =
+              T.let(
+                :starts_with,
+                Telnyx::Legacy::Reporting::Filter::CldFilter::TaggedSymbol
+              )
+            ENDS_WITH =
+              T.let(
+                :ends_with,
+                Telnyx::Legacy::Reporting::Filter::CldFilter::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Legacy::Reporting::Filter::CldFilter::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Filter type for CLI matching
+          module CliFilter
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::Legacy::Reporting::Filter::CliFilter)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONTAINS =
+              T.let(
+                :contains,
+                Telnyx::Legacy::Reporting::Filter::CliFilter::TaggedSymbol
+              )
+            STARTS_WITH =
+              T.let(
+                :starts_with,
+                Telnyx::Legacy::Reporting::Filter::CliFilter::TaggedSymbol
+              )
+            ENDS_WITH =
+              T.let(
+                :ends_with,
+                Telnyx::Legacy::Reporting::Filter::CliFilter::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Legacy::Reporting::Filter::CliFilter::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Logical operator for combining filters
+          module FilterType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::Legacy::Reporting::Filter::FilterType)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AND =
+              T.let(
+                :and,
+                Telnyx::Legacy::Reporting::Filter::FilterType::TaggedSymbol
+              )
+            OR =
+              T.let(
+                :or,
+                Telnyx::Legacy::Reporting::Filter::FilterType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Legacy::Reporting::Filter::FilterType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/legacy/reporting/usage_reports/cdr_usage_report_response_legacy.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Legacy
+      module Reporting
+        module UsageReports
+          class CdrUsageReportResponseLegacy < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Legacy::Reporting::UsageReports::CdrUsageReportResponseLegacy,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Identifies the resource
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+
+            sig { params(id: String).void }
+            attr_writer :id
+
+            # Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :aggregation_type
+
+            sig { params(aggregation_type: Integer).void }
+            attr_writer :aggregation_type
+
+            sig { returns(T.nilable(T::Array[Integer])) }
+            attr_reader :connections
+
+            sig { params(connections: T::Array[Integer]).void }
+            attr_writer :connections
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_at
+
+            sig { params(created_at: Time).void }
+            attr_writer :created_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :end_time
+
+            sig { params(end_time: Time).void }
+            attr_writer :end_time
+
+            # Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID
+            # vs Toll-free per Country = 3
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :product_breakdown
+
+            sig { params(product_breakdown: Integer).void }
+            attr_writer :product_breakdown
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :record_type
+
+            sig { params(record_type: String).void }
+            attr_writer :record_type
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :report_url
+
+            sig { params(report_url: String).void }
+            attr_writer :report_url
+
+            sig { returns(T.nilable(T.anything)) }
+            attr_reader :result
+
+            sig { params(result: T.anything).void }
+            attr_writer :result
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :start_time
+
+            sig { params(start_time: Time).void }
+            attr_writer :start_time
+
+            # Status of the report: Pending = 1, Complete = 2, Failed = 3, Expired = 4
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :status
+
+            sig { params(status: Integer).void }
+            attr_writer :status
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :updated_at
+
+            sig { params(updated_at: Time).void }
+            attr_writer :updated_at
+
+            # Legacy V2 CDR usage report response
+            sig do
+              params(
+                id: String,
+                aggregation_type: Integer,
+                connections: T::Array[Integer],
+                created_at: Time,
+                end_time: Time,
+                product_breakdown: Integer,
+                record_type: String,
+                report_url: String,
+                result: T.anything,
+                start_time: Time,
+                status: Integer,
+                updated_at: Time
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Identifies the resource
+              id: nil,
+              # Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3
+              aggregation_type: nil,
+              connections: nil,
+              created_at: nil,
+              end_time: nil,
+              # Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID
+              # vs Toll-free per Country = 3
+              product_breakdown: nil,
+              record_type: nil,
+              report_url: nil,
+              result: nil,
+              start_time: nil,
+              # Status of the report: Pending = 1, Complete = 2, Failed = 3, Expired = 4
+              status: nil,
+              updated_at: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  aggregation_type: Integer,
+                  connections: T::Array[Integer],
+                  created_at: Time,
+                  end_time: Time,
+                  product_breakdown: Integer,
+                  record_type: String,
+                  report_url: String,
+                  result: T.anything,
+                  start_time: Time,
+                  status: Integer,
+                  updated_at: Time
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/legacy/reporting/usage_reports/mdr_usage_report_response_legacy.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Legacy
+      module Reporting
+        module UsageReports
+          class MdrUsageReportResponseLegacy < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Identifies the resource
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+
+            sig { params(id: String).void }
+            attr_writer :id
+
+            # Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :aggregation_type
+
+            sig { params(aggregation_type: Integer).void }
+            attr_writer :aggregation_type
+
+            sig { returns(T.nilable(T::Array[Integer])) }
+            attr_reader :connections
+
+            sig { params(connections: T::Array[Integer]).void }
+            attr_writer :connections
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_at
+
+            sig { params(created_at: Time).void }
+            attr_writer :created_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :end_time
+
+            sig { params(end_time: Time).void }
+            attr_writer :end_time
+
+            # List of messaging profile IDs
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :profiles
+
+            sig { params(profiles: T::Array[String]).void }
+            attr_writer :profiles
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :record_type
+
+            sig { params(record_type: String).void }
+            attr_writer :record_type
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :report_url
+
+            sig { params(report_url: String).void }
+            attr_writer :report_url
+
+            sig { returns(T.nilable(T.anything)) }
+            attr_reader :result
+
+            sig { params(result: T.anything).void }
+            attr_writer :result
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :start_time
+
+            sig { params(start_time: Time).void }
+            attr_writer :start_time
+
+            # Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :status
+
+            sig { params(status: Integer).void }
+            attr_writer :status
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :updated_at
+
+            sig { params(updated_at: Time).void }
+            attr_writer :updated_at
+
+            # Legacy V2 MDR usage report response
+            sig do
+              params(
+                id: String,
+                aggregation_type: Integer,
+                connections: T::Array[Integer],
+                created_at: Time,
+                end_time: Time,
+                profiles: T::Array[String],
+                record_type: String,
+                report_url: String,
+                result: T.anything,
+                start_time: Time,
+                status: Integer,
+                updated_at: Time
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Identifies the resource
+              id: nil,
+              # Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
+              aggregation_type: nil,
+              connections: nil,
+              created_at: nil,
+              end_time: nil,
+              # List of messaging profile IDs
+              profiles: nil,
+              record_type: nil,
+              report_url: nil,
+              result: nil,
+              start_time: nil,
+              # Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
+              status: nil,
+              updated_at: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  aggregation_type: Integer,
+                  connections: T::Array[Integer],
+                  created_at: Time,
+                  end_time: Time,
+                  profiles: T::Array[String],
+                  record_type: String,
+                  report_url: String,
+                  result: T.anything,
+                  start_time: Time,
+                  status: Integer,
+                  updated_at: Time
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end