Class: PayPal::SDK::REST::DataTypes::Order

Inherits:
Base show all
Includes:
RequestDataType
Defined in:
lib/paypal-sdk/rest/data_types.rb

Constant Summary

Constants inherited from Core::API::DataTypes::Base

Core::API::DataTypes::Base::ContentKey, Core::API::DataTypes::Base::HashOptions

Instance Attribute Summary

Attributes inherited from Base

#error, #header, #request_id

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RequestDataType

#api, api, #error=, included

Methods included from SetAPI

#client_id=, #client_secret=, #set_config, #token=

Methods inherited from Base

#http_header, #merge!, #raise_error!, raise_on_api_error, #success?

Methods inherited from Core::API::DataTypes::Base

add_attribute, add_member, array_of, #convert_array, #convert_object, define_alias_methods, #hash_key, #initialize, #member_names, members, #members, #merge!, object_of, #set, #skip_value?, snakecase, #to_hash, #value_to_hash

Methods included from Core::Logging

#log_event, #logger, logger, logger=

Constructor Details

This class inherits a constructor from PayPal::SDK::Core::API::DataTypes::Base

Class Method Details

.find(resource_id) ⇒ Object

Raises:

  • (ArgumentError) 


924
925
926
927
928
 
# File 'lib/paypal-sdk/rest/data_types.rb', line 924

def find(resource_id)
  raise ArgumentError.new("id required") if resource_id.to_s.strip.empty?
  path = "v1/payments/orders/#{resource_id}"
  self.new(api.get(path))
end

.load_members ⇒ Object 



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/paypal-sdk/rest/data_types.rb', line 903

def self.load_members
  object_of :id, String
  object_of :purchase_unit_reference_id, String # Deprecated - use :reference_id instead
  object_of :reference_id, String
  object_of :amount, Amount
  object_of :payment_mode, String
  object_of :state, String
  object_of :reason_code, String
  object_of :pending_reason, String
  object_of :protection_eligibility, String
  object_of :protection_eligibility_type, String
  object_of :parent_payment, String
  object_of :fmf_details, FmfDetails
  object_of :create_time, String
  object_of :update_time, String
  array_of  :links, Links
end

Instance Method Details

#authorize ⇒ Object 



945
946
947
948
949
 
# File 'lib/paypal-sdk/rest/data_types.rb', line 945

def authorize()
  path = "v1/payments/orders/#{self.id}/authorize"
  response = api.post(path, self.to_hash, http_header)
  Authorization.new(response)
end

#capture(capture) ⇒ Object 



931
932
933
934
935
936
 
# File 'lib/paypal-sdk/rest/data_types.rb', line 931

def capture(capture)
  capture = Capture.new(capture) unless capture.is_a? Capture
  path = "v1/payments/orders/#{self.id}/capture"
  response = api.post(path, capture.to_hash, http_header)
  Capture.new(response)
end

#void ⇒ Object 



938
939
940
941
942
943
 
# File 'lib/paypal-sdk/rest/data_types.rb', line 938

def void()
  path = "v1/payments/orders/#{self.id}/do-void"
  response = api.post(path, {}, http_header)
  self.merge!(response)
  success?
end