wavix-ruby-sdk 1.0.0

data/lib/wavix/types/ten_dlc_brand_appeal_outcome.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The appeal outcome details
+    class TenDlcBrandAppealOutcome < Internal::Types::Model
+      field :optional_attributes, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+
+      field :vetting_status, -> { Wavix::Types::TenDlcBrandAppealOutcomeVettingStatus }, optional: false, nullable: false
+
+      field :feedback, -> { Wavix::Types::TenDlcBrandAppealOutcomeFeedback }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_appeal_outcome_feedback.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Brand Identity Verification appeal feedback, if any
+    class TenDlcBrandAppealOutcomeFeedback < Internal::Types::Model
+      field :category, -> { Internal::Types::Array[Wavix::Types::TcrFeedbackCategory] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_appeal_outcome_vetting_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandAppealOutcomeVettingStatus
+      extend Wavix::Internal::Types::Enum
+
+      REVIEW = "REVIEW"
+      VERIFIED = "VERIFIED"
+      UNVERIFIED = "UNVERIFIED"
+      VETTED_VERIFIED = "VETTED_VERIFIED"
+      SUSPENDED = "SUSPENDED"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # 10DLC Brand registration request
+    class TenDlcBrandCreateRequest < Internal::Types::Model
+      extend Wavix::Internal::Types::Union
+
+      member -> { Wavix::Types::TenDlcBrandCreateRequestZero }
+
+      member -> { Wavix::Types::TenDlcBrandCreateRequestStockExchange }
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_entity_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandCreateRequestEntityType
+      extend Wavix::Internal::Types::Enum
+
+      PRIVATE_PROFIT = "PRIVATE_PROFIT"
+      PUBLIC_PROFIT = "PUBLIC_PROFIT"
+      NON_PROFIT = "NON_PROFIT"
+      GOVERNMENT = "GOVERNMENT"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_stock_exchange.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Non-PUBLIC_PROFIT brands must not include stock_symbol or stock_exchange.
+    class TenDlcBrandCreateRequestStockExchange < Internal::Types::Model
+      field :entity_type, -> { Wavix::Types::TenDlcBrandCreateRequestStockExchangeEntityType }, optional: true, nullable: false
+
+      field :stock_symbol, -> { Object }, optional: true, nullable: false
+
+      field :stock_exchange, -> { Object }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_stock_exchange_entity_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandCreateRequestStockExchangeEntityType
+      extend Wavix::Internal::Types::Enum
+
+      PRIVATE_PROFIT = "PRIVATE_PROFIT"
+      NON_PROFIT = "NON_PROFIT"
+      GOVERNMENT = "GOVERNMENT"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_vertical.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandCreateRequestVertical
+      extend Wavix::Internal::Types::Enum
+
+      HEALTHCARE = "HEALTHCARE"
+      PROFESSIONAL = "PROFESSIONAL"
+      RETAIL = "RETAIL"
+      TECHNOLOGY = "TECHNOLOGY"
+      EDUCATION = "EDUCATION"
+      FINANCIAL = "FINANCIAL"
+      NON_PROFIT = "NON_PROFIT"
+      GOVERNMENT = "GOVERNMENT"
+      OTHER = "OTHER"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_zero.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # PUBLIC_PROFIT brands must provide stock_symbol and stock_exchange.
+    class TenDlcBrandCreateRequestZero < Internal::Types::Model
+      field :entity_type, -> { Wavix::Types::TenDlcBrandCreateRequestZeroEntityType }, optional: true, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_create_request_zero_entity_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandCreateRequestZeroEntityType
+      extend Wavix::Internal::Types::Enum
+
+      PUBLIC_PROFIT = "PUBLIC_PROFIT"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_entity_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandEntityType
+      extend Wavix::Internal::Types::Enum
+
+      PRIVATE_PROFIT = "PRIVATE_PROFIT"
+      PUBLIC_PROFIT = "PUBLIC_PROFIT"
+      NON_PROFIT = "NON_PROFIT"
+      GOVERNMENT = "GOVERNMENT"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_evidence.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcBrandEvidence < Internal::Types::Model
+      field :file_name, -> { String }, optional: false, nullable: false
+
+      field :mime_type, -> { String }, optional: false, nullable: false
+
+      field :url, -> { String }, optional: false, nullable: false
+
+      field :uuid, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_identity_verification_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandIdentityVerificationStatus
+      extend Wavix::Internal::Types::Enum
+
+      REVIEW = "REVIEW"
+      VERIFIED = "VERIFIED"
+      UNVERIFIED = "UNVERIFIED"
+      VETTED_VERIFIED = "VETTED_VERIFIED"
+      SUSPENDED = "SUSPENDED"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # A list of 10DLC Brands
+    class TenDlcBrandListResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Wavix::Types::TenDlcBrand] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::TenDlcBrandListResponsePagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_list_response_pagination.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Pagination details
+    class TenDlcBrandListResponsePagination < Internal::Types::Model
+      field :current_page, -> { Integer }, optional: false, nullable: false
+
+      field :per_page, -> { Integer }, optional: false, nullable: false
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :total_pages, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_qualification_result.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcBrandQualificationResult < Internal::Types::Model
+      field :mno_metadata, -> { Internal::Types::Array[Wavix::Types::TenDlcmnoMetadata] }, optional: false, nullable: false
+
+      field :monthly_fee, -> { Integer }, optional: false, nullable: false
+
+      field :usecase, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TenDlcBrandStatus
+      extend Wavix::Internal::Types::Enum
+
+      REVIEW = "REVIEW"
+      VERIFIED = "VERIFIED"
+      UNVERIFIED = "UNVERIFIED"
+      VETTED_VERIFIED = "VETTED_VERIFIED"
+      SUSPENDED = "SUSPENDED"
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents the result of an external vetting performed on a 10DLC brand. Vetting can raise a Brand's trust score
+    # and unlock higher messaging throughput.
+    class TenDlcBrandVetting < Internal::Types::Model
+      field :evp_id, -> { String }, optional: false, nullable: false
+
+      field :create_date, -> { String }, optional: false, nullable: false
+
+      field :vetting_details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :vetted_date, -> { String }, optional: false, nullable: true
+
+      field :vetting_id, -> { String }, optional: false, nullable: false
+
+      field :vetting_token, -> { String }, optional: false, nullable: true
+
+      field :vetting_score, -> { Integer }, optional: false, nullable: true
+
+      field :vetting_class, -> { String }, optional: false, nullable: false
+
+      field :vetting_status, -> { String }, optional: false, nullable: false
+
+      field :reasons, -> { Internal::Types::Array[String] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents an appeal against a 10DLC brand vetting result. An appeal asks the vetting provider to reconsider the
+    # assigned score.
+    class TenDlcBrandVettingAppeal < Internal::Types::Model
+      field :appeal_outcome, -> { Wavix::Types::TenDlcBrandVettingAppealAppealOutcome }, optional: false, nullable: false
+
+      field :appeal_status, -> { String }, optional: false, nullable: false
+
+      field :appeal_status_update_date, -> { String }, optional: false, nullable: false
+
+      field :attachment_uuid_list, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :brand_id, -> { String }, optional: false, nullable: false
+
+      field :category_list, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :create_date, -> { String }, optional: false, nullable: false
+
+      field :explanation, -> { String }, optional: false, nullable: false
+
+      field :evp_id, -> { String }, optional: false, nullable: false
+
+      field :vetting_class, -> { String }, optional: false, nullable: false
+
+      field :vetting_id, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal_appeal_outcome.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Outcome of the appeal, including the revised vetting status and score.
+    class TenDlcBrandVettingAppealAppealOutcome < Internal::Types::Model
+      field :vet_status, -> { String }, optional: false, nullable: false
+
+      field :vet_score, -> { Integer }, optional: false, nullable: false
+
+      field :feedback, -> { Wavix::Types::TenDlcBrandVettingAppealAppealOutcomeFeedback }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal_appeal_outcome_feedback.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The feedback provided by the external vetting provider
+    class TenDlcBrandVettingAppealAppealOutcomeFeedback < Internal::Types::Model
+      field :reasons, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal_outcome.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcBrandVettingAppealOutcome < Internal::Types::Model
+      field :vet_status, -> { String }, optional: false, nullable: false
+
+      field :vet_score, -> { Integer }, optional: false, nullable: false
+
+      field :feedback, -> { Wavix::Types::TenDlcBrandVettingAppealOutcomeFeedback }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal_outcome_feedback.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # The feedback provided by the external vetting provider
+    class TenDlcBrandVettingAppealOutcomeFeedback < Internal::Types::Model
+      field :reasons, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_brand_vetting_appeal_outcome_reason.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcBrandVettingAppealOutcomeReason < Internal::Types::Model
+      field :reasons, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and
+    # opt-out flows, and the phone numbers permitted to send its traffic.
+    class TenDlcCampaign < Internal::Types::Model
+      field :affiliate_marketing, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :age_gated, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :auto_renewal, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :last_bill_date, -> { String }, optional: false, nullable: true
+
+      field :next_bill_date, -> { String }, optional: false, nullable: true
+
+      field :direct_lending, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :embedded_links, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :embedded_phones, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :embedded_link_sample, -> { String }, optional: false, nullable: true
+
+      field :brand_id, -> { String }, optional: false, nullable: false
+
+      field :campaign_id, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: true
+
+      field :optin_workflow, -> { String }, optional: false, nullable: true
+
+      field :feedback, -> { String }, optional: false, nullable: true
+
+      field :help, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :help_keywords, -> { String }, optional: false, nullable: false
+
+      field :help_message, -> { String }, optional: false, nullable: true
+
+      field :optin, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :optin_keywords, -> { String }, optional: false, nullable: false
+
+      field :optin_message, -> { String }, optional: false, nullable: true
+
+      field :optout, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :optout_keywords, -> { String }, optional: false, nullable: false
+
+      field :optout_message, -> { String }, optional: false, nullable: true
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :sample1, -> { String }, optional: false, nullable: true
+
+      field :sample2, -> { String }, optional: false, nullable: true
+
+      field :sample3, -> { String }, optional: false, nullable: true
+
+      field :sample4, -> { String }, optional: false, nullable: true
+
+      field :sample5, -> { String }, optional: false, nullable: true
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+
+      field :mock, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :usecase, -> { String }, optional: false, nullable: false
+
+      field :monthly_fee, -> { String }, optional: false, nullable: false
+
+      field :privacy_policy, -> { String }, optional: false, nullable: true
+
+      field :terms_conditions, -> { String }, optional: false, nullable: true
+
+      field :status, -> { String }, optional: false, nullable: false
+
+      field :phone_numbers, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Paginated list of 10DLC Campaigns.
+    class TenDlcCampaignListResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Wavix::Types::TenDlcCampaign] }, optional: false, nullable: false
+
+      field :pagination, -> { Wavix::Types::TenDlcCampaignListResponsePagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign_list_response_pagination.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Pagination metadata for the result set.
+    class TenDlcCampaignListResponsePagination < Internal::Types::Model
+      field :current_page, -> { Integer }, optional: false, nullable: false
+
+      field :per_page, -> { Integer }, optional: false, nullable: false
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :total_pages, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign_nudge_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Nudge configuration. Set the nudge intent to `REVIEW` to request action on a pending approval, or to
+    # `APPEAL_REJECTION` to submit an appeal for a rejected campaign.
+    class TenDlcCampaignNudgeRequest < Internal::Types::Model
+      field :nudge_intent, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign_number.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcCampaignNumber < Internal::Types::Model
+      field :number, -> { String }, optional: false, nullable: false
+
+      field :status, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_campaign_number_list_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    class TenDlcCampaignNumberListResponse < Internal::Types::Model
+      field :brand_id, -> { String }, optional: false, nullable: false
+
+      field :campaign_id, -> { String }, optional: false, nullable: false
+
+      field :numbers, -> { Internal::Types::Array[Wavix::Types::TenDlcCampaignNumber] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlc_event_subscription.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents a subscription that delivers 10DLC lifecycle events to a webhook URL.
+    class TenDlcEventSubscription < Internal::Types::Model
+      field :subscription_category, -> { String }, optional: false, nullable: false
+
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/wavix/types/ten_dlcmno_metadata.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents per-MNO 10DLC requirements and throughput limits that apply to a campaign use case.
+    class TenDlcmnoMetadata < Internal::Types::Model
+      field :att_mms_tpm, -> { Integer }, optional: false, nullable: true
+
+      field :att_msg_class, -> { String }, optional: false, nullable: true
+
+      field :att_sms_tpm, -> { Integer }, optional: false, nullable: true
+
+      field :att_tpm_scope, -> { String }, optional: false, nullable: true
+
+      field :help_required, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :optin_required, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :optout_required, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :min_msg_samples, -> { Integer }, optional: false, nullable: false
+
+      field :mno, -> { String }, optional: false, nullable: false
+
+      field :mno_qualify, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :mno_review, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :mno_support, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :no_embedded_links, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :no_embedded_phone, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :tmobile_brand_dcap, -> { Integer }, optional: false, nullable: true
+
+      field :tmobile_brand_tier, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/wavix/types/transaction_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TransactionStatus
+      extend Wavix::Internal::Types::Enum
+
+      CREATED = "Created"
+      PENDING = "Pending"
+      COMMITTED = "Committed"
+      REVERTED = "Reverted"
+    end
+  end
+end

data/lib/wavix/types/transaction_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    module TransactionType
+      # TransactionType is an alias for Integer
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/wavix/types/transcript_turn.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Wavix
+  module Types
+    # Represents a single turn in a call transcript. Each turn carries the text attributed to one speaker, with the
+    # start and end times for that text.
+    class TranscriptTurn < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+
+      field :s, -> { Integer }, optional: true, nullable: false
+
+      field :e, -> { Integer }, optional: true, nullable: false
+
+      field :text, -> { String }, optional: true, nullable: false
+
+      field :sentiment, -> { String }, optional: true, nullable: false
+    end
+  end
+end