payrix-api-sdk 1.0.0

data/lib/payrix/models/invoice_status_enum.rb

@@ -0,0 +1,41 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # invoiceStatus.
+  class InvoiceStatusEnum
+    INVOICE_STATUS_ENUM = [
+      # Initial status of invoice before any action is taken.
+      PENDING = 'pending'.freeze,
+
+      # Updated status to indicate the invoice has expired.
+      CANCELLED = 'cancelled'.freeze,
+
+      # Updated status once the invoice has expired.
+      EXPIRED = 'expired'.freeze,
+
+      # Updated status once the invoice is viewed by the customer.
+      VIEWED = 'viewed'.freeze,
+
+      # Updated status once the invoice has been paid by the customer.
+      PAID = 'paid'.freeze,
+
+      # Updated status once the invoice has been confirmed by the customer.
+      CONFIRMED = 'confirmed'.freeze,
+
+      # Updated status once the invoice has been refunded.
+      REFUNDED = 'refunded'.freeze,
+
+      # Updated status once the invoice has been rejected by the customer.
+      REJECTED = 'rejected'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/invoice_type_enum.rb

@@ -0,0 +1,26 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # invoiceType.
+  class InvoiceTypeEnum
+    INVOICE_TYPE_ENUM = [
+      # A single-use invoice.
+      ONEOFF = 'single'.freeze,
+
+      # A static, reusable invoice (Payment Page).
+      STATIC = 'multiUse'.freeze,
+
+      # A subscription-based invoice.
+      SUBSCRIPTION = 'recurring'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/invoices_post_request.rb

@@ -0,0 +1,387 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # InvoicesPostRequest Model.
+  class InvoicesPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the Login of this invoice resource.
+    # @return [String]
+    attr_accessor :login
+
+    # The identifier of the Merchant of this invoice resource.
+    # @return [String]
+    attr_accessor :merchant
+
+    # The identifier of the Merchant of this invoice resource.
+    # @return [Object]
+    attr_accessor :customer
+
+    # The identifier of the Subscription of this invoice resource.
+    # @return [String]
+    attr_accessor :subscription
+
+    # The invoice number.
+    # @return [String]
+    attr_accessor :number
+
+    # The methods of payment allowed for this invoice. This field accepts
+    # multiple options concatenated into a 
+    # single string with a pipe (|) separator between each option.
+    # <details>
+    # <summary>Allowed Values</summary>
+    # - `Amex` - **American Express**
+    # - `Visa` - **Visa card**
+    # - `Mc` - **MasterCard**
+    # - `Diners` - **Diners Club card**
+    # - `Discover` - **Discover card**
+    # - `PayPal` - **PayPal payment method**
+    # - `Debit` - **Debit card**
+    # - `Checking` - **Checking account**
+    # - `Savings` - **Savings account**
+    # - `CorpChecking` - **Corporate checking account**
+    # - `CorpSavings` - **Corporate savings account**
+    # - `Gift` - **Gift card**
+    # - `EBT` - **Electronic Benefits Transfer**
+    # - `WIC` - **Women, Infants, and Children program**
+    # - `Accel` - **Accel network**
+    # - `ATH` - **ATH network**
+    # - `AFFN` - **Armed Forces Financial Network**
+    # - `Culiance` - **Culiance network**
+    # - `Interlink` - **Interlink network**
+    # - `Jeanie` - **Jeanie network**
+    # - `Maestro` - **Maestro card**
+    # - `NYCE` - **NYCE network**
+    # - `Pulse` - **Pulse network**
+    # - `Shazam` - **Shazam network**
+    # - `Star` - **Star network**
+    # - `Interac` - **Interac network**
+    # - `Omnitoken` - **Omnitoken**
+    # </details>
+    # @return [String]
+    attr_accessor :allowed_payment_methods
+
+    # The title of the invoice.
+    # @return [String]
+    attr_accessor :title
+
+    # The message that will be sent with the invoice.
+    # @return [String]
+    attr_accessor :message
+
+    # The total amount for this invoice.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The tax amount for this invoice.
+    # @return [Integer]
+    attr_accessor :tax
+
+    # The discount amount applied to this invoice.
+    # @return [Integer]
+    attr_accessor :discount
+
+    # The date the invoice is due.
+    # @return [Integer]
+    attr_accessor :due_date
+
+    # The date the invoice is due.
+    # @return [Integer]
+    attr_accessor :expiration_date
+
+    # The date to send this invoice.
+    # @return [Integer]
+    attr_accessor :send_on
+
+    # The current status of the transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    #  - `pending` - **Pending**
+    #  - `cancelled` - **Cancelled**
+    #  - `expired` - **Expired**
+    #  - `viewed` - **Viewed**
+    #  - `paid` - **Paid**
+    #  - `confirmed` - **Confirmed**
+    #  - `refunded` - **Refunded**       
+    #  - `rejected` - **Rejected**
+    #  </details>
+    # @return [InvoiceStatusEnum]
+    attr_accessor :status
+
+    # The current status of the invoice.
+    # <details>
+    # <summary>Valid Values</summary>
+    #  - `send` - **Updated email status to indicate the invoice is ready to be
+    # sent to the customer.**
+    #  - `sent` - **Updated email status once the invoice is sent to the
+    # customer.**
+    #  - `pending` - **Updated email status pending**
+    #  </details>
+    # @return [EmailStatusEnum]
+    attr_accessor :email_status
+
+    # The email addresses to send the invoice to.
+    # @return [String]
+    attr_accessor :emails
+
+    # The type of invoice.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `single` - **A single-use invoice.**
+    # - `multiUse` - **A static, reusable invoice. (Payment Page.)**
+    # - `recurring` - **A subscription-based invoice.**
+    # </details>
+    # @return [InvoiceTypeEnum]
+    attr_accessor :type
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [Array[InvoiceLineItemsPostRequest]]
+    attr_accessor :invoice_line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['login'] = 'login'
+      @_hash['merchant'] = 'merchant'
+      @_hash['customer'] = 'customer'
+      @_hash['subscription'] = 'subscription'
+      @_hash['number'] = 'number'
+      @_hash['allowed_payment_methods'] = 'allowedPaymentMethods'
+      @_hash['title'] = 'title'
+      @_hash['message'] = 'message'
+      @_hash['total'] = 'total'
+      @_hash['tax'] = 'tax'
+      @_hash['discount'] = 'discount'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['expiration_date'] = 'expirationDate'
+      @_hash['send_on'] = 'sendOn'
+      @_hash['status'] = 'status'
+      @_hash['email_status'] = 'emailStatus'
+      @_hash['emails'] = 'emails'
+      @_hash['type'] = 'type'
+      @_hash['frozen'] = 'frozen'
+      @_hash['inactive'] = 'inactive'
+      @_hash['invoice_line_items'] = 'invoiceLineItems'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+        allowed_payment_methods
+        title
+        message
+        total
+        tax
+        discount
+        due_date
+        expiration_date
+        send_on
+        email_status
+        emails
+        type
+        frozen
+        inactive
+        invoice_line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        merchant
+        subscription
+        tax
+        discount
+        due_date
+        expiration_date
+        send_on
+        emails
+      ]
+    end
+
+    def initialize(login = nil, merchant = nil, subscription = nil,
+                   number = nil, status = nil, customer = SKIP,
+                   allowed_payment_methods = SKIP, title = SKIP, message = SKIP,
+                   total = 0, tax = SKIP, discount = SKIP, due_date = SKIP,
+                   expiration_date = SKIP, send_on = SKIP,
+                   email_status = EmailStatusEnum::PENDING, emails = SKIP,
+                   type = InvoiceTypeEnum::ONEOFF,
+                   frozen = FrozenEnum::NOTFROZEN,
+                   inactive = InactiveEnum::ACTIVE, invoice_line_items = SKIP)
+      @login = login
+      @merchant = merchant
+      @customer = customer unless customer == SKIP
+      @subscription = subscription
+      @number = number
+      @allowed_payment_methods = allowed_payment_methods unless allowed_payment_methods == SKIP
+      @title = title unless title == SKIP
+      @message = message unless message == SKIP
+      @total = total unless total == SKIP
+      @tax = tax unless tax == SKIP
+      @discount = discount unless discount == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @send_on = send_on unless send_on == SKIP
+      @status = status
+      @email_status = email_status unless email_status == SKIP
+      @emails = emails unless emails == SKIP
+      @type = type unless type == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @invoice_line_items = invoice_line_items unless invoice_line_items == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      login = hash.key?('login') ? hash['login'] : nil
+      merchant = hash.key?('merchant') ? hash['merchant'] : nil
+      subscription = hash.key?('subscription') ? hash['subscription'] : nil
+      number = hash.key?('number') ? hash['number'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      customer = hash.key?('customer') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InvoicesPostRequestCustomer), hash['customer']
+      ) : SKIP
+      allowed_payment_methods =
+        hash.key?('allowedPaymentMethods') ? hash['allowedPaymentMethods'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      total = hash['total'] ||= 0
+      tax = hash.key?('tax') ? hash['tax'] : SKIP
+      discount = hash.key?('discount') ? hash['discount'] : SKIP
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : SKIP
+      expiration_date =
+        hash.key?('expirationDate') ? hash['expirationDate'] : SKIP
+      send_on = hash.key?('sendOn') ? hash['sendOn'] : SKIP
+      email_status = hash['emailStatus'] ||= EmailStatusEnum::PENDING
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      type = hash['type'] ||= InvoiceTypeEnum::ONEOFF
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      # Parameter is an array, so we need to iterate through it
+      invoice_line_items = nil
+      unless hash['invoiceLineItems'].nil?
+        invoice_line_items = []
+        hash['invoiceLineItems'].each do |structure|
+          invoice_line_items << (InvoiceLineItemsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      invoice_line_items = SKIP unless hash.key?('invoiceLineItems')
+
+      # Create object from extracted values.
+      InvoicesPostRequest.new(login,
+                              merchant,
+                              subscription,
+                              number,
+                              status,
+                              customer,
+                              allowed_payment_methods,
+                              title,
+                              message,
+                              total,
+                              tax,
+                              discount,
+                              due_date,
+                              expiration_date,
+                              send_on,
+                              email_status,
+                              emails,
+                              type,
+                              frozen,
+                              inactive,
+                              invoice_line_items)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicesPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.login,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.merchant,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.subscription,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { InvoiceStatusEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['login'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['merchant'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['subscription'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { InvoiceStatusEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} login: #{@login}, merchant: #{@merchant}, customer: #{@customer},"\
+      " subscription: #{@subscription}, number: #{@number}, allowed_payment_methods:"\
+      " #{@allowed_payment_methods}, title: #{@title}, message: #{@message}, total: #{@total},"\
+      " tax: #{@tax}, discount: #{@discount}, due_date: #{@due_date}, expiration_date:"\
+      " #{@expiration_date}, send_on: #{@send_on}, status: #{@status}, email_status:"\
+      " #{@email_status}, emails: #{@emails}, type: #{@type}, frozen: #{@frozen}, inactive:"\
+      " #{@inactive}, invoice_line_items: #{@invoice_line_items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} login: #{@login.inspect}, merchant: #{@merchant.inspect}, customer:"\
+      " #{@customer.inspect}, subscription: #{@subscription.inspect}, number: #{@number.inspect},"\
+      " allowed_payment_methods: #{@allowed_payment_methods.inspect}, title: #{@title.inspect},"\
+      " message: #{@message.inspect}, total: #{@total.inspect}, tax: #{@tax.inspect}, discount:"\
+      " #{@discount.inspect}, due_date: #{@due_date.inspect}, expiration_date:"\
+      " #{@expiration_date.inspect}, send_on: #{@send_on.inspect}, status: #{@status.inspect},"\
+      " email_status: #{@email_status.inspect}, emails: #{@emails.inspect}, type:"\
+      " #{@type.inspect}, frozen: #{@frozen.inspect}, inactive: #{@inactive.inspect},"\
+      " invoice_line_items: #{@invoice_line_items.inspect}>"
+    end
+  end
+end