zavudev 0.6.0 → 0.8.0

data/lib/zavudev/models/number_10dlc/ten_dlc_brand.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#list
+      class TenDlcBrand < Zavudev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute city
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute country
+        #   Two-letter ISO country code.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute display_name
+        #   Display name of the brand.
+        #
+        #   @return [String]
+        required :display_name, String, api_name: :displayName
+
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute entity_type
+        #   Business entity type for 10DLC brand registration.
+        #
+        #   @return [Symbol, Zavudev::Models::Number10dlc::TenDlcBrand::EntityType]
+        required :entity_type,
+                 enum: -> {
+                   Zavudev::Number10dlc::TenDlcBrand::EntityType
+                 },
+                 api_name: :entityType
+
+        # @!attribute phone
+        #   Contact phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone, String
+
+        # @!attribute postal_code
+        #
+        #   @return [String]
+        required :postal_code, String, api_name: :postalCode
+
+        # @!attribute state
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute status
+        #   Status of a 10DLC brand registration.
+        #
+        #   @return [Symbol, Zavudev::Models::Number10dlc::TenDlcBrand::Status]
+        required :status, enum: -> { Zavudev::Number10dlc::TenDlcBrand::Status }
+
+        # @!attribute street
+        #
+        #   @return [String]
+        required :street, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
+
+        # @!attribute vertical
+        #   Industry vertical.
+        #
+        #   @return [String]
+        required :vertical, String
+
+        # @!attribute brand_relationship
+        #
+        #   @return [String, nil]
+        optional :brand_relationship, String, api_name: :brandRelationship, nil?: true
+
+        # @!attribute brand_score
+        #   Trust score assigned by TCR after vetting.
+        #
+        #   @return [Integer, nil]
+        optional :brand_score, Integer, api_name: :brandScore, nil?: true
+
+        # @!attribute company_name
+        #   Legal company name.
+        #
+        #   @return [String, nil]
+        optional :company_name, String, api_name: :companyName, nil?: true
+
+        # @!attribute ein
+        #   Employer Identification Number (EIN).
+        #
+        #   @return [String, nil]
+        optional :ein, String, nil?: true
+
+        # @!attribute failure_reason
+        #   Reason for rejection, if applicable.
+        #
+        #   @return [String, nil]
+        optional :failure_reason, String, api_name: :failureReason, nil?: true
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName, nil?: true
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName, nil?: true
+
+        # @!attribute stock_exchange
+        #
+        #   @return [String, nil]
+        optional :stock_exchange, String, api_name: :stockExchange, nil?: true
+
+        # @!attribute stock_symbol
+        #
+        #   @return [String, nil]
+        optional :stock_symbol, String, api_name: :stockSymbol, nil?: true
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+        # @!attribute verified_at
+        #
+        #   @return [Time, nil]
+        optional :verified_at, Time, api_name: :verifiedAt, nil?: true
+
+        # @!attribute website
+        #
+        #   @return [String, nil]
+        optional :website, String, nil?: true
+
+        # @!method initialize(id:, city:, country:, created_at:, display_name:, email:, entity_type:, phone:, postal_code:, state:, status:, street:, updated_at:, vertical:, brand_relationship: nil, brand_score: nil, company_name: nil, ein: nil, failure_reason: nil, first_name: nil, last_name: nil, stock_exchange: nil, stock_symbol: nil, submitted_at: nil, verified_at: nil, website: nil)
+        #   @param id [String]
+        #
+        #   @param city [String]
+        #
+        #   @param country [String] Two-letter ISO country code.
+        #
+        #   @param created_at [Time]
+        #
+        #   @param display_name [String] Display name of the brand.
+        #
+        #   @param email [String]
+        #
+        #   @param entity_type [Symbol, Zavudev::Models::Number10dlc::TenDlcBrand::EntityType] Business entity type for 10DLC brand registration.
+        #
+        #   @param phone [String] Contact phone number in E.164 format.
+        #
+        #   @param postal_code [String]
+        #
+        #   @param state [String]
+        #
+        #   @param status [Symbol, Zavudev::Models::Number10dlc::TenDlcBrand::Status] Status of a 10DLC brand registration.
+        #
+        #   @param street [String]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param vertical [String] Industry vertical.
+        #
+        #   @param brand_relationship [String, nil]
+        #
+        #   @param brand_score [Integer, nil] Trust score assigned by TCR after vetting.
+        #
+        #   @param company_name [String, nil] Legal company name.
+        #
+        #   @param ein [String, nil] Employer Identification Number (EIN).
+        #
+        #   @param failure_reason [String, nil] Reason for rejection, if applicable.
+        #
+        #   @param first_name [String, nil]
+        #
+        #   @param last_name [String, nil]
+        #
+        #   @param stock_exchange [String, nil]
+        #
+        #   @param stock_symbol [String, nil]
+        #
+        #   @param submitted_at [Time, nil]
+        #
+        #   @param verified_at [Time, nil]
+        #
+        #   @param website [String, nil]
+
+        # Business entity type for 10DLC brand registration.
+        #
+        # @see Zavudev::Models::Number10dlc::TenDlcBrand#entity_type
+        module EntityType
+          extend Zavudev::Internal::Type::Enum
+
+          PRIVATE_PROFIT = :PRIVATE_PROFIT
+          PUBLIC_PROFIT = :PUBLIC_PROFIT
+          NON_PROFIT = :NON_PROFIT
+          GOVERNMENT = :GOVERNMENT
+          SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Status of a 10DLC brand registration.
+        #
+        # @see Zavudev::Models::Number10dlc::TenDlcBrand#status
+        module Status
+          extend Zavudev::Internal::Type::Enum
+
+          DRAFT = :draft
+          PENDING = :pending
+          VERIFIED = :verified
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#list
+      class TenDlcCampaign < Zavudev::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute affiliate_marketing
+        #
+        #   @return [Boolean]
+        required :affiliate_marketing, Zavudev::Internal::Type::Boolean, api_name: :affiliateMarketing
+
+        # @!attribute age_gated
+        #
+        #   @return [Boolean]
+        required :age_gated, Zavudev::Internal::Type::Boolean, api_name: :ageGated
+
+        # @!attribute brand_id
+        #   ID of the brand this campaign belongs to.
+        #
+        #   @return [String]
+        required :brand_id, String, api_name: :brandId
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute description
+        #   Description of the messaging campaign.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute direct_lending
+        #
+        #   @return [Boolean]
+        required :direct_lending, Zavudev::Internal::Type::Boolean, api_name: :directLending
+
+        # @!attribute embedded_link
+        #
+        #   @return [Boolean]
+        required :embedded_link, Zavudev::Internal::Type::Boolean, api_name: :embeddedLink
+
+        # @!attribute embedded_phone
+        #
+        #   @return [Boolean]
+        required :embedded_phone, Zavudev::Internal::Type::Boolean, api_name: :embeddedPhone
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute number_pooling
+        #
+        #   @return [Boolean]
+        required :number_pooling, Zavudev::Internal::Type::Boolean, api_name: :numberPooling
+
+        # @!attribute sample_messages
+        #   Sample messages representative of campaign content.
+        #
+        #   @return [Array<String>]
+        required :sample_messages, Zavudev::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!attribute status
+        #   Status of a 10DLC campaign registration.
+        #
+        #   @return [Symbol, Zavudev::Models::Number10dlc::TenDlcCampaign::Status]
+        required :status, enum: -> { Zavudev::Number10dlc::TenDlcCampaign::Status }
+
+        # @!attribute subscriber_help
+        #
+        #   @return [Boolean]
+        required :subscriber_help, Zavudev::Internal::Type::Boolean, api_name: :subscriberHelp
+
+        # @!attribute subscriber_opt_in
+        #
+        #   @return [Boolean]
+        required :subscriber_opt_in, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptIn
+
+        # @!attribute subscriber_opt_out
+        #
+        #   @return [Boolean]
+        required :subscriber_opt_out, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptOut
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
+
+        # @!attribute use_case
+        #   Campaign use case type.
+        #
+        #   @return [String]
+        required :use_case, String, api_name: :useCase
+
+        # @!attribute approved_at
+        #
+        #   @return [Time, nil]
+        optional :approved_at, Time, api_name: :approvedAt, nil?: true
+
+        # @!attribute daily_limit
+        #   Daily message limit based on brand trust score.
+        #
+        #   @return [Integer, nil]
+        optional :daily_limit, Integer, api_name: :dailyLimit, nil?: true
+
+        # @!attribute failure_reason
+        #
+        #   @return [String, nil]
+        optional :failure_reason, String, api_name: :failureReason, nil?: true
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute monthly_fee_cents
+        #   Recurring monthly fee in cents.
+        #
+        #   @return [Integer, nil]
+        optional :monthly_fee_cents, Integer, api_name: :monthlyFeeCents, nil?: true
+
+        # @!attribute opt_in_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_in_keywords,
+                 Zavudev::Internal::Type::ArrayOf[String],
+                 api_name: :optInKeywords,
+                 nil?: true
+
+        # @!attribute opt_out_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_out_keywords,
+                 Zavudev::Internal::Type::ArrayOf[String],
+                 api_name: :optOutKeywords,
+                 nil?: true
+
+        # @!attribute registration_cost_cents
+        #   One-time registration cost in cents.
+        #
+        #   @return [Integer, nil]
+        optional :registration_cost_cents, Integer, api_name: :registrationCostCents, nil?: true
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+        # @!attribute sub_use_cases
+        #
+        #   @return [Array<String>, nil]
+        optional :sub_use_cases, Zavudev::Internal::Type::ArrayOf[String], api_name: :subUseCases, nil?: true
+
+        # @!method initialize(id:, affiliate_marketing:, age_gated:, brand_id:, created_at:, description:, direct_lending:, embedded_link:, embedded_phone:, name:, number_pooling:, sample_messages:, status:, subscriber_help:, subscriber_opt_in:, subscriber_opt_out:, updated_at:, use_case:, approved_at: nil, daily_limit: nil, failure_reason: nil, help_message: nil, message_flow: nil, monthly_fee_cents: nil, opt_in_keywords: nil, opt_out_keywords: nil, registration_cost_cents: nil, submitted_at: nil, sub_use_cases: nil)
+        #   @param id [String]
+        #
+        #   @param affiliate_marketing [Boolean]
+        #
+        #   @param age_gated [Boolean]
+        #
+        #   @param brand_id [String] ID of the brand this campaign belongs to.
+        #
+        #   @param created_at [Time]
+        #
+        #   @param description [String] Description of the messaging campaign.
+        #
+        #   @param direct_lending [Boolean]
+        #
+        #   @param embedded_link [Boolean]
+        #
+        #   @param embedded_phone [Boolean]
+        #
+        #   @param name [String]
+        #
+        #   @param number_pooling [Boolean]
+        #
+        #   @param sample_messages [Array<String>] Sample messages representative of campaign content.
+        #
+        #   @param status [Symbol, Zavudev::Models::Number10dlc::TenDlcCampaign::Status] Status of a 10DLC campaign registration.
+        #
+        #   @param subscriber_help [Boolean]
+        #
+        #   @param subscriber_opt_in [Boolean]
+        #
+        #   @param subscriber_opt_out [Boolean]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param use_case [String] Campaign use case type.
+        #
+        #   @param approved_at [Time, nil]
+        #
+        #   @param daily_limit [Integer, nil] Daily message limit based on brand trust score.
+        #
+        #   @param failure_reason [String, nil]
+        #
+        #   @param help_message [String, nil]
+        #
+        #   @param message_flow [String, nil]
+        #
+        #   @param monthly_fee_cents [Integer, nil] Recurring monthly fee in cents.
+        #
+        #   @param opt_in_keywords [Array<String>, nil]
+        #
+        #   @param opt_out_keywords [Array<String>, nil]
+        #
+        #   @param registration_cost_cents [Integer, nil] One-time registration cost in cents.
+        #
+        #   @param submitted_at [Time, nil]
+        #
+        #   @param sub_use_cases [Array<String>, nil]
+
+        # Status of a 10DLC campaign registration.
+        #
+        # @see Zavudev::Models::Number10dlc::TenDlcCampaign#status
+        module Status
+          extend Zavudev::Internal::Type::Enum
+
+          DRAFT = :draft
+          PENDING = :pending
+          APPROVED = :approved
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/plan_retrieve_params.rb

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

data/lib/zavudev/models/plan_retrieve_response.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::Plan#retrieve
+    class PlanRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute billing_interval
+      #
+      #   @return [Symbol, Zavudev::Models::PlanRetrieveResponse::BillingInterval]
+      required :billing_interval,
+               enum: -> { Zavudev::Models::PlanRetrieveResponse::BillingInterval },
+               api_name: :billingInterval
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::PlanRetrieveResponse::Status]
+      required :status, enum: -> { Zavudev::Models::PlanRetrieveResponse::Status }
+
+      # @!attribute tier
+      #   Current subscription tier.
+      #
+      #   @return [Symbol, Zavudev::Models::PlanRetrieveResponse::Tier]
+      required :tier, enum: -> { Zavudev::Models::PlanRetrieveResponse::Tier }
+
+      # @!attribute cancel_at_period_end
+      #
+      #   @return [Boolean, nil]
+      optional :cancel_at_period_end, Zavudev::Internal::Type::Boolean, api_name: :cancelAtPeriodEnd
+
+      # @!attribute current_period_end
+      #
+      #   @return [Time, nil]
+      optional :current_period_end, Time, api_name: :currentPeriodEnd
+
+      # @!attribute current_period_start
+      #
+      #   @return [Time, nil]
+      optional :current_period_start, Time, api_name: :currentPeriodStart
+
+      # @!attribute limits
+      #
+      #   @return [Zavudev::Models::PlanRetrieveResponse::Limits, nil]
+      optional :limits, -> { Zavudev::Models::PlanRetrieveResponse::Limits }
+
+      # @!method initialize(billing_interval:, status:, tier:, cancel_at_period_end: nil, current_period_end: nil, current_period_start: nil, limits: nil)
+      #   @param billing_interval [Symbol, Zavudev::Models::PlanRetrieveResponse::BillingInterval]
+      #
+      #   @param status [Symbol, Zavudev::Models::PlanRetrieveResponse::Status]
+      #
+      #   @param tier [Symbol, Zavudev::Models::PlanRetrieveResponse::Tier] Current subscription tier.
+      #
+      #   @param cancel_at_period_end [Boolean]
+      #
+      #   @param current_period_end [Time]
+      #
+      #   @param current_period_start [Time]
+      #
+      #   @param limits [Zavudev::Models::PlanRetrieveResponse::Limits]
+
+      # @see Zavudev::Models::PlanRetrieveResponse#billing_interval
+      module BillingInterval
+        extend Zavudev::Internal::Type::Enum
+
+        MONTHLY = :monthly
+        ANNUAL = :annual
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Zavudev::Models::PlanRetrieveResponse#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAST_DUE = :past_due
+        CANCELED = :canceled
+        TRIALING = :trialing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current subscription tier.
+      #
+      # @see Zavudev::Models::PlanRetrieveResponse#tier
+      module Tier
+        extend Zavudev::Internal::Type::Enum
+
+        FREE = :free
+        PRO = :pro
+        SCALE = :scale
+        ENTERPRISE = :enterprise
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Zavudev::Models::PlanRetrieveResponse#limits
+      class Limits < Zavudev::Internal::Type::BaseModel
+        # @!attribute broadcasts
+        #
+        #   @return [Boolean, nil]
+        optional :broadcasts, Zavudev::Internal::Type::Boolean
+
+        # @!attribute emails
+        #   Monthly email limit.
+        #
+        #   @return [Integer, nil]
+        optional :emails, Integer
+
+        # @!attribute messages_a2_p
+        #   Monthly A2P message limit.
+        #
+        #   @return [Integer, nil]
+        optional :messages_a2_p, Integer, api_name: :messagesA2P
+
+        # @!attribute phone_numbers
+        #
+        #   @return [Integer, nil]
+        optional :phone_numbers, Integer, api_name: :phoneNumbers
+
+        # @!attribute senders
+        #
+        #   @return [Integer, nil]
+        optional :senders, Integer
+
+        # @!attribute sub_accounts
+        #
+        #   @return [Boolean, nil]
+        optional :sub_accounts, Zavudev::Internal::Type::Boolean, api_name: :subAccounts
+
+        # @!attribute waba_connections
+        #
+        #   @return [Integer, nil]
+        optional :waba_connections, Integer, api_name: :wabaConnections
+
+        # @!method initialize(broadcasts: nil, emails: nil, messages_a2_p: nil, phone_numbers: nil, senders: nil, sub_accounts: nil, waba_connections: nil)
+        #   @param broadcasts [Boolean]
+        #
+        #   @param emails [Integer] Monthly email limit.
+        #
+        #   @param messages_a2_p [Integer] Monthly A2P message limit.
+        #
+        #   @param phone_numbers [Integer]
+        #
+        #   @param senders [Integer]
+        #
+        #   @param sub_accounts [Boolean]
+        #
+        #   @param waba_connections [Integer]
+      end
+    end
+  end
+end