telnyx 4.0.0 → 4.2.0

data/lib/telnyx/models/legacy/reporting/usage_reports/cdr_usage_report_response_legacy.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Legacy
+      module Reporting
+        module UsageReports
+          class CdrUsageReportResponseLegacy < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifies the resource
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute aggregation_type
+            #   Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3
+            #
+            #   @return [Integer, nil]
+            optional :aggregation_type, Integer
+
+            # @!attribute connections
+            #
+            #   @return [Array<Integer>, nil]
+            optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
+
+            # @!attribute created_at
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time
+
+            # @!attribute end_time
+            #
+            #   @return [Time, nil]
+            optional :end_time, Time
+
+            # @!attribute product_breakdown
+            #   Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID
+            #   vs Toll-free per Country = 3
+            #
+            #   @return [Integer, nil]
+            optional :product_breakdown, Integer
+
+            # @!attribute record_type
+            #
+            #   @return [String, nil]
+            optional :record_type, String
+
+            # @!attribute report_url
+            #
+            #   @return [String, nil]
+            optional :report_url, String
+
+            # @!attribute result
+            #
+            #   @return [Object, nil]
+            optional :result, Telnyx::Internal::Type::Unknown
+
+            # @!attribute start_time
+            #
+            #   @return [Time, nil]
+            optional :start_time, Time
+
+            # @!attribute status
+            #   Status of the report: Pending = 1, Complete = 2, Failed = 3, Expired = 4
+            #
+            #   @return [Integer, nil]
+            optional :status, Integer
+
+            # @!attribute updated_at
+            #
+            #   @return [Time, nil]
+            optional :updated_at, Time
+
+            # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, product_breakdown: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Legacy::Reporting::UsageReports::CdrUsageReportResponseLegacy}
+            #   for more details.
+            #
+            #   Legacy V2 CDR usage report response
+            #
+            #   @param id [String] Identifies the resource
+            #
+            #   @param aggregation_type [Integer] Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3
+            #
+            #   @param connections [Array<Integer>]
+            #
+            #   @param created_at [Time]
+            #
+            #   @param end_time [Time]
+            #
+            #   @param product_breakdown [Integer] Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID
+            #
+            #   @param record_type [String]
+            #
+            #   @param report_url [String]
+            #
+            #   @param result [Object]
+            #
+            #   @param start_time [Time]
+            #
+            #   @param status [Integer] Status of the report: Pending = 1, Complete = 2, Failed = 3, Expired = 4
+            #
+            #   @param updated_at [Time]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/legacy/reporting/usage_reports/mdr_usage_report_response_legacy.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Legacy
+      module Reporting
+        module UsageReports
+          class MdrUsageReportResponseLegacy < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifies the resource
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute aggregation_type
+            #   Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
+            #
+            #   @return [Integer, nil]
+            optional :aggregation_type, Integer
+
+            # @!attribute connections
+            #
+            #   @return [Array<Integer>, nil]
+            optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
+
+            # @!attribute created_at
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time
+
+            # @!attribute end_time
+            #
+            #   @return [Time, nil]
+            optional :end_time, Time
+
+            # @!attribute profiles
+            #   List of messaging profile IDs
+            #
+            #   @return [Array<String>, nil]
+            optional :profiles, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute record_type
+            #
+            #   @return [String, nil]
+            optional :record_type, String
+
+            # @!attribute report_url
+            #
+            #   @return [String, nil]
+            optional :report_url, String
+
+            # @!attribute result
+            #
+            #   @return [Object, nil]
+            optional :result, Telnyx::Internal::Type::Unknown
+
+            # @!attribute start_time
+            #
+            #   @return [Time, nil]
+            optional :start_time, Time
+
+            # @!attribute status
+            #   Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
+            #
+            #   @return [Integer, nil]
+            optional :status, Integer
+
+            # @!attribute updated_at
+            #
+            #   @return [Time, nil]
+            optional :updated_at, Time
+
+            # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, profiles: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
+            #   Legacy V2 MDR usage report response
+            #
+            #   @param id [String] Identifies the resource
+            #
+            #   @param aggregation_type [Integer] Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
+            #
+            #   @param connections [Array<Integer>]
+            #
+            #   @param created_at [Time]
+            #
+            #   @param end_time [Time]
+            #
+            #   @param profiles [Array<String>] List of messaging profile IDs
+            #
+            #   @param record_type [String]
+            #
+            #   @param report_url [String]
+            #
+            #   @param result [Object]
+            #
+            #   @param start_time [Time]
+            #
+            #   @param status [Integer] Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
+            #
+            #   @param updated_at [Time]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_response.rb

@@ -10,105 +10,11 @@ module Telnyx
             # @!attribute data
             #   Legacy V2 MDR usage report response
             #
-            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingCreateResponse::Data, nil]
-            optional :data, -> { Telnyx::Models::Legacy::Reporting::UsageReports::MessagingCreateResponse::Data }
+            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy, nil]
+            optional :data, -> { Telnyx::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy }
 
             # @!method initialize(data: nil)
-            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingCreateResponse::Data] Legacy V2 MDR usage report response
-
-            # @see Telnyx::Models::Legacy::Reporting::UsageReports::MessagingCreateResponse#data
-            class Data < Telnyx::Internal::Type::BaseModel
-              # @!attribute id
-              #   Identifies the resource
-              #
-              #   @return [String, nil]
-              optional :id, String
-
-              # @!attribute aggregation_type
-              #   Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @return [Integer, nil]
-              optional :aggregation_type, Integer
-
-              # @!attribute connections
-              #
-              #   @return [Array<Integer>, nil]
-              optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
-
-              # @!attribute created_at
-              #
-              #   @return [Time, nil]
-              optional :created_at, Time
-
-              # @!attribute end_time
-              #
-              #   @return [Time, nil]
-              optional :end_time, Time
-
-              # @!attribute profiles
-              #   List of messaging profile IDs
-              #
-              #   @return [Array<String>, nil]
-              optional :profiles, Telnyx::Internal::Type::ArrayOf[String]
-
-              # @!attribute record_type
-              #
-              #   @return [String, nil]
-              optional :record_type, String
-
-              # @!attribute report_url
-              #
-              #   @return [String, nil]
-              optional :report_url, String
-
-              # @!attribute result
-              #
-              #   @return [Object, nil]
-              optional :result, Telnyx::Internal::Type::Unknown
-
-              # @!attribute start_time
-              #
-              #   @return [Time, nil]
-              optional :start_time, Time
-
-              # @!attribute status
-              #   Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @return [Integer, nil]
-              optional :status, Integer
-
-              # @!attribute updated_at
-              #
-              #   @return [Time, nil]
-              optional :updated_at, Time
-
-              # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, profiles: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
-              #   Legacy V2 MDR usage report response
-              #
-              #   @param id [String] Identifies the resource
-              #
-              #   @param aggregation_type [Integer] Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @param connections [Array<Integer>]
-              #
-              #   @param created_at [Time]
-              #
-              #   @param end_time [Time]
-              #
-              #   @param profiles [Array<String>] List of messaging profile IDs
-              #
-              #   @param record_type [String]
-              #
-              #   @param report_url [String]
-              #
-              #   @param result [Object]
-              #
-              #   @param start_time [Time]
-              #
-              #   @param status [Integer] Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @param updated_at [Time]
-            end
+            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy] Legacy V2 MDR usage report response
           end
         end
       end

data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_delete_response.rb

@@ -10,105 +10,11 @@ module Telnyx
             # @!attribute data
             #   Legacy V2 MDR usage report response
             #
-            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingDeleteResponse::Data, nil]
-            optional :data, -> { Telnyx::Models::Legacy::Reporting::UsageReports::MessagingDeleteResponse::Data }
+            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy, nil]
+            optional :data, -> { Telnyx::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy }
 
             # @!method initialize(data: nil)
-            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingDeleteResponse::Data] Legacy V2 MDR usage report response
-
-            # @see Telnyx::Models::Legacy::Reporting::UsageReports::MessagingDeleteResponse#data
-            class Data < Telnyx::Internal::Type::BaseModel
-              # @!attribute id
-              #   Identifies the resource
-              #
-              #   @return [String, nil]
-              optional :id, String
-
-              # @!attribute aggregation_type
-              #   Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @return [Integer, nil]
-              optional :aggregation_type, Integer
-
-              # @!attribute connections
-              #
-              #   @return [Array<Integer>, nil]
-              optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
-
-              # @!attribute created_at
-              #
-              #   @return [Time, nil]
-              optional :created_at, Time
-
-              # @!attribute end_time
-              #
-              #   @return [Time, nil]
-              optional :end_time, Time
-
-              # @!attribute profiles
-              #   List of messaging profile IDs
-              #
-              #   @return [Array<String>, nil]
-              optional :profiles, Telnyx::Internal::Type::ArrayOf[String]
-
-              # @!attribute record_type
-              #
-              #   @return [String, nil]
-              optional :record_type, String
-
-              # @!attribute report_url
-              #
-              #   @return [String, nil]
-              optional :report_url, String
-
-              # @!attribute result
-              #
-              #   @return [Object, nil]
-              optional :result, Telnyx::Internal::Type::Unknown
-
-              # @!attribute start_time
-              #
-              #   @return [Time, nil]
-              optional :start_time, Time
-
-              # @!attribute status
-              #   Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @return [Integer, nil]
-              optional :status, Integer
-
-              # @!attribute updated_at
-              #
-              #   @return [Time, nil]
-              optional :updated_at, Time
-
-              # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, profiles: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
-              #   Legacy V2 MDR usage report response
-              #
-              #   @param id [String] Identifies the resource
-              #
-              #   @param aggregation_type [Integer] Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @param connections [Array<Integer>]
-              #
-              #   @param created_at [Time]
-              #
-              #   @param end_time [Time]
-              #
-              #   @param profiles [Array<String>] List of messaging profile IDs
-              #
-              #   @param record_type [String]
-              #
-              #   @param report_url [String]
-              #
-              #   @param result [Object]
-              #
-              #   @param start_time [Time]
-              #
-              #   @param status [Integer] Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @param updated_at [Time]
-            end
+            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy] Legacy V2 MDR usage report response
           end
         end
       end

data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rb

@@ -9,9 +9,9 @@ module Telnyx
           class MessagingListResponse < Telnyx::Internal::Type::BaseModel
             # @!attribute data
             #
-            #   @return [Array<Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse::Data>, nil]
+            #   @return [Array<Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy>, nil]
             optional :data,
-                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse::Data] }
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy] }
 
             # @!attribute meta
             #
@@ -19,102 +19,9 @@ module Telnyx
             optional :meta, -> { Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse::Meta }
 
             # @!method initialize(data: nil, meta: nil)
-            #   @param data [Array<Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse::Data>]
+            #   @param data [Array<Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy>]
             #   @param meta [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse::Meta]
 
-            class Data < Telnyx::Internal::Type::BaseModel
-              # @!attribute id
-              #   Identifies the resource
-              #
-              #   @return [String, nil]
-              optional :id, String
-
-              # @!attribute aggregation_type
-              #   Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @return [Integer, nil]
-              optional :aggregation_type, Integer
-
-              # @!attribute connections
-              #
-              #   @return [Array<Integer>, nil]
-              optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
-
-              # @!attribute created_at
-              #
-              #   @return [Time, nil]
-              optional :created_at, Time
-
-              # @!attribute end_time
-              #
-              #   @return [Time, nil]
-              optional :end_time, Time
-
-              # @!attribute profiles
-              #   List of messaging profile IDs
-              #
-              #   @return [Array<String>, nil]
-              optional :profiles, Telnyx::Internal::Type::ArrayOf[String]
-
-              # @!attribute record_type
-              #
-              #   @return [String, nil]
-              optional :record_type, String
-
-              # @!attribute report_url
-              #
-              #   @return [String, nil]
-              optional :report_url, String
-
-              # @!attribute result
-              #
-              #   @return [Object, nil]
-              optional :result, Telnyx::Internal::Type::Unknown
-
-              # @!attribute start_time
-              #
-              #   @return [Time, nil]
-              optional :start_time, Time
-
-              # @!attribute status
-              #   Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @return [Integer, nil]
-              optional :status, Integer
-
-              # @!attribute updated_at
-              #
-              #   @return [Time, nil]
-              optional :updated_at, Time
-
-              # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, profiles: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
-              #   Legacy V2 MDR usage report response
-              #
-              #   @param id [String] Identifies the resource
-              #
-              #   @param aggregation_type [Integer] Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @param connections [Array<Integer>]
-              #
-              #   @param created_at [Time]
-              #
-              #   @param end_time [Time]
-              #
-              #   @param profiles [Array<String>] List of messaging profile IDs
-              #
-              #   @param record_type [String]
-              #
-              #   @param report_url [String]
-              #
-              #   @param result [Object]
-              #
-              #   @param start_time [Time]
-              #
-              #   @param status [Integer] Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @param updated_at [Time]
-            end
-
             # @see Telnyx::Models::Legacy::Reporting::UsageReports::MessagingListResponse#meta
             class Meta < Telnyx::Internal::Type::BaseModel
               # @!attribute page_number

data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_retrieve_response.rb

@@ -10,105 +10,11 @@ module Telnyx
             # @!attribute data
             #   Legacy V2 MDR usage report response
             #
-            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingRetrieveResponse::Data, nil]
-            optional :data, -> { Telnyx::Models::Legacy::Reporting::UsageReports::MessagingRetrieveResponse::Data }
+            #   @return [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy, nil]
+            optional :data, -> { Telnyx::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy }
 
             # @!method initialize(data: nil)
-            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MessagingRetrieveResponse::Data] Legacy V2 MDR usage report response
-
-            # @see Telnyx::Models::Legacy::Reporting::UsageReports::MessagingRetrieveResponse#data
-            class Data < Telnyx::Internal::Type::BaseModel
-              # @!attribute id
-              #   Identifies the resource
-              #
-              #   @return [String, nil]
-              optional :id, String
-
-              # @!attribute aggregation_type
-              #   Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @return [Integer, nil]
-              optional :aggregation_type, Integer
-
-              # @!attribute connections
-              #
-              #   @return [Array<Integer>, nil]
-              optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]
-
-              # @!attribute created_at
-              #
-              #   @return [Time, nil]
-              optional :created_at, Time
-
-              # @!attribute end_time
-              #
-              #   @return [Time, nil]
-              optional :end_time, Time
-
-              # @!attribute profiles
-              #   List of messaging profile IDs
-              #
-              #   @return [Array<String>, nil]
-              optional :profiles, Telnyx::Internal::Type::ArrayOf[String]
-
-              # @!attribute record_type
-              #
-              #   @return [String, nil]
-              optional :record_type, String
-
-              # @!attribute report_url
-              #
-              #   @return [String, nil]
-              optional :report_url, String
-
-              # @!attribute result
-              #
-              #   @return [Object, nil]
-              optional :result, Telnyx::Internal::Type::Unknown
-
-              # @!attribute start_time
-              #
-              #   @return [Time, nil]
-              optional :start_time, Time
-
-              # @!attribute status
-              #   Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @return [Integer, nil]
-              optional :status, Integer
-
-              # @!attribute updated_at
-              #
-              #   @return [Time, nil]
-              optional :updated_at, Time
-
-              # @!method initialize(id: nil, aggregation_type: nil, connections: nil, created_at: nil, end_time: nil, profiles: nil, record_type: nil, report_url: nil, result: nil, start_time: nil, status: nil, updated_at: nil)
-              #   Legacy V2 MDR usage report response
-              #
-              #   @param id [String] Identifies the resource
-              #
-              #   @param aggregation_type [Integer] Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2
-              #
-              #   @param connections [Array<Integer>]
-              #
-              #   @param created_at [Time]
-              #
-              #   @param end_time [Time]
-              #
-              #   @param profiles [Array<String>] List of messaging profile IDs
-              #
-              #   @param record_type [String]
-              #
-              #   @param report_url [String]
-              #
-              #   @param result [Object]
-              #
-              #   @param start_time [Time]
-              #
-              #   @param status [Integer] Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)
-              #
-              #   @param updated_at [Time]
-            end
+            #   @param data [Telnyx::Models::Legacy::Reporting::UsageReports::MdrUsageReportResponseLegacy] Legacy V2 MDR usage report response
           end
         end
       end