zavudev 0.7.0 → 0.9.0

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

data/lib/zavudev/models/senders/whats_app_sync_contacts.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      class WhatsAppSyncContacts < Zavudev::Internal::Type::BaseModel
+        # @!attribute can_sync
+        #   Whether contacts sync can be initiated.
+        #
+        #   @return [Boolean]
+        required :can_sync, Zavudev::Internal::Type::Boolean, api_name: :canSync
+
+        # @!attribute status
+        #   Status of WhatsApp contacts sync.
+        #
+        #   @return [Symbol, Zavudev::Models::Senders::WhatsAppSyncContacts::Status]
+        required :status, enum: -> { Zavudev::Senders::WhatsAppSyncContacts::Status }
+
+        # @!attribute requested_at
+        #   When the sync was last requested.
+        #
+        #   @return [Time, nil]
+        optional :requested_at, Time, api_name: :requestedAt, nil?: true
+
+        # @!method initialize(can_sync:, status:, requested_at: nil)
+        #   Contacts sync status details.
+        #
+        #   @param can_sync [Boolean] Whether contacts sync can be initiated.
+        #
+        #   @param status [Symbol, Zavudev::Models::Senders::WhatsAppSyncContacts::Status] Status of WhatsApp contacts sync.
+        #
+        #   @param requested_at [Time, nil] When the sync was last requested.
+
+        # Status of WhatsApp contacts sync.
+        #
+        # @see Zavudev::Models::Senders::WhatsAppSyncContacts#status
+        module Status
+          extend Zavudev::Internal::Type::Enum
+
+          NOT_REQUESTED = :not_requested
+          PENDING = :pending
+          SYNCING = :syncing
+          COMPLETED = :completed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/senders/whats_app_sync_history.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      class WhatsAppSyncHistory < Zavudev::Internal::Type::BaseModel
+        # @!attribute can_sync
+        #   Whether history sync can be initiated.
+        #
+        #   @return [Boolean]
+        required :can_sync, Zavudev::Internal::Type::Boolean, api_name: :canSync
+
+        # @!attribute status
+        #   Status of WhatsApp message history sync.
+        #
+        #   @return [Symbol, Zavudev::Models::Senders::WhatsAppSyncHistory::Status]
+        required :status, enum: -> { Zavudev::Senders::WhatsAppSyncHistory::Status }
+
+        # @!attribute completed_at
+        #   When the sync was completed.
+        #
+        #   @return [Time, nil]
+        optional :completed_at, Time, api_name: :completedAt, nil?: true
+
+        # @!attribute requested_at
+        #   When the sync was last requested.
+        #
+        #   @return [Time, nil]
+        optional :requested_at, Time, api_name: :requestedAt, nil?: true
+
+        # @!method initialize(can_sync:, status:, completed_at: nil, requested_at: nil)
+        #   History sync status details.
+        #
+        #   @param can_sync [Boolean] Whether history sync can be initiated.
+        #
+        #   @param status [Symbol, Zavudev::Models::Senders::WhatsAppSyncHistory::Status] Status of WhatsApp message history sync.
+        #
+        #   @param completed_at [Time, nil] When the sync was completed.
+        #
+        #   @param requested_at [Time, nil] When the sync was last requested.
+
+        # Status of WhatsApp message history sync.
+        #
+        # @see Zavudev::Models::Senders::WhatsAppSyncHistory#status
+        module Status
+          extend Zavudev::Internal::Type::Enum
+
+          NOT_REQUESTED = :not_requested
+          PENDING = :pending
+          SYNCING = :syncing
+          COMPLETED = :completed
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/senders/whats_app_sync_status.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      class WhatsAppSyncStatus < Zavudev::Internal::Type::BaseModel
+        # @!attribute contacts
+        #   Contacts sync status details.
+        #
+        #   @return [Zavudev::Models::Senders::WhatsAppSyncContacts]
+        required :contacts, -> { Zavudev::Senders::WhatsAppSyncContacts }
+
+        # @!attribute history
+        #   History sync status details.
+        #
+        #   @return [Zavudev::Models::Senders::WhatsAppSyncHistory]
+        required :history, -> { Zavudev::Senders::WhatsAppSyncHistory }
+
+        # @!attribute is_coexistence
+        #   Whether the account is in coexistence mode.
+        #
+        #   @return [Boolean]
+        required :is_coexistence, Zavudev::Internal::Type::Boolean, api_name: :isCoexistence
+
+        # @!attribute status
+        #   WhatsApp account status.
+        #
+        #   @return [Symbol, Zavudev::Models::Senders::WhatsAppSyncStatus::Status]
+        required :status, enum: -> { Zavudev::Senders::WhatsAppSyncStatus::Status }
+
+        # @!method initialize(contacts:, history:, is_coexistence:, status:)
+        #   WhatsApp coexistence sync status.
+        #
+        #   @param contacts [Zavudev::Models::Senders::WhatsAppSyncContacts] Contacts sync status details.
+        #
+        #   @param history [Zavudev::Models::Senders::WhatsAppSyncHistory] History sync status details.
+        #
+        #   @param is_coexistence [Boolean] Whether the account is in coexistence mode.
+        #
+        #   @param status [Symbol, Zavudev::Models::Senders::WhatsAppSyncStatus::Status] WhatsApp account status.
+
+        # WhatsApp account status.
+        #
+        # @see Zavudev::Models::Senders::WhatsAppSyncStatus#status
+        module Status
+          extend Zavudev::Internal::Type::Enum
+
+          PENDING_VERIFICATION = :pending_verification
+          PENDING_REGISTRATION = :pending_registration
+          ACTIVE = :active
+          DISCONNECTED = :disconnected
+          ERROR = :error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/models/senders/whatsapp_sync_retrieve_params.rb

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

data/lib/zavudev/models/senders/whatsapp_sync_retrieve_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      # @see Zavudev::Resources::Senders::WhatsappSync#retrieve
+      class WhatsappSyncRetrieveResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute sync
+        #   WhatsApp coexistence sync status.
+        #
+        #   @return [Zavudev::Models::Senders::WhatsAppSyncStatus]
+        required :sync, -> { Zavudev::Senders::WhatsAppSyncStatus }
+
+        # @!method initialize(sync:)
+        #   @param sync [Zavudev::Models::Senders::WhatsAppSyncStatus] WhatsApp coexistence sync status.
+      end
+    end
+  end
+end

data/lib/zavudev/models/senders/whatsapp_sync_start_contacts_sync_params.rb

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

data/lib/zavudev/models/senders/whatsapp_sync_start_contacts_sync_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      # @see Zavudev::Resources::Senders::WhatsappSync#start_contacts_sync
+      class WhatsappSyncStartContactsSyncResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute message
+        #   Success message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute sync
+        #   WhatsApp coexistence sync status.
+        #
+        #   @return [Zavudev::Models::Senders::WhatsAppSyncStatus]
+        required :sync, -> { Zavudev::Senders::WhatsAppSyncStatus }
+
+        # @!method initialize(message:, sync:)
+        #   @param message [String] Success message.
+        #
+        #   @param sync [Zavudev::Models::Senders::WhatsAppSyncStatus] WhatsApp coexistence sync status.
+      end
+    end
+  end
+end

data/lib/zavudev/models/senders/whatsapp_sync_start_history_sync_params.rb

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

data/lib/zavudev/models/senders/whatsapp_sync_start_history_sync_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    module Senders
+      # @see Zavudev::Resources::Senders::WhatsappSync#start_history_sync
+      class WhatsappSyncStartHistorySyncResponse < Zavudev::Internal::Type::BaseModel
+        # @!attribute message
+        #   Success message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute sync
+        #   WhatsApp coexistence sync status.
+        #
+        #   @return [Zavudev::Models::Senders::WhatsAppSyncStatus]
+        required :sync, -> { Zavudev::Senders::WhatsAppSyncStatus }
+
+        # @!method initialize(message:, sync:)
+        #   @param message [String] Success message.
+        #
+        #   @param sync [Zavudev::Models::Senders::WhatsAppSyncStatus] WhatsApp coexistence sync status.
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_account.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#list
+    class SubAccount < Zavudev::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Zavudev::Models::SubAccount::Status]
+      required :status, enum: -> { Zavudev::SubAccount::Status }
+
+      # @!attribute total_spent
+      #   Total amount spent by this sub-account in cents.
+      #
+      #   @return [Integer]
+      required :total_spent, Integer, api_name: :totalSpent
+
+      # @!attribute api_key
+      #   API key for the sub-account. Only returned on creation.
+      #
+      #   @return [String, nil]
+      optional :api_key, String, api_name: :apiKey
+
+      # @!attribute credit_limit
+      #   Spending cap in cents. When reached, messages from this sub-account will be
+      #   blocked.
+      #
+      #   @return [Integer, nil]
+      optional :credit_limit, Integer, api_name: :creditLimit, nil?: true
+
+      # @!attribute external_id
+      #   External reference ID set by the parent account.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, api_name: :externalId, nil?: true
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[Zavudev::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(id:, created_at:, name:, status:, total_spent:, api_key: nil, credit_limit: nil, external_id: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::SubAccount} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param name [String]
+      #
+      #   @param status [Symbol, Zavudev::Models::SubAccount::Status]
+      #
+      #   @param total_spent [Integer] Total amount spent by this sub-account in cents.
+      #
+      #   @param api_key [String] API key for the sub-account. Only returned on creation.
+      #
+      #   @param credit_limit [Integer, nil] Spending cap in cents. When reached, messages from this sub-account will be bloc
+      #
+      #   @param external_id [String, nil] External reference ID set by the parent account.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil]
+
+      # @see Zavudev::Models::SubAccount#status
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/zavudev/models/sub_account_create_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#create
+    class SubAccountCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Name of the sub-account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute credit_limit
+      #   Spending cap in cents. When reached, messages from this sub-account will be
+      #   blocked. Omit or set to 0 for no limit.
+      #
+      #   @return [Integer, nil]
+      optional :credit_limit, Integer, api_name: :creditLimit
+
+      # @!attribute external_id
+      #   External reference ID for your own tracking.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, api_name: :externalId
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Zavudev::Internal::Type::HashOf[Zavudev::Internal::Type::Unknown]
+
+      # @!method initialize(name:, credit_limit: nil, external_id: nil, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Zavudev::Models::SubAccountCreateParams} for more details.
+      #
+      #   @param name [String] Name of the sub-account.
+      #
+      #   @param credit_limit [Integer] Spending cap in cents. When reached, messages from this sub-account will be bloc
+      #
+      #   @param external_id [String] External reference ID for your own tracking.
+      #
+      #   @param metadata [Hash{Symbol=>Object}]
+      #
+      #   @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#create
+    class SubAccountCreateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute sub_account
+      #
+      #   @return [Zavudev::Models::SubAccount]
+      required :sub_account, -> { Zavudev::SubAccount }, api_name: :subAccount
+
+      # @!method initialize(sub_account:)
+      #   @param sub_account [Zavudev::Models::SubAccount]
+    end
+  end
+end

data/lib/zavudev/models/sub_account_deactivate_params.rb

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

data/lib/zavudev/models/sub_account_deactivate_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Models
+    # @see Zavudev::Resources::SubAccounts#deactivate
+    class SubAccountDeactivateResponse < Zavudev::Internal::Type::BaseModel
+      # @!attribute keys_revoked
+      #   Number of API keys revoked.
+      #
+      #   @return [Integer]
+      required :keys_revoked, Integer, api_name: :keysRevoked
+
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!method initialize(keys_revoked:, message:)
+      #   @param keys_revoked [Integer] Number of API keys revoked.
+      #
+      #   @param message [String]
+    end
+  end
+end