zavudev 0.7.0 → 0.8.0

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#update
+      class BrandUpdateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute city
+        #
+        #   @return [String, nil]
+        optional :city, String
+
+        # @!attribute company_name
+        #
+        #   @return [String, nil]
+        optional :company_name, String, api_name: :companyName
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute display_name
+        #
+        #   @return [String, nil]
+        optional :display_name, String, api_name: :displayName
+
+        # @!attribute ein
+        #
+        #   @return [String, nil]
+        optional :ein, String
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute entity_type
+        #   Business entity type for 10DLC brand registration.
+        #
+        #   @return [Symbol, Zavudev::Models::Number10dlc::BrandUpdateParams::EntityType, nil]
+        optional :entity_type,
+                 enum: -> { Zavudev::Number10dlc::BrandUpdateParams::EntityType },
+                 api_name: :entityType
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute postal_code
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, api_name: :postalCode
+
+        # @!attribute state
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!attribute stock_exchange
+        #
+        #   @return [String, nil]
+        optional :stock_exchange, String, api_name: :stockExchange
+
+        # @!attribute stock_symbol
+        #
+        #   @return [String, nil]
+        optional :stock_symbol, String, api_name: :stockSymbol
+
+        # @!attribute street
+        #
+        #   @return [String, nil]
+        optional :street, String
+
+        # @!attribute vertical
+        #
+        #   @return [String, nil]
+        optional :vertical, String
+
+        # @!attribute website
+        #
+        #   @return [String, nil]
+        optional :website, String
+
+        # @!method initialize(brand_id:, city: nil, company_name: nil, country: nil, display_name: nil, ein: nil, email: nil, entity_type: nil, first_name: nil, last_name: nil, phone: nil, postal_code: nil, state: nil, stock_exchange: nil, stock_symbol: nil, street: nil, vertical: nil, website: nil, request_options: {})
+        #   @param brand_id [String]
+        #
+        #   @param city [String]
+        #
+        #   @param company_name [String]
+        #
+        #   @param country [String]
+        #
+        #   @param display_name [String]
+        #
+        #   @param ein [String]
+        #
+        #   @param email [String]
+        #
+        #   @param entity_type [Symbol, Zavudev::Models::Number10dlc::BrandUpdateParams::EntityType] Business entity type for 10DLC brand registration.
+        #
+        #   @param first_name [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param phone [String]
+        #
+        #   @param postal_code [String]
+        #
+        #   @param state [String]
+        #
+        #   @param stock_exchange [String]
+        #
+        #   @param stock_symbol [String]
+        #
+        #   @param street [String]
+        #
+        #   @param vertical [String]
+        #
+        #   @param website [String]
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+
+        # Business entity type for 10DLC brand registration.
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Brands#update
+      class BrandUpdateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute brand
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcBrand]
+        required :brand, -> { Zavudev::Number10dlc::TenDlcBrand }
+
+        # @!method initialize(brand:)
+        #   @param brand [Zavudev::Models::Number10dlc::TenDlcBrand]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#create
+      class CampaignCreateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!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 to create this campaign under.
+        #
+        #   @return [String]
+        required :brand_id, String, api_name: :brandId
+
+        # @!attribute description
+        #
+        #   @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
+        #
+        #   @return [Array<String>]
+        required :sample_messages, Zavudev::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!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 use_case
+        #   Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).
+        #
+        #   @return [String]
+        required :use_case, String, api_name: :useCase
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow
+
+        # @!attribute opt_in_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_in_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optInKeywords
+
+        # @!attribute opt_out_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_out_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optOutKeywords
+
+        # @!attribute sub_use_cases
+        #
+        #   @return [Array<String>, nil]
+        optional :sub_use_cases, Zavudev::Internal::Type::ArrayOf[String], api_name: :subUseCases
+
+        # @!method initialize(affiliate_marketing:, age_gated:, brand_id:, description:, direct_lending:, embedded_link:, embedded_phone:, name:, number_pooling:, sample_messages:, subscriber_help:, subscriber_opt_in:, subscriber_opt_out:, use_case:, help_message: nil, message_flow: nil, opt_in_keywords: nil, opt_out_keywords: nil, sub_use_cases: nil, request_options: {})
+        #   @param affiliate_marketing [Boolean]
+        #
+        #   @param age_gated [Boolean]
+        #
+        #   @param brand_id [String] ID of the brand to create this campaign under.
+        #
+        #   @param description [String]
+        #
+        #   @param direct_lending [Boolean]
+        #
+        #   @param embedded_link [Boolean]
+        #
+        #   @param embedded_phone [Boolean]
+        #
+        #   @param name [String]
+        #
+        #   @param number_pooling [Boolean]
+        #
+        #   @param sample_messages [Array<String>]
+        #
+        #   @param subscriber_help [Boolean]
+        #
+        #   @param subscriber_opt_in [Boolean]
+        #
+        #   @param subscriber_opt_out [Boolean]
+        #
+        #   @param use_case [String] Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).
+        #
+        #   @param help_message [String]
+        #
+        #   @param message_flow [String]
+        #
+        #   @param opt_in_keywords [Array<String>]
+        #
+        #   @param opt_out_keywords [Array<String>]
+        #
+        #   @param sub_use_cases [Array<String>]
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#create
+      class CampaignCreateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcCampaign]
+        required :campaign, -> { Zavudev::Number10dlc::TenDlcCampaign }
+
+        # @!method initialize(campaign:)
+        #   @param campaign [Zavudev::Models::Number10dlc::TenDlcCampaign]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#delete
+      class CampaignDeleteParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!method initialize(campaign_id:, request_options: {})
+        #   @param campaign_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#list
+      class CampaignListParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #   Filter campaigns by brand ID.
+        #
+        #   @return [String, nil]
+        optional :brand_id, String
+
+        # @!attribute cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(brand_id: nil, cursor: nil, limit: nil, request_options: {})
+        #   @param brand_id [String] Filter campaigns by brand ID.
+        #
+        #   @param cursor [String]
+        #
+        #   @param limit [Integer]
+        #
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#retrieve
+      class CampaignRetrieveParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!method initialize(campaign_id:, request_options: {})
+        #   @param campaign_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#retrieve
+      class CampaignRetrieveResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcCampaign]
+        required :campaign, -> { Zavudev::Number10dlc::TenDlcCampaign }
+
+        # @!method initialize(campaign:)
+        #   @param campaign [Zavudev::Models::Number10dlc::TenDlcCampaign]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#submit
+      class CampaignSubmitParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!method initialize(campaign_id:, request_options: {})
+        #   @param campaign_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#submit
+      class CampaignSubmitResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcCampaign]
+        required :campaign, -> { Zavudev::Number10dlc::TenDlcCampaign }
+
+        # @!method initialize(campaign:)
+        #   @param campaign [Zavudev::Models::Number10dlc::TenDlcCampaign]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#sync_status
+      class CampaignSyncStatusParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!method initialize(campaign_id:, request_options: {})
+        #   @param campaign_id [String]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#sync_status
+      class CampaignSyncStatusResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcCampaign]
+        required :campaign, -> { Zavudev::Number10dlc::TenDlcCampaign }
+
+        # @!method initialize(campaign:)
+        #   @param campaign [Zavudev::Models::Number10dlc::TenDlcCampaign]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#update
+      class CampaignUpdateParams < Zavudev::Internal::Type::BaseModel
+        extend Zavudev::Internal::Type::RequestParameters::Converter
+        include Zavudev::Internal::Type::RequestParameters
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute opt_in_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_in_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optInKeywords
+
+        # @!attribute opt_out_keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :opt_out_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optOutKeywords
+
+        # @!attribute sample_messages
+        #
+        #   @return [Array<String>, nil]
+        optional :sample_messages, Zavudev::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!method initialize(campaign_id:, description: nil, help_message: nil, message_flow: nil, name: nil, opt_in_keywords: nil, opt_out_keywords: nil, sample_messages: nil, request_options: {})
+        #   @param campaign_id [String]
+        #   @param description [String]
+        #   @param help_message [String]
+        #   @param message_flow [String]
+        #   @param name [String]
+        #   @param opt_in_keywords [Array<String>]
+        #   @param opt_out_keywords [Array<String>]
+        #   @param sample_messages [Array<String>]
+        #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      # @see Zavudev::Resources::Number10dlc::Campaigns#update
+      class CampaignUpdateResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute campaign
+        #
+        #   @return [Zavudev::Models::Number10dlc::TenDlcCampaign]
+        required :campaign, -> { Zavudev::Number10dlc::TenDlcCampaign }
+
+        # @!method initialize(campaign:)
+        #   @param campaign [Zavudev::Models::Number10dlc::TenDlcCampaign]
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/campaigns/phone_number_assign_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      module Campaigns
+        # @see Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers#assign
+        class PhoneNumberAssignParams < Zavudev::Internal::Type::BaseModel
+          extend Zavudev::Internal::Type::RequestParameters::Converter
+          include Zavudev::Internal::Type::RequestParameters
+
+          # @!attribute campaign_id
+          #
+          #   @return [String]
+          required :campaign_id, String
+
+          # @!attribute phone_number_id
+          #   ID of the phone number to assign.
+          #
+          #   @return [String]
+          required :phone_number_id, String, api_name: :phoneNumberId
+
+          # @!method initialize(campaign_id:, phone_number_id:, request_options: {})
+          #   @param campaign_id [String]
+          #
+          #   @param phone_number_id [String] ID of the phone number to assign.
+          #
+          #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/number_10dlc/campaigns/phone_number_assign_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Number10dlc
+      module Campaigns
+        # @see Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers#assign
+        class PhoneNumberAssignResponse < Zavudev::Internal::Type::BaseModel
+          # @!attribute assignment
+          #
+          #   @return [Zavudev::Models::Number10dlc::Campaigns::TenDlcPhoneNumberAssignment]
+          required :assignment, -> { Zavudev::Number10dlc::Campaigns::TenDlcPhoneNumberAssignment }
+
+          # @!method initialize(assignment:)
+          #   @param assignment [Zavudev::Models::Number10dlc::Campaigns::TenDlcPhoneNumberAssignment]
+        end
+      end
+    end
+  end
+end