Class: Inttegro::Refund::CreateRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/refund/create_request.rb

Overview

Typed representation of the create request object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

Optional in the API payload; omitted values default to nil. Wire name: custom_data.

Returns:



64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#line_items ⇒ Array<Inttegro::Refund::CreateLineItem> (readonly)

Value of the line_items field in the Inttegro API payload.

Required in the API payload. Wire name: line_items.

Returns:



64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#order_id ⇒ String (readonly)

Paid order to refund.

Required in the API payload. Wire name: order_id.

Returns:

  • (String) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#reason ⇒ Inttegro::Refund::Reason (readonly)

Value of the reason field in the Inttegro API payload.

Required in the API payload. Wire name: reason.

Returns:



64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#reason_details ⇒ String? (readonly)

Overall explanation. Required when reason is custom.

Optional in the API payload; omitted values default to nil. Wire name: reason_details.

Returns:

  • (String, nil) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#reference ⇒ String? (readonly)

Your reconciliation reference.

Optional in the API payload; omitted values default to nil. Wire name: reference.

Returns:

  • (String, nil) 


64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end

#request_meta ⇒ Inttegro::Refund::RequestMeta? (readonly)

Value of the request_meta field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: request_meta.

Returns:



64
65
66
67
68
69
70
71
72
 
# File 'lib/inttegro/refund/create_request.rb', line 64

class CreateRequest < T::Struct
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
  const :order_id, String
  const :reason, Inttegro::Refund::Reason
  const :reason_details, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
end