mollie-ruby-sdk 0.0.1.pre.alpha.9

data/lib/mollie/models/operations/update_payment_requestbody.rb

@@ -0,0 +1,253 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module Mollie
+  module Models
+    module Operations
+
+      class UpdatePaymentRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The description of the payment will be shown to your customer on their card or bank statement when possible.
+        # We truncate the description automatically according to the limits of the used payment method. The description is
+        # also visible in any exports you generate.
+        #
+        # We recommend you use a unique identifier so that you can always link the payment to the order in your back office.
+        # This is particularly useful for bookkeeping.
+        #
+        # The maximum length of the description field differs per payment method, with the absolute maximum being 255
+        # characters. The API will not reject strings longer than the maximum length but it will truncate them to fit.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("description")}}
+        )
+        # Whether the entity was created in test mode or live mode. This field does not update the mode of the entity.
+        #
+        # Most API credentials are specifically created for either live mode or test mode, in which case this parameter must
+        # not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+        # `testmode` to `true`.
+        field(
+          :testmode,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("testmode")}}
+        )
+        # The customer's billing address details. We advise to provide these details to improve fraud protection and
+        # conversion.
+        #
+        # Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and
+        # `country`.
+        #
+        # Required for payment method `alma`, `in3`, `klarna`, `billie`, `billink` and `riverty`.
+        field(
+          :billing_address,
+          Crystalline::Nilable.new(Models::Components::BillingAddress),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("billingAddress")}}
+        )
+
+        field(
+          :shipping_address,
+          Crystalline::Nilable.new(Models::Components::ShippingAddress),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("shippingAddress")}}
+        )
+
+        field(
+          :billing_email,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("billingEmail")}}
+        )
+        # The URL your customer will be redirected to after the payment process.
+        #
+        # It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the
+        # right page referencing the order when your customer returns.
+        #
+        # The parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for
+        # Apple Pay payments with an `applePayPaymentToken`.
+        field(
+          :redirect_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("redirectUrl")}}
+        )
+        # The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not
+        # provided, the customer will be redirected to the `redirectUrl` instead — see above.
+        #
+        # Mollie will always give you status updates via webhooks, including for the canceled status. This parameter is
+        # therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle
+        # payment cancellations.
+        field(
+          :cancel_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("cancelUrl")}}
+        )
+        # The webhook URL where we will send payment status updates to.
+        #
+        # The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.
+        #
+        # The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
+        # webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
+        # local machine.
+        field(
+          :webhook_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("webhookUrl")}}
+        )
+        # Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+        # you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+        field(
+          :metadata,
+          Crystalline::Nilable.new(
+            Crystalline::Union.new(
+              ::String,
+              ::Float,
+              Crystalline::Hash.new(::Symbol, ::Object),
+              Crystalline::Array.new(::String)
+            )
+          ),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("metadata")}}
+        )
+        # Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
+        # method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
+        # parameter enables you to fully integrate the payment method selection into your website.
+        #
+        # You can also specify the methods in an array. By doing so we will still show the payment method selection screen
+        # but will only show the methods specified in the array. For example, you can use this functionality to only show
+        # payment methods from a specific country to your customer `['bancontact', 'belfius']`.
+        field(
+          :method,
+          Crystalline::Nilable.new(
+            Crystalline::Union.new(
+              Models::Components::MethodEnum,
+              Crystalline::Array.new(Models::Components::MethodEnum)
+            )
+          ),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("method")}}
+        )
+        # Sets the language for customer-facing content and communications.
+        field(
+          :locale,
+          Crystalline::Nilable.new(Models::Components::Locale2),
+          {
+            'format_json': {
+              'letter_case': ::Mollie::Utils.field_name("locale"),
+              'decoder': ::Mollie::Utils.enum_from_string(Models::Components::Locale2, true)
+            }
+          }
+        )
+        # The date by which the payment should be completed in `YYYY-MM-DD` format. Sending `null` has the same effect
+        # as omitting the field.
+        field(
+          :due_date,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("dueDate")}}
+        )
+        # For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT
+        # rates you have used for the order to ensure your customer's country matches the VAT country.
+        #
+        # Use this parameter to restrict the payment methods available to your customer to those from a single country.
+        #
+        # If available, the credit card method will still be offered, but only cards from the allowed country are accepted.
+        #
+        # The field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`.
+        field(
+          :restrict_payment_methods_to_country,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("restrictPaymentMethodsToCountry")}}
+        )
+        # **Only relevant for iDEAL, KBC/CBC, gift card, and voucher payments.**
+        #
+        # **⚠️ With the introduction of iDEAL 2 in 2025, this field will be ignored for iDEAL payments. For more information
+        # on the migration, refer to our [help center](https://help.mollie.com/hc/articles/19100313768338-iDEAL-2-0).**
+        #
+        # Some payment methods are a network of connected banks or card issuers. In these cases, after selecting the payment
+        # method, the customer may still need to select the appropriate issuer before the payment can proceed.
+        #
+        # We provide hosted issuer selection screens, but these screens can be skipped by providing the `issuer` via the API
+        # up front.
+        #
+        # The full list of issuers for a specific method can be retrieved via the Methods API by using the optional
+        # `issuers` include.
+        #
+        # A valid issuer for iDEAL is for example `ideal_INGBNL2A` (for ING Bank).
+        field(
+          :issuer,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("issuer")}}
+        )
+
+        sig {
+          params(
+            description: T.nilable(::String),
+            testmode: T.nilable(T::Boolean),
+            billing_address: T.nilable(Models::Components::BillingAddress),
+            shipping_address: T.nilable(Models::Components::ShippingAddress),
+            billing_email: T.nilable(::String),
+            redirect_url: T.nilable(::String),
+            cancel_url: T.nilable(::String),
+            webhook_url: T.nilable(::String),
+            metadata: T.nilable(T.any(::String, ::Float, T::Hash[::Symbol, ::Object], T::Array[::String])),
+            method: T.nilable(T.any(Models::Components::MethodEnum, T::Array[Models::Components::MethodEnum])),
+            locale: T.nilable(Models::Components::Locale2),
+            due_date: T.nilable(::String),
+            restrict_payment_methods_to_country: T.nilable(::String),
+            issuer: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          description: nil,
+          testmode: nil,
+          billing_address: nil,
+          shipping_address: nil,
+          billing_email: nil,
+          redirect_url: nil,
+          cancel_url: nil,
+          webhook_url: nil,
+          metadata: nil,
+          method: nil,
+          locale: nil,
+          due_date: nil,
+          restrict_payment_methods_to_country: nil,
+          issuer: nil
+        )
+          @description = description
+          @testmode = testmode
+          @billing_address = billing_address
+          @shipping_address = shipping_address
+          @billing_email = billing_email
+          @redirect_url = redirect_url
+          @cancel_url = cancel_url
+          @webhook_url = webhook_url
+          @metadata = metadata
+          @method = method
+          @locale = locale
+          @due_date = due_date
+          @restrict_payment_methods_to_country = restrict_payment_methods_to_country
+          @issuer = issuer
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @description == other.description
+          return false unless @testmode == other.testmode
+          return false unless @billing_address == other.billing_address
+          return false unless @shipping_address == other.shipping_address
+          return false unless @billing_email == other.billing_email
+          return false unless @redirect_url == other.redirect_url
+          return false unless @cancel_url == other.cancel_url
+          return false unless @webhook_url == other.webhook_url
+          return false unless @metadata == other.metadata
+          return false unless @method == other.method
+          return false unless @locale == other.locale
+          return false unless @due_date == other.due_date
+          return false unless @restrict_payment_methods_to_country == other.restrict_payment_methods_to_country
+          return false unless @issuer == other.issuer
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mollie/models/operations/update_payment_requestbody.rbi

@@ -0,0 +1,92 @@
+# typed: true
+# frozen_string_literal: true
+
+class Mollie::Models::Operations::UpdatePaymentRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class Mollie::Models::Operations::UpdatePaymentRequestBody
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def testmode
+  end
+
+  def testmode=(str_)
+  end
+
+  def billing_address
+  end
+
+  def billing_address=(str_)
+  end
+
+  def shipping_address
+  end
+
+  def shipping_address=(str_)
+  end
+
+  def billing_email
+  end
+
+  def billing_email=(str_)
+  end
+
+  def redirect_url
+  end
+
+  def redirect_url=(str_)
+  end
+
+  def cancel_url
+  end
+
+  def cancel_url=(str_)
+  end
+
+  def webhook_url
+  end
+
+  def webhook_url=(str_)
+  end
+
+  def metadata
+  end
+
+  def metadata=(str_)
+  end
+
+  def method
+  end
+
+  def method=(str_)
+  end
+
+  def locale
+  end
+
+  def locale=(str_)
+  end
+
+  def due_date
+  end
+
+  def due_date=(str_)
+  end
+
+  def restrict_payment_methods_to_country
+  end
+
+  def restrict_payment_methods_to_country=(str_)
+  end
+
+  def issuer
+  end
+
+  def issuer=(str_)
+  end
+end

data/lib/mollie/models/operations/update_payment_response.rb

@@ -0,0 +1,51 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module Mollie
+  module Models
+    module Operations
+
+      class UpdatePaymentResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # The updated payment object.
+        field :payment_response, Crystalline::Nilable.new(Models::Components::PaymentResponse)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            payment_response: T.nilable(Models::Components::PaymentResponse)
+          )
+            .void
+        }
+        def initialize(content_type:, status_code:, raw_response:, payment_response: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @payment_response = payment_response
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @payment_response == other.payment_response
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mollie/models/operations/update_payment_response.rbi

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class Mollie::Models::Operations::UpdatePaymentResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class Mollie::Models::Operations::UpdatePaymentResponse
+  def content_type
+  end
+
+  def content_type=(str_)
+  end
+
+  def status_code
+  end
+
+  def status_code=(str_)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(str_)
+  end
+
+  def payment_response
+  end
+
+  def payment_response=(str_)
+  end
+end

data/lib/mollie/models/operations/update_profile_request.rb

@@ -0,0 +1,68 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module Mollie
+  module Models
+    module Operations
+
+      class UpdateProfileRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Provide the ID of the related profile.
+        field :profile_id, ::String, {'path_param': {'field_name': "profileId", 'style': "simple", 'explode': false}}
+
+        field :body, Models::Operations::UpdateProfileRequestBody, {'request': {'media_type': "application/json"}}
+        # A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+        field(
+          :idempotency_key,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "idempotency-key", 'style': "simple", 'explode': false}}
+        )
+        # A cryptographic signature of the request, used to verify that it was sent by you and hasn't been tampered with. Required if you've enabled request signing for your integration.
+        field(
+          :x_client_signature,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "X-Client-Signature", 'style': "simple", 'explode': false}}
+        )
+        # The timestamp, in ISO 8601 format, at which you generated the `X-Client-Signature`. Required together with `X-Client-Signature` if you've enabled request signing for your integration.
+        field(
+          :x_client_signed_at,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "X-Client-Signed-At", 'style': "simple", 'explode': false}}
+        )
+
+        sig {
+          params(
+            profile_id: ::String,
+            body: Models::Operations::UpdateProfileRequestBody,
+            idempotency_key: T.nilable(::String),
+            x_client_signature: T.nilable(::String),
+            x_client_signed_at: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(profile_id:, body:, idempotency_key: nil, x_client_signature: nil, x_client_signed_at: nil)
+          @profile_id = profile_id
+          @body = body
+          @idempotency_key = idempotency_key
+          @x_client_signature = x_client_signature
+          @x_client_signed_at = x_client_signed_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @profile_id == other.profile_id
+          return false unless @body == other.body
+          return false unless @idempotency_key == other.idempotency_key
+          return false unless @x_client_signature == other.x_client_signature
+          return false unless @x_client_signed_at == other.x_client_signed_at
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mollie/models/operations/update_profile_request.rbi

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class Mollie::Models::Operations::UpdateProfileRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class Mollie::Models::Operations::UpdateProfileRequest
+  def profile_id
+  end
+
+  def profile_id=(str_)
+  end
+
+  def body
+  end
+
+  def body=(str_)
+  end
+
+  def idempotency_key
+  end
+
+  def idempotency_key=(str_)
+  end
+
+  def x_client_signature
+  end
+
+  def x_client_signature=(str_)
+  end
+
+  def x_client_signed_at
+  end
+
+  def x_client_signed_at=(str_)
+  end
+end

data/lib/mollie/models/operations/update_profile_requestbody.rb

@@ -0,0 +1,108 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module Mollie
+  module Models
+    module Operations
+
+      class UpdateProfileRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+        # application.
+        field(
+          :name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("name")}}
+        )
+        # The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs
+        # are allowed.
+        field(
+          :website,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("website")}}
+        )
+        # The email address associated with the profile's trade name or brand.
+        #
+        # If the domain contains non-ASCII characters, encode it as Punycode per [RFC 3492](https://www.rfc-editor.org/rfc/rfc3492).
+        field(
+          :email,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("email")}}
+        )
+        # The phone number associated with the profile's trade name or brand.
+        field(
+          :phone,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("phone")}}
+        )
+        # The products or services offered by the profile's website or application.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("description")}}
+        )
+        # A list of countries where you expect that the majority of the profile's customers reside,
+        # in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+        field(
+          :countries_of_activity,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("countriesOfActivity")}}
+        )
+        # The industry associated with the profile's trade name or brand. Please refer to the
+        # [business category list](common-data-types) for all possible options.
+        field(
+          :business_category,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::Mollie::Utils.field_name("businessCategory")}}
+        )
+
+        sig {
+          params(
+            name: T.nilable(::String),
+            website: T.nilable(::String),
+            email: T.nilable(::String),
+            phone: T.nilable(::String),
+            description: T.nilable(::String),
+            countries_of_activity: T.nilable(T::Array[::String]),
+            business_category: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          name: nil,
+          website: nil,
+          email: nil,
+          phone: nil,
+          description: nil,
+          countries_of_activity: nil,
+          business_category: nil
+        )
+          @name = name
+          @website = website
+          @email = email
+          @phone = phone
+          @description = description
+          @countries_of_activity = countries_of_activity
+          @business_category = business_category
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @name == other.name
+          return false unless @website == other.website
+          return false unless @email == other.email
+          return false unless @phone == other.phone
+          return false unless @description == other.description
+          return false unless @countries_of_activity == other.countries_of_activity
+          return false unless @business_category == other.business_category
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mollie/models/operations/update_profile_requestbody.rbi

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class Mollie::Models::Operations::UpdateProfileRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class Mollie::Models::Operations::UpdateProfileRequestBody
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def website
+  end
+
+  def website=(str_)
+  end
+
+  def email
+  end
+
+  def email=(str_)
+  end
+
+  def phone
+  end
+
+  def phone=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def countries_of_activity
+  end
+
+  def countries_of_activity=(str_)
+  end
+
+  def business_category
+  end
+
+  def business_category=(str_)
+  end
+end