Class: CloudpaymentsRuby::Models::OrderCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cloudpayments_ruby/models/order_create_params.rb,
sig/cloudpayments_ruby/models/order_create_params.rbs

Overview

See Also:

  • CloudpaymentsRuby::Resources::Orders#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::CloudpaymentsRuby

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount:, description:, account_id: nil, culture_name: nil, currency: nil, email: nil, fail_redirect_url: nil, invoice_id: nil, json_data: nil, offer_uri: nil, phone: nil, require_confirmation: nil, send_email: nil, send_sms: nil, send_viber: nil, subscription_behavior: nil, success_redirect_url: nil, request_options: {}) ⇒ Object

Parameters:

  • amount (Float) —

    Сумма платежа

  • description (String) —

    Описание платежа

  • account_id (String) (defaults to: nil) —

    Идентификатор пользователя

  • culture_name (String) (defaults to: nil) —

    Язык уведомлений (ru-RU, en-US)

  • currency (String) (defaults to: nil) —

    Валюта (RUB по умолчанию)

  • email (String) (defaults to: nil) —

    Email плательщика

  • fail_redirect_url (String) (defaults to: nil) —

    URL редиректа при неуспешной оплате

  • invoice_id (String) (defaults to: nil) —

    Номер заказа в системе мерчанта

  • json_data (Object) (defaults to: nil) —

    Дополнительные данные (JSON)

  • offer_uri (String) (defaults to: nil) —

    Ссылка на оферту

  • phone (String) (defaults to: nil) —

    Телефон плательщика

  • require_confirmation (Boolean) (defaults to: nil) —

    Требуется подтверждение (двухстадийная схема)

  • send_email (Boolean) (defaults to: nil) —

    Отправить ссылку на email

  • send_sms (Boolean) (defaults to: nil) —

    Отправить ссылку по SMS

  • send_viber (Boolean) (defaults to: nil) —

    Отправить ссылку через Viber

  • subscription_behavior (String) (defaults to: nil) —

    Поведение подписки: CreateWeekly, CreateMonthly

  • success_redirect_url (String) (defaults to: nil) —

    URL редиректа при успешной оплате

  • request_options (CloudpaymentsRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 114

Instance Attribute Details

#account_id ⇒ String?

Идентификатор пользователя

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 26

optional :account_id, String, api_name: :AccountId

#amount ⇒ Float

Сумма платежа

Parameters:

  • value (Float)

Returns:

  • (Float) 


14
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 14

required :amount, Float, api_name: :Amount

#culture_name ⇒ String?

Язык уведомлений (ru-RU, en-US)

Parameters:

  • (String)

Returns:

  • (String, nil) 


32
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 32

optional :culture_name, String, api_name: :CultureName

#currency ⇒ String?

Валюта (RUB по умолчанию)

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 38

optional :currency, String, api_name: :Currency

#description ⇒ String

Описание платежа

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 20

required :description, String, api_name: :Description

#email ⇒ String?

Email плательщика

Parameters:

  • (String)

Returns:

  • (String, nil) 


44
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 44

optional :email, String, api_name: :Email

#fail_redirect_url ⇒ String?

URL редиректа при неуспешной оплате

Parameters:

  • (String)

Returns:

  • (String, nil) 


50
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 50

optional :fail_redirect_url, String, api_name: :FailRedirectUrl

#invoice_id ⇒ String?

Номер заказа в системе мерчанта

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 56

optional :invoice_id, String, api_name: :InvoiceId

#json_data ⇒ Object?

Дополнительные данные (JSON)

Parameters:

  • (top)

Returns:

  • (Object, nil) 


62
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 62

optional :json_data, CloudpaymentsRuby::Internal::Type::Unknown, api_name: :JsonData

#offer_uri ⇒ String?

Ссылка на оферту

Parameters:

  • (String)

Returns:

  • (String, nil) 


68
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 68

optional :offer_uri, String, api_name: :OfferUri

#phone ⇒ String?

Телефон плательщика

Parameters:

  • (String)

Returns:

  • (String, nil) 


74
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 74

optional :phone, String, api_name: :Phone

#require_confirmation ⇒ Boolean?

Требуется подтверждение (двухстадийная схема)

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


80
81
82
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 80

optional :require_confirmation,
CloudpaymentsRuby::Internal::Type::Boolean,
api_name: :RequireConfirmation

#send_email ⇒ Boolean?

Отправить ссылку на email

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


88
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 88

optional :send_email, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :SendEmail

#send_sms ⇒ Boolean?

Отправить ссылку по SMS

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


94
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 94

optional :send_sms, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :SendSms

#send_viber ⇒ Boolean?

Отправить ссылку через Viber

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


100
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 100

optional :send_viber, CloudpaymentsRuby::Internal::Type::Boolean, api_name: :SendViber

#subscription_behavior ⇒ String?

Поведение подписки: CreateWeekly, CreateMonthly

Parameters:

  • (String)

Returns:

  • (String, nil) 


106
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 106

optional :subscription_behavior, String, api_name: :SubscriptionBehavior

#success_redirect_url ⇒ String?

URL редиректа при успешной оплате

Parameters:

  • (String)

Returns:

  • (String, nil) 


112
 
# File 'lib/cloudpayments_ruby/models/order_create_params.rb', line 112

optional :success_redirect_url, String, api_name: :SuccessRedirectUrl

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


114
 
# File 'sig/cloudpayments_ruby/models/order_create_params.rbs', line 114

def to_hash: -> {