Class: Azure::CognitiveServices::ImageSearch::V1_0::Models::Offer

Inherits:
Thing show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb

Overview

Defines a merchant’s offer.

Direct Known Subclasses

AggregateOffer

Instance Attribute Summary collapse

Attributes inherited from Thing

#alternate_name, #bing_id, #description, #image, #name, #url

Attributes inherited from Response

#read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Offer

Returns a new instance of Offer.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 16

def initialize
  @_type = "Offer"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 20

def _type
  @_type
end

#aggregate_rating ⇒ AggregateRating

the product has been rated by others.

Returns:



58
59
60
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 58

def aggregate_rating
  @aggregate_rating
end

#availability ⇒ ItemAvailability

the possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: ‘Discontinued’, ‘InStock’, ‘InStoreOnly’, ‘LimitedAvailability’, ‘OnlineOnly’, ‘OutOfStock’, ‘PreOrder’, ‘SoldOut’

Returns:



54
55
56
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 54

def availability
  @availability
end

#last_updated ⇒ String

in the form YYYY-MM-DD.

Returns:

  • (String) —

    The last date that the offer was updated. The date is



62
63
64
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 62

def last_updated
  @last_updated
end

#price ⇒ Float

Returns The item’s price.

Returns:

  • (Float) —

    The item’s price.



26
27
28
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 26

def price
  @price
end

#price_currency ⇒ Currency

values include: ‘USD’, ‘CAD’, ‘GBP’, ‘EUR’, ‘COP’, ‘JPY’, ‘CNY’, ‘AUD’, ‘INR’, ‘AED’, ‘AFN’, ‘ALL’, ‘AMD’, ‘ANG’, ‘AOA’, ‘ARS’, ‘AWG’, ‘AZN’, ‘BAM’, ‘BBD’, ‘BDT’, ‘BGN’, ‘BHD’, ‘BIF’, ‘BMD’, ‘BND’, ‘BOB’, ‘BOV’, ‘BRL’, ‘BSD’, ‘BTN’, ‘BWP’, ‘BYR’, ‘BZD’, ‘CDF’, ‘CHE’, ‘CHF’, ‘CHW’, ‘CLF’, ‘CLP’, ‘COU’, ‘CRC’, ‘CUC’, ‘CUP’, ‘CVE’, ‘CZK’, ‘DJF’, ‘DKK’, ‘DOP’, ‘DZD’, ‘EGP’, ‘ERN’, ‘ETB’, ‘FJD’, ‘FKP’, ‘GEL’, ‘GHS’, ‘GIP’, ‘GMD’, ‘GNF’, ‘GTQ’, ‘GYD’, ‘HKD’, ‘HNL’, ‘HRK’, ‘HTG’, ‘HUF’, ‘IDR’, ‘ILS’, ‘IQD’, ‘IRR’, ‘ISK’, ‘JMD’, ‘JOD’, ‘KES’, ‘KGS’, ‘KHR’, ‘KMF’, ‘KPW’, ‘KRW’, ‘KWD’, ‘KYD’, ‘KZT’, ‘LAK’, ‘LBP’, ‘LKR’, ‘LRD’, ‘LSL’, ‘LYD’, ‘MAD’, ‘MDL’, ‘MGA’, ‘MKD’, ‘MMK’, ‘MNT’, ‘MOP’, ‘MRO’, ‘MUR’, ‘MVR’, ‘MWK’, ‘MXN’, ‘MXV’, ‘MYR’, ‘MZN’, ‘NAD’, ‘NGN’, ‘NIO’, ‘NOK’, ‘NPR’, ‘NZD’, ‘OMR’, ‘PAB’, ‘PEN’, ‘PGK’, ‘PHP’, ‘PKR’, ‘PLN’, ‘PYG’, ‘QAR’, ‘RON’, ‘RSD’, ‘RUB’, ‘RWF’, ‘SAR’, ‘SBD’, ‘SCR’, ‘SDG’, ‘SEK’, ‘SGD’, ‘SHP’, ‘SLL’, ‘SOS’, ‘SRD’, ‘SSP’, ‘STD’, ‘SYP’, ‘SZL’, ‘THB’, ‘TJS’, ‘TMT’, ‘TND’, ‘TOP’, ‘TRY’, ‘TTD’, ‘TWD’, ‘TZS’, ‘UAH’, ‘UGX’, ‘UYU’, ‘UZS’, ‘VEF’, ‘VND’, ‘VUV’, ‘WST’, ‘XAF’, ‘XCD’, ‘XOF’, ‘XPF’, ‘YER’, ‘ZAR’, ‘ZMW’. Default value: ‘USD’ .

Returns:

  • (Currency) —

    The monetary currency. For example, USD. Possible



46
47
48
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 46

def price_currency
  @price_currency
end

#seller ⇒ Organization

Returns Seller for this offer.

Returns:



23
24
25
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 23

def seller
  @seller
end

Class Method Details

.mapper ⇒ Object

Mapper for Offer class as Ruby Hash. This will be used for serialization/deserialization.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/offer.rb', line 69

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Offer',
    type: {
      name: 'Composite',
      class_name: 'Offer',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        read_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readLink',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'url',
          type: {
            name: 'String'
          }
        },
        image: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'image',
          type: {
            name: 'Composite',
            class_name: 'ImageObject'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        alternate_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'alternateName',
          type: {
            name: 'String'
          }
        },
        bing_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'bingId',
          type: {
            name: 'String'
          }
        },
        seller: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'seller',
          type: {
            name: 'Composite',
            class_name: 'Organization'
          }
        },
        price: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'price',
          type: {
            name: 'Double'
          }
        },
        price_currency: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'priceCurrency',
          default_value: 'USD',
          type: {
            name: 'String'
          }
        },
        availability: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'availability',
          type: {
            name: 'String'
          }
        },
        aggregate_rating: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'aggregateRating',
          type: {
            name: 'Composite',
            class_name: 'AggregateRating'
          }
        },
        last_updated: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'lastUpdated',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end