Class: PinterestSdkClient::AdAccountCreateSubscriptionResponse

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/ad_account_create_subscription_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AdAccountCreateSubscriptionResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



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
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::AdAccountCreateSubscriptionResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::AdAccountCreateSubscriptionResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'ad_account_id')
    self. = attributes[:'ad_account_id']
  end

  if attributes.key?(:'api_version')
    self.api_version = attributes[:'api_version']
  end

  if attributes.key?(:'created_time')
    self.created_time = attributes[:'created_time']
  end

  if attributes.key?(:'cryptographic_algorithm')
    self.cryptographic_algorithm = attributes[:'cryptographic_algorithm']
  end

  if attributes.key?(:'cryptographic_key')
    self.cryptographic_key = attributes[:'cryptographic_key']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'lead_form_id')
    self.lead_form_id = attributes[:'lead_form_id']
  end

  if attributes.key?(:'user_account_id')
    self. = attributes[:'user_account_id']
  end

  if attributes.key?(:'webhook_url')
    self.webhook_url = attributes[:'webhook_url']
  end
end

Instance Attribute Details

#ad_account_idObject

The Ad Account ID that this lead form belongs to.



19
20
21
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 19

def 
  @ad_account_id
end

#api_versionObject

API version.



22
23
24
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 22

def api_version
  @api_version
end

#created_timeObject

Subscription creation time. Unix timestamp in milliseconds.



25
26
27
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 25

def created_time
  @created_time
end

#cryptographic_algorithmObject

Lead data encryption algorithm.



28
29
30
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 28

def cryptographic_algorithm
  @cryptographic_algorithm
end

#cryptographic_keyObject

Base64 encoded key for client to decrypt lead data.



31
32
33
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 31

def cryptographic_key
  @cryptographic_key
end

#idObject

Subscription ID.



34
35
36
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 34

def id
  @id
end

#lead_form_idObject

Lead form ID.



37
38
39
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 37

def lead_form_id
  @lead_form_id
end

#user_account_idObject

User account used to subscribe lead data.



40
41
42
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 40

def 
  @user_account_id
end

#webhook_urlObject

Standard HTTPS webhook URL.



43
44
45
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 43

def webhook_url
  @webhook_url
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



61
62
63
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



66
67
68
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 46

def self.attribute_map
  {
    :'ad_account_id' => :'ad_account_id',
    :'api_version' => :'api_version',
    :'created_time' => :'created_time',
    :'cryptographic_algorithm' => :'cryptographic_algorithm',
    :'cryptographic_key' => :'cryptographic_key',
    :'id' => :'id',
    :'lead_form_id' => :'lead_form_id',
    :'user_account_id' => :'user_account_id',
    :'webhook_url' => :'webhook_url'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 273

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



86
87
88
89
90
91
92
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 86

def self.openapi_nullable
  Set.new([
    :'cryptographic_algorithm',
    :'cryptographic_key',
    :'lead_form_id',
  ])
end

.openapi_typesObject

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 71

def self.openapi_types
  {
    :'ad_account_id' => :'String',
    :'api_version' => :'String',
    :'created_time' => :'Integer',
    :'cryptographic_algorithm' => :'String',
    :'cryptographic_key' => :'String',
    :'id' => :'String',
    :'lead_form_id' => :'String',
    :'user_account_id' => :'String',
    :'webhook_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      api_version == o.api_version &&
      created_time == o.created_time &&
      cryptographic_algorithm == o.cryptographic_algorithm &&
      cryptographic_key == o.cryptographic_key &&
      id == o.id &&
      lead_form_id == o.lead_form_id &&
       == o. &&
      webhook_url == o.webhook_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


260
261
262
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 260

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



266
267
268
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 266

def hash
  [, api_version, created_time, cryptographic_algorithm, cryptographic_key, id, lead_form_id, , webhook_url].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 149

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@ad_account_id.nil? && @ad_account_id !~ pattern
    invalid_properties.push("invalid value for \"ad_account_id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@lead_form_id.nil? && @lead_form_id !~ pattern
    invalid_properties.push("invalid value for \"lead_form_id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@user_account_id.nil? && @user_account_id !~ pattern
    invalid_properties.push("invalid value for \"user_account_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 295

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



177
178
179
180
181
182
183
184
# File 'lib/pinterest_sdk/models/ad_account_create_subscription_response.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@ad_account_id.nil? && @ad_account_id !~ Regexp.new(/^\d+$/)
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  return false if !@lead_form_id.nil? && @lead_form_id !~ Regexp.new(/^\d+$/)
  return false if !@user_account_id.nil? && @user_account_id !~ Regexp.new(/^\d+$/)
  true
end