zavudev 0.7.0 → 0.8.0

data/rbi/zavudev/models/invitation.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class Invitation < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Zavudev::Invitation, Zavudev::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Unique invitation token.
+      sig { returns(String) }
+      attr_accessor :token
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # Current status of the partner invitation.
+      sig { returns(Zavudev::Invitation::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Full URL to share with the client.
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :client_email
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :client_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :client_phone
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :completed_at
+
+      # ID of a pre-assigned Zavu phone number for WhatsApp registration.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number_id
+
+      # ID of the sender created when invitation is completed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sender_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :started_at
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :viewed_at
+
+      sig do
+        params(
+          id: String,
+          token: String,
+          created_at: Time,
+          expires_at: Time,
+          status: Zavudev::Invitation::Status::OrSymbol,
+          updated_at: Time,
+          url: String,
+          client_email: T.nilable(String),
+          client_name: T.nilable(String),
+          client_phone: T.nilable(String),
+          completed_at: T.nilable(Time),
+          phone_number_id: T.nilable(String),
+          sender_id: T.nilable(String),
+          started_at: T.nilable(Time),
+          viewed_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Unique invitation token.
+        token:,
+        created_at:,
+        expires_at:,
+        # Current status of the partner invitation.
+        status:,
+        updated_at:,
+        # Full URL to share with the client.
+        url:,
+        client_email: nil,
+        client_name: nil,
+        client_phone: nil,
+        completed_at: nil,
+        # ID of a pre-assigned Zavu phone number for WhatsApp registration.
+        phone_number_id: nil,
+        # ID of the sender created when invitation is completed.
+        sender_id: nil,
+        started_at: nil,
+        viewed_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            token: String,
+            created_at: Time,
+            expires_at: Time,
+            status: Zavudev::Invitation::Status::TaggedSymbol,
+            updated_at: Time,
+            url: String,
+            client_email: T.nilable(String),
+            client_name: T.nilable(String),
+            client_phone: T.nilable(String),
+            completed_at: T.nilable(Time),
+            phone_number_id: T.nilable(String),
+            sender_id: T.nilable(String),
+            started_at: T.nilable(Time),
+            viewed_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Current status of the partner invitation.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::Invitation::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:pending, Zavudev::Invitation::Status::TaggedSymbol)
+        IN_PROGRESS =
+          T.let(:in_progress, Zavudev::Invitation::Status::TaggedSymbol)
+        COMPLETED = T.let(:completed, Zavudev::Invitation::Status::TaggedSymbol)
+        EXPIRED = T.let(:expired, Zavudev::Invitation::Status::TaggedSymbol)
+        CANCELLED = T.let(:cancelled, Zavudev::Invitation::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Zavudev::Invitation::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_cancel_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCancelParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationCancelParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :invitation_id
+
+      sig do
+        params(
+          invitation_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(invitation_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { invitation_id: String, request_options: Zavudev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_cancel_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCancelResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::InvitationCancelResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Invitation) }
+      attr_reader :invitation
+
+      sig { params(invitation: Zavudev::Invitation::OrHash).void }
+      attr_writer :invitation
+
+      sig do
+        params(invitation: Zavudev::Invitation::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(invitation:)
+      end
+
+      sig { override.returns({ invitation: Zavudev::Invitation }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_create_params.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCreateParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationCreateParams, Zavudev::Internal::AnyHash)
+        end
+
+      # ISO country codes for allowed phone numbers.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :allowed_phone_countries
+
+      sig { params(allowed_phone_countries: T::Array[String]).void }
+      attr_writer :allowed_phone_countries
+
+      # Email of the client being invited.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_email
+
+      sig { params(client_email: String).void }
+      attr_writer :client_email
+
+      # Name of the client being invited.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_name
+
+      sig { params(client_name: String).void }
+      attr_writer :client_name
+
+      # Phone number of the client in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_phone
+
+      sig { params(client_phone: String).void }
+      attr_writer :client_phone
+
+      # Number of days until the invitation expires.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :expires_in_days
+
+      sig { params(expires_in_days: Integer).void }
+      attr_writer :expires_in_days
+
+      # ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      # the client will use this number instead of their own.
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number_id
+
+      sig { params(phone_number_id: String).void }
+      attr_writer :phone_number_id
+
+      sig do
+        params(
+          allowed_phone_countries: T::Array[String],
+          client_email: String,
+          client_name: String,
+          client_phone: String,
+          expires_in_days: Integer,
+          phone_number_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ISO country codes for allowed phone numbers.
+        allowed_phone_countries: nil,
+        # Email of the client being invited.
+        client_email: nil,
+        # Name of the client being invited.
+        client_name: nil,
+        # Phone number of the client in E.164 format.
+        client_phone: nil,
+        # Number of days until the invitation expires.
+        expires_in_days: nil,
+        # ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+        # the client will use this number instead of their own.
+        phone_number_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            allowed_phone_countries: T::Array[String],
+            client_email: String,
+            client_name: String,
+            client_phone: String,
+            expires_in_days: Integer,
+            phone_number_id: String,
+            request_options: Zavudev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_create_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationCreateResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::InvitationCreateResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Invitation) }
+      attr_reader :invitation
+
+      sig { params(invitation: Zavudev::Invitation::OrHash).void }
+      attr_writer :invitation
+
+      sig do
+        params(invitation: Zavudev::Invitation::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(invitation:)
+      end
+
+      sig { override.returns({ invitation: Zavudev::Invitation }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_list_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationListParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationListParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Current status of the partner invitation.
+      sig do
+        returns(T.nilable(Zavudev::InvitationListParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: Zavudev::InvitationListParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          status: Zavudev::InvitationListParams::Status::OrSymbol,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        cursor: nil,
+        limit: nil,
+        # Current status of the partner invitation.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            limit: Integer,
+            status: Zavudev::InvitationListParams::Status::OrSymbol,
+            request_options: Zavudev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Current status of the partner invitation.
+      module Status
+        extend Zavudev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Zavudev::InvitationListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(:pending, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        IN_PROGRESS =
+          T.let(
+            :in_progress,
+            Zavudev::InvitationListParams::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(:completed, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        EXPIRED =
+          T.let(:expired, Zavudev::InvitationListParams::Status::TaggedSymbol)
+        CANCELLED =
+          T.let(:cancelled, Zavudev::InvitationListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Zavudev::InvitationListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationRetrieveParams < Zavudev::Internal::Type::BaseModel
+      extend Zavudev::Internal::Type::RequestParameters::Converter
+      include Zavudev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Zavudev::InvitationRetrieveParams, Zavudev::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :invitation_id
+
+      sig do
+        params(
+          invitation_id: String,
+          request_options: Zavudev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(invitation_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { invitation_id: String, request_options: Zavudev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/zavudev/models/invitation_retrieve_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Zavudev
+  module Models
+    class InvitationRetrieveResponse < Zavudev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Zavudev::Models::InvitationRetrieveResponse,
+            Zavudev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Zavudev::Invitation) }
+      attr_reader :invitation
+
+      sig { params(invitation: Zavudev::Invitation::OrHash).void }
+      attr_writer :invitation
+
+      sig do
+        params(invitation: Zavudev::Invitation::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(invitation:)
+      end
+
+      sig { override.returns({ invitation: Zavudev::Invitation }) }
+      def to_hash
+      end
+    end
+  end
+end