mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/purchase_account_credit_request.rb

@@ -0,0 +1,154 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # PurchaseAccountCreditRequest Model.
+  class PurchaseAccountCreditRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, allows you to test the request without affecting the
+    # database.
+    # When `false`, the request is carried out and the database is affected.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # The ID of the location where the account credit is being sold.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # The ID of the location where the account credit is being sold.
+    # @return [String]
+    attr_accessor :client_id
+
+    # When `true`, indicates that a purchase receipt email should be sent to the
+    # purchasing client, if all settings are correctly configured.<br />
+    # When `false`, no email is sent to the purchaser.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email_receipt
+
+    # The ID of the staff member to be marked as the sales rep for this account
+    # credit sale.
+    # @return [Integer]
+    attr_accessor :sales_rep_id
+
+    # When `true`, indicates that the consumer is present or otherwise able to
+    # successfully negotiate an SCA challenge.
+    #  It is not a good idea to have this always be false as that could very
+    # likely lead to a bank declining all transactions for the merchant.
+    # Defaults to false.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :consumer_present
+
+    # The URL consumer is redirected to if the bank requests SCA. This field is
+    # only needed if ConsumerPresent is true.
+    # @return [String]
+    attr_accessor :payment_authentication_callback_url
+
+    # The URL consumer is redirected to if the bank requests SCA. This field is
+    # only needed if ConsumerPresent is true.
+    # @return [CheckoutPaymentInfo]
+    attr_accessor :payment_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['test'] = 'Test'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['send_email_receipt'] = 'SendEmailReceipt'
+      @_hash['sales_rep_id'] = 'SalesRepId'
+      @_hash['consumer_present'] = 'ConsumerPresent'
+      @_hash['payment_authentication_callback_url'] =
+        'PaymentAuthenticationCallbackUrl'
+      @_hash['payment_info'] = 'PaymentInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        test
+        location_id
+        send_email_receipt
+        sales_rep_id
+        consumer_present
+        payment_authentication_callback_url
+        payment_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, test = SKIP, location_id = SKIP,
+                   send_email_receipt = SKIP, sales_rep_id = SKIP,
+                   consumer_present = SKIP,
+                   payment_authentication_callback_url = SKIP,
+                   payment_info = SKIP)
+      @test = test unless test == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @client_id = client_id
+      @send_email_receipt = send_email_receipt unless send_email_receipt == SKIP
+      @sales_rep_id = sales_rep_id unless sales_rep_id == SKIP
+      @consumer_present = consumer_present unless consumer_present == SKIP
+      unless payment_authentication_callback_url == SKIP
+        @payment_authentication_callback_url =
+          payment_authentication_callback_url
+      end
+      @payment_info = payment_info unless payment_info == 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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      send_email_receipt =
+        hash.key?('SendEmailReceipt') ? hash['SendEmailReceipt'] : SKIP
+      sales_rep_id = hash.key?('SalesRepId') ? hash['SalesRepId'] : SKIP
+      consumer_present =
+        hash.key?('ConsumerPresent') ? hash['ConsumerPresent'] : SKIP
+      payment_authentication_callback_url =
+        hash.key?('PaymentAuthenticationCallbackUrl') ? hash['PaymentAuthenticationCallbackUrl'] : SKIP
+      payment_info = CheckoutPaymentInfo.from_hash(hash['PaymentInfo']) if hash['PaymentInfo']
+
+      # Create object from extracted values.
+      PurchaseAccountCreditRequest.new(client_id,
+                                       test,
+                                       location_id,
+                                       send_email_receipt,
+                                       sales_rep_id,
+                                       consumer_present,
+                                       payment_authentication_callback_url,
+                                       payment_info)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} test: #{@test}, location_id: #{@location_id}, client_id: #{@client_id},"\
+      " send_email_receipt: #{@send_email_receipt}, sales_rep_id: #{@sales_rep_id},"\
+      " consumer_present: #{@consumer_present}, payment_authentication_callback_url:"\
+      " #{@payment_authentication_callback_url}, payment_info: #{@payment_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} test: #{@test.inspect}, location_id: #{@location_id.inspect}, client_id:"\
+      " #{@client_id.inspect}, send_email_receipt: #{@send_email_receipt.inspect}, sales_rep_id:"\
+      " #{@sales_rep_id.inspect}, consumer_present: #{@consumer_present.inspect},"\
+      " payment_authentication_callback_url: #{@payment_authentication_callback_url.inspect},"\
+      " payment_info: #{@payment_info.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/purchase_account_credit_response.rb

@@ -0,0 +1,118 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # PurchaseAccountCreditResponse Model.
+  class PurchaseAccountCreditResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount paid for the gift card by the purchaser.
+    # @return [Float]
+    attr_accessor :amount_paid
+
+    # The client ID of the purchaser.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The sale ID of the gift card.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # Whether or not an email receipt was sent to the purchaser. If true, a
+    # receipt was sent.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :email_receipt
+
+    # Any cart processing failures, for example when SCA challenged, the cart is
+    # in PaymentAuthenticationRequired state and at least one of the failures
+    # listed will provide an authentication Url.
+    # @return [Array[PaymentProcessingFailure]]
+    attr_accessor :payment_processing_failures
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_paid'] = 'AmountPaid'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['sale_id'] = 'SaleId'
+      @_hash['email_receipt'] = 'EmailReceipt'
+      @_hash['payment_processing_failures'] = 'PaymentProcessingFailures'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_paid
+        client_id
+        sale_id
+        email_receipt
+        payment_processing_failures
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount_paid = SKIP, client_id = SKIP, sale_id = SKIP,
+                   email_receipt = SKIP, payment_processing_failures = SKIP)
+      @amount_paid = amount_paid unless amount_paid == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @sale_id = sale_id unless sale_id == SKIP
+      @email_receipt = email_receipt unless email_receipt == SKIP
+      unless payment_processing_failures == SKIP
+        @payment_processing_failures =
+          payment_processing_failures
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount_paid = hash.key?('AmountPaid') ? hash['AmountPaid'] : SKIP
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      email_receipt = hash.key?('EmailReceipt') ? hash['EmailReceipt'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      payment_processing_failures = nil
+      unless hash['PaymentProcessingFailures'].nil?
+        payment_processing_failures = []
+        hash['PaymentProcessingFailures'].each do |structure|
+          payment_processing_failures << (PaymentProcessingFailure.from_hash(structure) if structure)
+        end
+      end
+
+      payment_processing_failures = SKIP unless hash.key?('PaymentProcessingFailures')
+
+      # Create object from extracted values.
+      PurchaseAccountCreditResponse.new(amount_paid,
+                                        client_id,
+                                        sale_id,
+                                        email_receipt,
+                                        payment_processing_failures)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_paid: #{@amount_paid}, client_id: #{@client_id}, sale_id:"\
+      " #{@sale_id}, email_receipt: #{@email_receipt}, payment_processing_failures:"\
+      " #{@payment_processing_failures}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_paid: #{@amount_paid.inspect}, client_id: #{@client_id.inspect},"\
+      " sale_id: #{@sale_id.inspect}, email_receipt: #{@email_receipt.inspect},"\
+      " payment_processing_failures: #{@payment_processing_failures.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/purchase_contract_request.rb

@@ -0,0 +1,324 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # PurchaseContractRequest Model.
+  class PurchaseContractRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, the Public API validates input information, but does not
+    # commit it, so no client data is affected.<br />
+    # When `false` or omitted, the transaction is committed, and client data is
+    # affected.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # The ID of the location where the client is purchasing the contract; used
+    # for AutoPays.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # The ID of the client. Note that this is not the same as the client’s
+    # unique ID.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The unique ID of the client.
+    # Note: you need to provide the 'UniqueClientId' OR the 'ClientId'. If both
+    # are provided, the 'UniqueClientId' takes precedence.
+    # @return [Integer]
+    attr_accessor :unique_client_id
+
+    # The ID of the contract being purchased.
+    # @return [Integer]
+    attr_accessor :contract_id
+
+    # The date that the contract starts.<br />
+    # Default: **today’s date**
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The date on which the first payment is to occur. Possible values:
+    # * Instant
+    # * `StartDate`
+    # @return [String]
+    attr_accessor :first_payment_occurs
+
+    # A representation of the client’s signature. This value can take the form
+    # of Base64-encoded byte array. The file type should be PNG. The picture of
+    # the client’s signature is uploaded and viewable from the Client Documents
+    # page in the Core Business Mode software. The title of the document is:<br
+    # />
+    # clientContractSignature-{uniquePurchasedClientContractID}-{contractName}-{
+    # contractStartDate}.{fileType}
+    # @return [String]
+    attr_accessor :client_signature
+
+    # A promotion code, if one applies. Promotion codes are applied to items
+    # that are both marked as pay now in a contract and are discounted by the
+    # promotion code. If a pay now item is an autopay item, its autopay price is
+    # the price at the time of checkout, so, if a promotion code was applied,
+    # all autopays are scheduled using that discounted price.
+    # @return [String]
+    attr_accessor :promotion_code
+
+    # Promotion codes, if they apply. Promotion codes are applied to items that
+    # are both marked as pay now in a contract and are discounted by the
+    # promotion code. If a pay now item is an autopay item, its autopay price is
+    # the price at the time of checkout, so, if a promotion code was applied,
+    # all autopays are scheduled using that discounted price.
+    # @return [Array[String]]
+    attr_accessor :promotion_codes
+
+    # Information about an individual credit card
+    # @return [CreditCardInfo]
+    attr_accessor :credit_card_info
+
+    # Information about an individual credit card
+    # @return [StoredCardInfo]
+    attr_accessor :stored_card_info
+
+    # When `true`, indicates that email and SMS notifications should be sent to
+    # the client after purchase.<br />
+    # Default: **true**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_notifications
+
+    # The ID of the staff member to be marked as the sales rep for this contract
+    # sale.
+    # @return [Integer]
+    attr_accessor :sales_rep_id
+
+    # When `true`, indicates that the direct debit information stored on the
+    # client's account is to be used to pay for the contract.<br />
+    # This is only required if both `CreditCardInfo` and `StoredCardInfo` are
+    # not passed and `UseAccountCredit` is false.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_direct_debit
+
+    # When `true`, indicates that the account credit of the client's account is
+    # to be used to pay for the contract.<br />
+    # This is only required if both `CreditCardInfo` and `StoredCardInfo` are
+    # not passed and `UseDirectDebit` is false. <br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_account_credit
+
+    # When `true`, indicates that the consumer is present or otherwise able to
+    # successfully negotiate an SCA challenge. It is not a good idea to have
+    # this always be false as that could very likely lead to a bank declining
+    # all transactions for the merchant.
+    # Defaults to **false**.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :consumer_present
+
+    # The URL consumer is redirected to if the bank requests SCA. This field is
+    # only needed if ConsumerPresent is true.
+    # @return [String]
+    attr_accessor :payment_authentication_callback_url
+
+    # Optional, date to prorate contract
+    # @return [DateTime]
+    attr_accessor :prorate_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['test'] = 'Test'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['unique_client_id'] = 'UniqueClientId'
+      @_hash['contract_id'] = 'ContractId'
+      @_hash['start_date'] = 'StartDate'
+      @_hash['first_payment_occurs'] = 'FirstPaymentOccurs'
+      @_hash['client_signature'] = 'ClientSignature'
+      @_hash['promotion_code'] = 'PromotionCode'
+      @_hash['promotion_codes'] = 'PromotionCodes'
+      @_hash['credit_card_info'] = 'CreditCardInfo'
+      @_hash['stored_card_info'] = 'StoredCardInfo'
+      @_hash['send_notifications'] = 'SendNotifications'
+      @_hash['sales_rep_id'] = 'SalesRepId'
+      @_hash['use_direct_debit'] = 'UseDirectDebit'
+      @_hash['use_account_credit'] = 'UseAccountCredit'
+      @_hash['consumer_present'] = 'ConsumerPresent'
+      @_hash['payment_authentication_callback_url'] =
+        'PaymentAuthenticationCallbackUrl'
+      @_hash['prorate_date'] = 'ProrateDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        test
+        location_id
+        client_id
+        unique_client_id
+        start_date
+        first_payment_occurs
+        client_signature
+        promotion_code
+        promotion_codes
+        credit_card_info
+        stored_card_info
+        send_notifications
+        sales_rep_id
+        use_direct_debit
+        use_account_credit
+        consumer_present
+        payment_authentication_callback_url
+        prorate_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contract_id = nil, test = SKIP, location_id = SKIP,
+                   client_id = SKIP, unique_client_id = SKIP, start_date = SKIP,
+                   first_payment_occurs = SKIP, client_signature = SKIP,
+                   promotion_code = SKIP, promotion_codes = SKIP,
+                   credit_card_info = SKIP, stored_card_info = SKIP,
+                   send_notifications = SKIP, sales_rep_id = SKIP,
+                   use_direct_debit = SKIP, use_account_credit = SKIP,
+                   consumer_present = SKIP,
+                   payment_authentication_callback_url = SKIP,
+                   prorate_date = SKIP)
+      @test = test unless test == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @unique_client_id = unique_client_id unless unique_client_id == SKIP
+      @contract_id = contract_id
+      @start_date = start_date unless start_date == SKIP
+      @first_payment_occurs = first_payment_occurs unless first_payment_occurs == SKIP
+      @client_signature = client_signature unless client_signature == SKIP
+      @promotion_code = promotion_code unless promotion_code == SKIP
+      @promotion_codes = promotion_codes unless promotion_codes == SKIP
+      @credit_card_info = credit_card_info unless credit_card_info == SKIP
+      @stored_card_info = stored_card_info unless stored_card_info == SKIP
+      @send_notifications = send_notifications unless send_notifications == SKIP
+      @sales_rep_id = sales_rep_id unless sales_rep_id == SKIP
+      @use_direct_debit = use_direct_debit unless use_direct_debit == SKIP
+      @use_account_credit = use_account_credit unless use_account_credit == SKIP
+      @consumer_present = consumer_present unless consumer_present == SKIP
+      unless payment_authentication_callback_url == SKIP
+        @payment_authentication_callback_url =
+          payment_authentication_callback_url
+      end
+      @prorate_date = prorate_date unless prorate_date == 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.
+      contract_id = hash.key?('ContractId') ? hash['ContractId'] : nil
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      unique_client_id =
+        hash.key?('UniqueClientId') ? hash['UniqueClientId'] : SKIP
+      start_date = if hash.key?('StartDate')
+                     (DateTimeHelper.from_rfc3339(hash['StartDate']) if hash['StartDate'])
+                   else
+                     SKIP
+                   end
+      first_payment_occurs =
+        hash.key?('FirstPaymentOccurs') ? hash['FirstPaymentOccurs'] : SKIP
+      client_signature =
+        hash.key?('ClientSignature') ? hash['ClientSignature'] : SKIP
+      promotion_code = hash.key?('PromotionCode') ? hash['PromotionCode'] : SKIP
+      promotion_codes =
+        hash.key?('PromotionCodes') ? hash['PromotionCodes'] : SKIP
+      credit_card_info = CreditCardInfo.from_hash(hash['CreditCardInfo']) if
+        hash['CreditCardInfo']
+      stored_card_info = StoredCardInfo.from_hash(hash['StoredCardInfo']) if
+        hash['StoredCardInfo']
+      send_notifications =
+        hash.key?('SendNotifications') ? hash['SendNotifications'] : SKIP
+      sales_rep_id = hash.key?('SalesRepId') ? hash['SalesRepId'] : SKIP
+      use_direct_debit =
+        hash.key?('UseDirectDebit') ? hash['UseDirectDebit'] : SKIP
+      use_account_credit =
+        hash.key?('UseAccountCredit') ? hash['UseAccountCredit'] : SKIP
+      consumer_present =
+        hash.key?('ConsumerPresent') ? hash['ConsumerPresent'] : SKIP
+      payment_authentication_callback_url =
+        hash.key?('PaymentAuthenticationCallbackUrl') ? hash['PaymentAuthenticationCallbackUrl'] : SKIP
+      prorate_date = if hash.key?('ProrateDate')
+                       (DateTimeHelper.from_rfc3339(hash['ProrateDate']) if hash['ProrateDate'])
+                     else
+                       SKIP
+                     end
+
+      # Create object from extracted values.
+      PurchaseContractRequest.new(contract_id,
+                                  test,
+                                  location_id,
+                                  client_id,
+                                  unique_client_id,
+                                  start_date,
+                                  first_payment_occurs,
+                                  client_signature,
+                                  promotion_code,
+                                  promotion_codes,
+                                  credit_card_info,
+                                  stored_card_info,
+                                  send_notifications,
+                                  sales_rep_id,
+                                  use_direct_debit,
+                                  use_account_credit,
+                                  consumer_present,
+                                  payment_authentication_callback_url,
+                                  prorate_date)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_prorate_date
+      DateTimeHelper.to_rfc3339(prorate_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} test: #{@test}, location_id: #{@location_id}, client_id: #{@client_id},"\
+      " unique_client_id: #{@unique_client_id}, contract_id: #{@contract_id}, start_date:"\
+      " #{@start_date}, first_payment_occurs: #{@first_payment_occurs}, client_signature:"\
+      " #{@client_signature}, promotion_code: #{@promotion_code}, promotion_codes:"\
+      " #{@promotion_codes}, credit_card_info: #{@credit_card_info}, stored_card_info:"\
+      " #{@stored_card_info}, send_notifications: #{@send_notifications}, sales_rep_id:"\
+      " #{@sales_rep_id}, use_direct_debit: #{@use_direct_debit}, use_account_credit:"\
+      " #{@use_account_credit}, consumer_present: #{@consumer_present},"\
+      " payment_authentication_callback_url: #{@payment_authentication_callback_url},"\
+      " prorate_date: #{@prorate_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} test: #{@test.inspect}, location_id: #{@location_id.inspect}, client_id:"\
+      " #{@client_id.inspect}, unique_client_id: #{@unique_client_id.inspect}, contract_id:"\
+      " #{@contract_id.inspect}, start_date: #{@start_date.inspect}, first_payment_occurs:"\
+      " #{@first_payment_occurs.inspect}, client_signature: #{@client_signature.inspect},"\
+      " promotion_code: #{@promotion_code.inspect}, promotion_codes: #{@promotion_codes.inspect},"\
+      " credit_card_info: #{@credit_card_info.inspect}, stored_card_info:"\
+      " #{@stored_card_info.inspect}, send_notifications: #{@send_notifications.inspect},"\
+      " sales_rep_id: #{@sales_rep_id.inspect}, use_direct_debit: #{@use_direct_debit.inspect},"\
+      " use_account_credit: #{@use_account_credit.inspect}, consumer_present:"\
+      " #{@consumer_present.inspect}, payment_authentication_callback_url:"\
+      " #{@payment_authentication_callback_url.inspect}, prorate_date: #{@prorate_date.inspect}>"
+    end
+  end
+end