context.dev 0.0.2

data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi

@@ -0,0 +1,763 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::BrandRetrieveSimplifiedResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Simplified brand information
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand)
+        )
+      end
+      attr_reader :brand
+
+      sig do
+        params(
+          brand:
+            ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash
+        ).void
+      end
+      attr_writer :brand
+
+      # HTTP status code of the response
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :code
+
+      sig { params(code: Integer).void }
+      attr_writer :code
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      sig do
+        params(
+          brand:
+            ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
+          code: Integer,
+          status: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Simplified brand information
+        brand: nil,
+        # HTTP status code of the response
+        code: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
+            code: Integer,
+            status: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Brand < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # An array of backdrop images for the brand
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop
+              ]
+            )
+          )
+        end
+        attr_reader :backdrops
+
+        sig do
+          params(
+            backdrops:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::OrHash
+              ]
+          ).void
+        end
+        attr_writer :backdrops
+
+        # An array of brand colors
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color
+              ]
+            )
+          )
+        end
+        attr_reader :colors
+
+        sig do
+          params(
+            colors:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::OrHash
+              ]
+          ).void
+        end
+        attr_writer :colors
+
+        # The domain name of the brand
+        sig { returns(T.nilable(String)) }
+        attr_reader :domain
+
+        sig { params(domain: String).void }
+        attr_writer :domain
+
+        # An array of logos associated with the brand
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo
+              ]
+            )
+          )
+        end
+        attr_reader :logos
+
+        sig do
+          params(
+            logos:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::OrHash
+              ]
+          ).void
+        end
+        attr_writer :logos
+
+        # The title or name of the brand
+        sig { returns(T.nilable(String)) }
+        attr_reader :title
+
+        sig { params(title: String).void }
+        attr_writer :title
+
+        # Simplified brand information
+        sig do
+          params(
+            backdrops:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::OrHash
+              ],
+            colors:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::OrHash
+              ],
+            domain: String,
+            logos:
+              T::Array[
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::OrHash
+              ],
+            title: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of backdrop images for the brand
+          backdrops: nil,
+          # An array of brand colors
+          colors: nil,
+          # The domain name of the brand
+          domain: nil,
+          # An array of logos associated with the brand
+          logos: nil,
+          # The title or name of the brand
+          title: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              backdrops:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop
+                ],
+              colors:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color
+                ],
+              domain: String,
+              logos:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo
+                ],
+              title: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Backdrop < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Array of colors in the backdrop image
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color
+                ]
+              )
+            )
+          end
+          attr_reader :colors
+
+          sig do
+            params(
+              colors:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color::OrHash
+                ]
+            ).void
+          end
+          attr_writer :colors
+
+          # Resolution of the backdrop image
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution
+              )
+            )
+          end
+          attr_reader :resolution
+
+          sig do
+            params(
+              resolution:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution::OrHash
+            ).void
+          end
+          attr_writer :resolution
+
+          # URL of the backdrop image
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          sig do
+            params(
+              colors:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color::OrHash
+                ],
+              resolution:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution::OrHash,
+              url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of colors in the backdrop image
+            colors: nil,
+            # Resolution of the backdrop image
+            resolution: nil,
+            # URL of the backdrop image
+            url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                colors:
+                  T::Array[
+                    ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color
+                  ],
+                resolution:
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
+                url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Color < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Color in hexadecimal format
+            sig { returns(T.nilable(String)) }
+            attr_reader :hex
+
+            sig { params(hex: String).void }
+            attr_writer :hex
+
+            # Name of the color
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            sig { params(hex: String, name: String).returns(T.attached_class) }
+            def self.new(
+              # Color in hexadecimal format
+              hex: nil,
+              # Name of the color
+              name: nil
+            )
+            end
+
+            sig { override.returns({ hex: String, name: String }) }
+            def to_hash
+            end
+          end
+
+          class Resolution < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Aspect ratio of the image (width/height)
+            sig { returns(T.nilable(Float)) }
+            attr_reader :aspect_ratio
+
+            sig { params(aspect_ratio: Float).void }
+            attr_writer :aspect_ratio
+
+            # Height of the image in pixels
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :height
+
+            sig { params(height: Integer).void }
+            attr_writer :height
+
+            # Width of the image in pixels
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :width
+
+            sig { params(width: Integer).void }
+            attr_writer :width
+
+            # Resolution of the backdrop image
+            sig do
+              params(
+                aspect_ratio: Float,
+                height: Integer,
+                width: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Aspect ratio of the image (width/height)
+              aspect_ratio: nil,
+              # Height of the image in pixels
+              height: nil,
+              # Width of the image in pixels
+              width: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { aspect_ratio: Float, height: Integer, width: Integer }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
+        class Color < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Color in hexadecimal format
+          sig { returns(T.nilable(String)) }
+          attr_reader :hex
+
+          sig { params(hex: String).void }
+          attr_writer :hex
+
+          # Name of the color
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          sig { params(hex: String, name: String).returns(T.attached_class) }
+          def self.new(
+            # Color in hexadecimal format
+            hex: nil,
+            # Name of the color
+            name: nil
+          )
+          end
+
+          sig { override.returns({ hex: String, name: String }) }
+          def to_hash
+          end
+        end
+
+        class Logo < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Array of colors in the logo
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color
+                ]
+              )
+            )
+          end
+          attr_reader :colors
+
+          sig do
+            params(
+              colors:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color::OrHash
+                ]
+            ).void
+          end
+          attr_writer :colors
+
+          # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          # best for dark mode, 'has_opaque_background' = can be used for either as image
+          # has its own background
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :mode
+
+          sig do
+            params(
+              mode:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::OrSymbol
+            ).void
+          end
+          attr_writer :mode
+
+          # Resolution of the logo image
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution
+              )
+            )
+          end
+          attr_reader :resolution
+
+          sig do
+            params(
+              resolution:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution::OrHash
+            ).void
+          end
+          attr_writer :resolution
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          # CDN hosted url of the logo (ready for display)
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          sig do
+            params(
+              colors:
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color::OrHash
+                ],
+              mode:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::OrSymbol,
+              resolution:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution::OrHash,
+              type:
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::OrSymbol,
+              url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of colors in the logo
+            colors: nil,
+            # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+            # best for dark mode, 'has_opaque_background' = can be used for either as image
+            # has its own background
+            mode: nil,
+            # Resolution of the logo image
+            resolution: nil,
+            # Type of the logo based on resolution (e.g., 'icon', 'logo')
+            type: nil,
+            # CDN hosted url of the logo (ready for display)
+            url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                colors:
+                  T::Array[
+                    ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color
+                  ],
+                mode:
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol,
+                resolution:
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
+                type:
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol,
+                url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Color < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Color in hexadecimal format
+            sig { returns(T.nilable(String)) }
+            attr_reader :hex
+
+            sig { params(hex: String).void }
+            attr_writer :hex
+
+            # Name of the color
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            sig { params(hex: String, name: String).returns(T.attached_class) }
+            def self.new(
+              # Color in hexadecimal format
+              hex: nil,
+              # Name of the color
+              name: nil
+            )
+            end
+
+            sig { override.returns({ hex: String, name: String }) }
+            def to_hash
+            end
+          end
+
+          # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
+          # best for dark mode, 'has_opaque_background' = can be used for either as image
+          # has its own background
+          module Mode
+            extend ContextDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LIGHT =
+              T.let(
+                :light,
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            DARK =
+              T.let(
+                :dark,
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+            HAS_OPAQUE_BACKGROUND =
+              T.let(
+                :has_opaque_background,
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Resolution < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Aspect ratio of the image (width/height)
+            sig { returns(T.nilable(Float)) }
+            attr_reader :aspect_ratio
+
+            sig { params(aspect_ratio: Float).void }
+            attr_writer :aspect_ratio
+
+            # Height of the image in pixels
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :height
+
+            sig { params(height: Integer).void }
+            attr_writer :height
+
+            # Width of the image in pixels
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :width
+
+            sig { params(width: Integer).void }
+            attr_writer :width
+
+            # Resolution of the logo image
+            sig do
+              params(
+                aspect_ratio: Float,
+                height: Integer,
+                width: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Aspect ratio of the image (width/height)
+              aspect_ratio: nil,
+              # Height of the image in pixels
+              height: nil,
+              # Width of the image in pixels
+              width: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { aspect_ratio: Float, height: Integer, width: Integer }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          # Type of the logo based on resolution (e.g., 'icon', 'logo')
+          module Type
+            extend ContextDev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ICON =
+              T.let(
+                :icon,
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
+              )
+            LOGO =
+              T.let(
+                :logo,
+                ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end