|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module BrandDev |
| 4 | + module Models |
| 5 | + # @see BrandDev::Resources::Brand#ai_products |
| 6 | + class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel |
| 7 | + # @!attribute products |
| 8 | + # Array of products extracted from the website |
| 9 | + # |
| 10 | + # @return [Array<BrandDev::Models::BrandAIProductsResponse::Product>, nil] |
| 11 | + optional :products, |
| 12 | + -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIProductsResponse::Product] } |
| 13 | + |
| 14 | + # @!method initialize(products: nil) |
| 15 | + # @param products [Array<BrandDev::Models::BrandAIProductsResponse::Product>] Array of products extracted from the website |
| 16 | + |
| 17 | + class Product < BrandDev::Internal::Type::BaseModel |
| 18 | + # @!attribute description |
| 19 | + # Description of the product |
| 20 | + # |
| 21 | + # @return [String] |
| 22 | + required :description, String |
| 23 | + |
| 24 | + # @!attribute features |
| 25 | + # List of product features |
| 26 | + # |
| 27 | + # @return [Array<String>] |
| 28 | + required :features, BrandDev::Internal::Type::ArrayOf[String] |
| 29 | + |
| 30 | + # @!attribute name |
| 31 | + # Name of the product |
| 32 | + # |
| 33 | + # @return [String] |
| 34 | + required :name, String |
| 35 | + |
| 36 | + # @!attribute tags |
| 37 | + # Tags associated with the product |
| 38 | + # |
| 39 | + # @return [Array<String>] |
| 40 | + required :tags, BrandDev::Internal::Type::ArrayOf[String] |
| 41 | + |
| 42 | + # @!attribute target_audience |
| 43 | + # Target audience for the product (array of strings) |
| 44 | + # |
| 45 | + # @return [Array<String>] |
| 46 | + required :target_audience, BrandDev::Internal::Type::ArrayOf[String] |
| 47 | + |
| 48 | + # @!attribute billing_frequency |
| 49 | + # Billing frequency for the product |
| 50 | + # |
| 51 | + # @return [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil] |
| 52 | + optional :billing_frequency, |
| 53 | + enum: -> { BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency }, |
| 54 | + nil?: true |
| 55 | + |
| 56 | + # @!attribute category |
| 57 | + # Category of the product |
| 58 | + # |
| 59 | + # @return [String, nil] |
| 60 | + optional :category, String, nil?: true |
| 61 | + |
| 62 | + # @!attribute currency |
| 63 | + # Currency code for the price (e.g., USD, EUR) |
| 64 | + # |
| 65 | + # @return [String, nil] |
| 66 | + optional :currency, String, nil?: true |
| 67 | + |
| 68 | + # @!attribute image_url |
| 69 | + # URL to the product image |
| 70 | + # |
| 71 | + # @return [String, nil] |
| 72 | + optional :image_url, String, nil?: true |
| 73 | + |
| 74 | + # @!attribute price |
| 75 | + # Price of the product |
| 76 | + # |
| 77 | + # @return [Float, nil] |
| 78 | + optional :price, Float, nil?: true |
| 79 | + |
| 80 | + # @!attribute pricing_model |
| 81 | + # Pricing model for the product |
| 82 | + # |
| 83 | + # @return [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] |
| 84 | + optional :pricing_model, |
| 85 | + enum: -> { BrandDev::Models::BrandAIProductsResponse::Product::PricingModel }, |
| 86 | + nil?: true |
| 87 | + |
| 88 | + # @!attribute url |
| 89 | + # URL to the product page |
| 90 | + # |
| 91 | + # @return [String, nil] |
| 92 | + optional :url, String, nil?: true |
| 93 | + |
| 94 | + # @!method initialize(description:, features:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) |
| 95 | + # @param description [String] Description of the product |
| 96 | + # |
| 97 | + # @param features [Array<String>] List of product features |
| 98 | + # |
| 99 | + # @param name [String] Name of the product |
| 100 | + # |
| 101 | + # @param tags [Array<String>] Tags associated with the product |
| 102 | + # |
| 103 | + # @param target_audience [Array<String>] Target audience for the product (array of strings) |
| 104 | + # |
| 105 | + # @param billing_frequency [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil] Billing frequency for the product |
| 106 | + # |
| 107 | + # @param category [String, nil] Category of the product |
| 108 | + # |
| 109 | + # @param currency [String, nil] Currency code for the price (e.g., USD, EUR) |
| 110 | + # |
| 111 | + # @param image_url [String, nil] URL to the product image |
| 112 | + # |
| 113 | + # @param price [Float, nil] Price of the product |
| 114 | + # |
| 115 | + # @param pricing_model [Symbol, BrandDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] Pricing model for the product |
| 116 | + # |
| 117 | + # @param url [String, nil] URL to the product page |
| 118 | + |
| 119 | + # Billing frequency for the product |
| 120 | + # |
| 121 | + # @see BrandDev::Models::BrandAIProductsResponse::Product#billing_frequency |
| 122 | + module BillingFrequency |
| 123 | + extend BrandDev::Internal::Type::Enum |
| 124 | + |
| 125 | + MONTHLY = :monthly |
| 126 | + YEARLY = :yearly |
| 127 | + ONE_TIME = :one_time |
| 128 | + USAGE_BASED = :usage_based |
| 129 | + |
| 130 | + # @!method self.values |
| 131 | + # @return [Array<Symbol>] |
| 132 | + end |
| 133 | + |
| 134 | + # Pricing model for the product |
| 135 | + # |
| 136 | + # @see BrandDev::Models::BrandAIProductsResponse::Product#pricing_model |
| 137 | + module PricingModel |
| 138 | + extend BrandDev::Internal::Type::Enum |
| 139 | + |
| 140 | + PER_SEAT = :per_seat |
| 141 | + FLAT = :flat |
| 142 | + TIERED = :tiered |
| 143 | + FREEMIUM = :freemium |
| 144 | + CUSTOM = :custom |
| 145 | + |
| 146 | + # @!method self.values |
| 147 | + # @return [Array<Symbol>] |
| 148 | + end |
| 149 | + end |
| 150 | + end |
| 151 | + end |
| 152 | +end |
0 commit comments