Class: MasterCard::API::Qkr::User

Inherits:
Core::Model::BaseObject
  • Object
show all
Includes:
Core::Model
Defined in:
lib/mastercard/api/qkr/user.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create(mapObj) ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'lib/mastercard/api/qkr/user.rb', line 63

def self.create(mapObj)
    #
    #Creates object of type User
    #
    #@param Dict mapObj, containing the required parameters to create a new object
    #@return [User] of the response of created instance.
    #@raise [APIException] an exception from the response status
    return self.execute("a5c612df-dcce-4b7a-889b-fe0479a60a7d", User.new(mapObj))
end

.deleteById(id, map = nil) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/mastercard/api/qkr/user.rb', line 82

def self.deleteById(id, map = nil)
    #Delete object of type User by id

    #@param [String] id
    #@param [Dict] map, containing additional parameters
    #@return [User] of the response of the deleted instance.
    #@raise [APIException] an exception from the response status


    mapObj = User.new
    if !(id.nil? || id.to_s.empty?)
      mapObj.set("id", id)
    end
    if !map.nil?
        if map.instance_of? RequestMap
          mapObj.setAll(map.getObject())
        else
          mapObj.setAll(map)
        end
    end

    return self.execute("5501e030-acd3-498c-aeea-f19bc78db843", mapObj)
end

.query(criteria) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/mastercard/api/qkr/user.rb', line 127

def self.query(criteria)
    #
    #Query objects of type User by id and optional criteria
    #@param [Dict] criteria
    #@return [User] object representing the response.
    #@raise [APIException] an exception from the response status
    #

    return self.execute("eaf5ebe4-5582-49f0-9f56-f0c74e4dea44",User.new(criteria))
end

Instance Method Details

#delete ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/mastercard/api/qkr/user.rb', line 107

def delete
    #
    #Delete object of type User

    #@param [String] id
    #@return [User] of the response of the deleted instance.
    #@raise [APIException] an exception from the response status
    #

    return self.class.execute("5501e030-acd3-498c-aeea-f19bc78db843", self)
end

#update ⇒ Object 



140
141
142
143
144
145
146
147
148
 
# File 'lib/mastercard/api/qkr/user.rb', line 140

def update
    #
    #Updates an object of type User
    #
    #@return [User] object representing the response.
    #@raise [APIException] an exception from the response status
    #
    return self.class.execute("ea202c1d-a575-498c-bc46-1712c0d0ac47",self)
end