|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module Cloudpayments |
| 4 | + module Models |
| 5 | + # @see Cloudpayments::Resources::Orders#create |
| 6 | + class OrderCreateParams < Cloudpayments::Internal::Type::BaseModel |
| 7 | + extend Cloudpayments::Internal::Type::RequestParameters::Converter |
| 8 | + include Cloudpayments::Internal::Type::RequestParameters |
| 9 | + |
| 10 | + # @!attribute amount |
| 11 | + # Сумма платежа |
| 12 | + # |
| 13 | + # @return [Float] |
| 14 | + required :amount, Float, api_name: :Amount |
| 15 | + |
| 16 | + # @!attribute description |
| 17 | + # Описание платежа |
| 18 | + # |
| 19 | + # @return [String] |
| 20 | + required :description, String, api_name: :Description |
| 21 | + |
| 22 | + # @!attribute account_id |
| 23 | + # Идентификатор пользователя |
| 24 | + # |
| 25 | + # @return [String, nil] |
| 26 | + optional :account_id, String, api_name: :AccountId |
| 27 | + |
| 28 | + # @!attribute culture_name |
| 29 | + # Язык уведомлений (ru-RU, en-US) |
| 30 | + # |
| 31 | + # @return [String, nil] |
| 32 | + optional :culture_name, String, api_name: :CultureName |
| 33 | + |
| 34 | + # @!attribute currency |
| 35 | + # Валюта (RUB по умолчанию) |
| 36 | + # |
| 37 | + # @return [String, nil] |
| 38 | + optional :currency, String, api_name: :Currency |
| 39 | + |
| 40 | + # @!attribute email |
| 41 | + # Email плательщика |
| 42 | + # |
| 43 | + # @return [String, nil] |
| 44 | + optional :email, String, api_name: :Email |
| 45 | + |
| 46 | + # @!attribute fail_redirect_url |
| 47 | + # URL редиректа при неуспешной оплате |
| 48 | + # |
| 49 | + # @return [String, nil] |
| 50 | + optional :fail_redirect_url, String, api_name: :FailRedirectUrl |
| 51 | + |
| 52 | + # @!attribute invoice_id |
| 53 | + # Номер заказа в системе мерчанта |
| 54 | + # |
| 55 | + # @return [String, nil] |
| 56 | + optional :invoice_id, String, api_name: :InvoiceId |
| 57 | + |
| 58 | + # @!attribute json_data |
| 59 | + # Дополнительные данные (JSON) |
| 60 | + # |
| 61 | + # @return [Object, nil] |
| 62 | + optional :json_data, Cloudpayments::Internal::Type::Unknown, api_name: :JsonData |
| 63 | + |
| 64 | + # @!attribute offer_uri |
| 65 | + # Ссылка на оферту |
| 66 | + # |
| 67 | + # @return [String, nil] |
| 68 | + optional :offer_uri, String, api_name: :OfferUri |
| 69 | + |
| 70 | + # @!attribute phone |
| 71 | + # Телефон плательщика |
| 72 | + # |
| 73 | + # @return [String, nil] |
| 74 | + optional :phone, String, api_name: :Phone |
| 75 | + |
| 76 | + # @!attribute require_confirmation |
| 77 | + # Требуется подтверждение (двухстадийная схема) |
| 78 | + # |
| 79 | + # @return [Boolean, nil] |
| 80 | + optional :require_confirmation, Cloudpayments::Internal::Type::Boolean, api_name: :RequireConfirmation |
| 81 | + |
| 82 | + # @!attribute send_email |
| 83 | + # Отправить ссылку на email |
| 84 | + # |
| 85 | + # @return [Boolean, nil] |
| 86 | + optional :send_email, Cloudpayments::Internal::Type::Boolean, api_name: :SendEmail |
| 87 | + |
| 88 | + # @!attribute send_sms |
| 89 | + # Отправить ссылку по SMS |
| 90 | + # |
| 91 | + # @return [Boolean, nil] |
| 92 | + optional :send_sms, Cloudpayments::Internal::Type::Boolean, api_name: :SendSms |
| 93 | + |
| 94 | + # @!attribute send_viber |
| 95 | + # Отправить ссылку через Viber |
| 96 | + # |
| 97 | + # @return [Boolean, nil] |
| 98 | + optional :send_viber, Cloudpayments::Internal::Type::Boolean, api_name: :SendViber |
| 99 | + |
| 100 | + # @!attribute subscription_behavior |
| 101 | + # Поведение подписки: CreateWeekly, CreateMonthly |
| 102 | + # |
| 103 | + # @return [String, nil] |
| 104 | + optional :subscription_behavior, String, api_name: :SubscriptionBehavior |
| 105 | + |
| 106 | + # @!attribute success_redirect_url |
| 107 | + # URL редиректа при успешной оплате |
| 108 | + # |
| 109 | + # @return [String, nil] |
| 110 | + optional :success_redirect_url, String, api_name: :SuccessRedirectUrl |
| 111 | + |
| 112 | + # @!method 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: {}) |
| 113 | + # @param amount [Float] Сумма платежа |
| 114 | + # |
| 115 | + # @param description [String] Описание платежа |
| 116 | + # |
| 117 | + # @param account_id [String] Идентификатор пользователя |
| 118 | + # |
| 119 | + # @param culture_name [String] Язык уведомлений (ru-RU, en-US) |
| 120 | + # |
| 121 | + # @param currency [String] Валюта (RUB по умолчанию) |
| 122 | + # |
| 123 | + # @param email [String] Email плательщика |
| 124 | + # |
| 125 | + # @param fail_redirect_url [String] URL редиректа при неуспешной оплате |
| 126 | + # |
| 127 | + # @param invoice_id [String] Номер заказа в системе мерчанта |
| 128 | + # |
| 129 | + # @param json_data [Object] Дополнительные данные (JSON) |
| 130 | + # |
| 131 | + # @param offer_uri [String] Ссылка на оферту |
| 132 | + # |
| 133 | + # @param phone [String] Телефон плательщика |
| 134 | + # |
| 135 | + # @param require_confirmation [Boolean] Требуется подтверждение (двухстадийная схема) |
| 136 | + # |
| 137 | + # @param send_email [Boolean] Отправить ссылку на email |
| 138 | + # |
| 139 | + # @param send_sms [Boolean] Отправить ссылку по SMS |
| 140 | + # |
| 141 | + # @param send_viber [Boolean] Отправить ссылку через Viber |
| 142 | + # |
| 143 | + # @param subscription_behavior [String] Поведение подписки: CreateWeekly, CreateMonthly |
| 144 | + # |
| 145 | + # @param success_redirect_url [String] URL редиректа при успешной оплате |
| 146 | + # |
| 147 | + # @param request_options [Cloudpayments::RequestOptions, Hash{Symbol=>Object}] |
| 148 | + end |
| 149 | + end |
| 150 | +end |
0 commit comments