mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/initiate_checkout_shopping_cart_using_alternative_payments_request.rb

@@ -0,0 +1,265 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The API Request model for Initiate Checkout Shopping Cart API.
+  class InitiateCheckoutShoppingCartUsingAlternativePaymentsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID of the shopping cart to be processed. You can use this value
+    # to maintain a persistent cart. If you do not specify a cart ID, the
+    # MINDBODY software generates one.
+    # @return [String]
+    attr_accessor :cart_id
+
+    # The RSSID of the client making the purchase. A cart can be validated
+    # without a client ID, but a client ID must be specified to complete a sale.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The RSSID of the client paying for the purchase. This client needs to have
+    # a relationship of type "Pays for" with the client specified in the
+    # "ClientId" field.
+    # @return [String]
+    attr_accessor :payer_client_id
+
+    # When `true`, indicates that the contents of the cart are validated, but
+    # the transaction does not take place. You should use this parameter during
+    # testing and when checking the calculated totals of the items in the
+    # cart.<br />
+    # When `false`, the transaction takes place and the database is affected.<br
+    # />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # A list of the items in the cart.
+    # @return [Array[CheckoutItemWrapper]]
+    attr_accessor :items
+
+    # When `true`, indicates that the cart is to be completed by a staff member
+    # and is to take place at one of the business’ physical locations.<br />
+    # When `false`, indicates that the cart is to be completed by a client from
+    # the business’ online store.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :in_store
+
+    # When `true`, indicates that the tax should be calculated.
+    # When `false`, indicates that the tax should not be calculated.
+    # Default: **true**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :calculate_tax
+
+    # Promotion code to be applied to the cart.
+    # @return [String]
+    attr_accessor :promotion_code
+
+    # A list of payment information objects to be applied to payment against the
+    # items in the cart.
+    # @return [Array[CheckoutAlternativePaymentInfo]]
+    attr_accessor :payments
+
+    # When `true`, sends a purchase receipt email to the client. Note that all
+    # appropriate permissions and settings must be enabled for the client to
+    # receive an email.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email
+
+    # The location ID to be used for pulling business mode prices and taxes. If
+    # no location ID is supplied, it defaults to the online store, represented
+    # by a null value. 
+    # Default: **null** (the online store)
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # The URL consumer is redirected to after the payment.
+    # @return [String]
+    attr_accessor :payment_authentication_callback_url
+
+    # The list of TransactionIds provided with initial response containing SCA
+    # Challenge URLs for ConsumerPresent transactions
+    # @return [Array[Integer]]
+    attr_accessor :transaction_ids
+
+    # the flag to check billing post code is required or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_billing_postal_code_required
+
+    # When `true`, enforces "sell at" location restrictions on the cart items.
+    # When `false`, "sell at" location restrictions are not enforced.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enforce_location_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cart_id'] = 'CartId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['payer_client_id'] = 'PayerClientId'
+      @_hash['test'] = 'Test'
+      @_hash['items'] = 'Items'
+      @_hash['in_store'] = 'InStore'
+      @_hash['calculate_tax'] = 'CalculateTax'
+      @_hash['promotion_code'] = 'PromotionCode'
+      @_hash['payments'] = 'Payments'
+      @_hash['send_email'] = 'SendEmail'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['payment_authentication_callback_url'] =
+        'PaymentAuthenticationCallbackUrl'
+      @_hash['transaction_ids'] = 'TransactionIds'
+      @_hash['is_billing_postal_code_required'] =
+        'IsBillingPostalCodeRequired'
+      @_hash['enforce_location_restrictions'] = 'EnforceLocationRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cart_id
+        payer_client_id
+        test
+        in_store
+        calculate_tax
+        promotion_code
+        send_email
+        location_id
+        transaction_ids
+        is_billing_postal_code_required
+        enforce_location_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, items = nil, payments = nil,
+                   payment_authentication_callback_url = nil, cart_id = SKIP,
+                   payer_client_id = SKIP, test = SKIP, in_store = SKIP,
+                   calculate_tax = SKIP, promotion_code = SKIP,
+                   send_email = SKIP, location_id = SKIP,
+                   transaction_ids = SKIP,
+                   is_billing_postal_code_required = SKIP,
+                   enforce_location_restrictions = SKIP)
+      @cart_id = cart_id unless cart_id == SKIP
+      @client_id = client_id
+      @payer_client_id = payer_client_id unless payer_client_id == SKIP
+      @test = test unless test == SKIP
+      @items = items
+      @in_store = in_store unless in_store == SKIP
+      @calculate_tax = calculate_tax unless calculate_tax == SKIP
+      @promotion_code = promotion_code unless promotion_code == SKIP
+      @payments = payments
+      @send_email = send_email unless send_email == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @payment_authentication_callback_url = payment_authentication_callback_url
+      @transaction_ids = transaction_ids unless transaction_ids == SKIP
+      unless is_billing_postal_code_required == SKIP
+        @is_billing_postal_code_required =
+          is_billing_postal_code_required
+      end
+      unless enforce_location_restrictions == SKIP
+        @enforce_location_restrictions =
+          enforce_location_restrictions
+      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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['Items'].nil?
+        items = []
+        hash['Items'].each do |structure|
+          items << (CheckoutItemWrapper.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('Items')
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['Payments'].nil?
+        payments = []
+        hash['Payments'].each do |structure|
+          payments << (CheckoutAlternativePaymentInfo.from_hash(structure) if structure)
+        end
+      end
+
+      payments = nil unless hash.key?('Payments')
+      payment_authentication_callback_url =
+        hash.key?('PaymentAuthenticationCallbackUrl') ? hash['PaymentAuthenticationCallbackUrl'] : nil
+      cart_id = hash.key?('CartId') ? hash['CartId'] : SKIP
+      payer_client_id =
+        hash.key?('PayerClientId') ? hash['PayerClientId'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      in_store = hash.key?('InStore') ? hash['InStore'] : SKIP
+      calculate_tax = hash.key?('CalculateTax') ? hash['CalculateTax'] : SKIP
+      promotion_code = hash.key?('PromotionCode') ? hash['PromotionCode'] : SKIP
+      send_email = hash.key?('SendEmail') ? hash['SendEmail'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      transaction_ids =
+        hash.key?('TransactionIds') ? hash['TransactionIds'] : SKIP
+      is_billing_postal_code_required =
+        hash.key?('IsBillingPostalCodeRequired') ? hash['IsBillingPostalCodeRequired'] : SKIP
+      enforce_location_restrictions =
+        hash.key?('EnforceLocationRestrictions') ? hash['EnforceLocationRestrictions'] : SKIP
+
+      # Create object from extracted values.
+      InitiateCheckoutShoppingCartUsingAlternativePaymentsRequest.new(client_id,
+                                                                      items,
+                                                                      payments,
+                                                                      payment_authentication_callback_url,
+                                                                      cart_id,
+                                                                      payer_client_id,
+                                                                      test,
+                                                                      in_store,
+                                                                      calculate_tax,
+                                                                      promotion_code,
+                                                                      send_email,
+                                                                      location_id,
+                                                                      transaction_ids,
+                                                                      is_billing_postal_code_required,
+                                                                      enforce_location_restrictions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cart_id: #{@cart_id}, client_id: #{@client_id}, payer_client_id:"\
+      " #{@payer_client_id}, test: #{@test}, items: #{@items}, in_store: #{@in_store},"\
+      " calculate_tax: #{@calculate_tax}, promotion_code: #{@promotion_code}, payments:"\
+      " #{@payments}, send_email: #{@send_email}, location_id: #{@location_id},"\
+      " payment_authentication_callback_url: #{@payment_authentication_callback_url},"\
+      " transaction_ids: #{@transaction_ids}, is_billing_postal_code_required:"\
+      " #{@is_billing_postal_code_required}, enforce_location_restrictions:"\
+      " #{@enforce_location_restrictions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cart_id: #{@cart_id.inspect}, client_id: #{@client_id.inspect},"\
+      " payer_client_id: #{@payer_client_id.inspect}, test: #{@test.inspect}, items:"\
+      " #{@items.inspect}, in_store: #{@in_store.inspect}, calculate_tax:"\
+      " #{@calculate_tax.inspect}, promotion_code: #{@promotion_code.inspect}, payments:"\
+      " #{@payments.inspect}, send_email: #{@send_email.inspect}, location_id:"\
+      " #{@location_id.inspect}, payment_authentication_callback_url:"\
+      " #{@payment_authentication_callback_url.inspect}, transaction_ids:"\
+      " #{@transaction_ids.inspect}, is_billing_postal_code_required:"\
+      " #{@is_billing_postal_code_required.inspect}, enforce_location_restrictions:"\
+      " #{@enforce_location_restrictions.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/initiate_purchase_contract_request.rb

@@ -0,0 +1,184 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Request to initiate a purchase contract.
+  class InitiatePurchaseContractRequest < 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 />
+    # This endpoint DOES NOT support the `Test` parameter.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # The ID of the location where the client is purchasing the contract; used
+    # for AutoPays. If no location ID is supplied, it defaults to the online
+    # store, represented by a null value. 
+    # Default: **null** (Online store location)
+    # @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 ID of the contract being purchased.
+    # @return [Integer]
+    attr_accessor :contract_id
+
+    # 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
+
+    # 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
+
+    # The URL consumer is redirected to after the payment.
+    # @return [String]
+    attr_accessor :payment_authentication_callback_url
+
+    # The type of alternative payment. Possible values are:
+    # * 997 - Indicates that the payment method is iDEAL.
+    # * 801 - Indicates that the payment method is Apple Pay.
+    # @return [Integer]
+    attr_accessor :payment_method_id
+
+    # 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['contract_id'] = 'ContractId'
+      @_hash['promotion_code'] = 'PromotionCode'
+      @_hash['promotion_codes'] = 'PromotionCodes'
+      @_hash['send_notifications'] = 'SendNotifications'
+      @_hash['sales_rep_id'] = 'SalesRepId'
+      @_hash['payment_authentication_callback_url'] =
+        'PaymentAuthenticationCallbackUrl'
+      @_hash['payment_method_id'] = 'PaymentMethodId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        test
+        location_id
+        promotion_code
+        promotion_codes
+        send_notifications
+        sales_rep_id
+        payment_authentication_callback_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, contract_id = nil, payment_method_id = nil,
+                   test = SKIP, location_id = SKIP, promotion_code = SKIP,
+                   promotion_codes = SKIP, send_notifications = SKIP,
+                   sales_rep_id = SKIP,
+                   payment_authentication_callback_url = SKIP)
+      @test = test unless test == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @client_id = client_id
+      @contract_id = contract_id
+      @promotion_code = promotion_code unless promotion_code == SKIP
+      @promotion_codes = promotion_codes unless promotion_codes == SKIP
+      @send_notifications = send_notifications unless send_notifications == SKIP
+      @sales_rep_id = sales_rep_id unless sales_rep_id == SKIP
+      unless payment_authentication_callback_url == SKIP
+        @payment_authentication_callback_url =
+          payment_authentication_callback_url
+      end
+      @payment_method_id = payment_method_id
+    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
+      contract_id = hash.key?('ContractId') ? hash['ContractId'] : nil
+      payment_method_id =
+        hash.key?('PaymentMethodId') ? hash['PaymentMethodId'] : nil
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      promotion_code = hash.key?('PromotionCode') ? hash['PromotionCode'] : SKIP
+      promotion_codes =
+        hash.key?('PromotionCodes') ? hash['PromotionCodes'] : SKIP
+      send_notifications =
+        hash.key?('SendNotifications') ? hash['SendNotifications'] : SKIP
+      sales_rep_id = hash.key?('SalesRepId') ? hash['SalesRepId'] : SKIP
+      payment_authentication_callback_url =
+        hash.key?('PaymentAuthenticationCallbackUrl') ? hash['PaymentAuthenticationCallbackUrl'] : SKIP
+
+      # Create object from extracted values.
+      InitiatePurchaseContractRequest.new(client_id,
+                                          contract_id,
+                                          payment_method_id,
+                                          test,
+                                          location_id,
+                                          promotion_code,
+                                          promotion_codes,
+                                          send_notifications,
+                                          sales_rep_id,
+                                          payment_authentication_callback_url)
+    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},"\
+      " contract_id: #{@contract_id}, promotion_code: #{@promotion_code}, promotion_codes:"\
+      " #{@promotion_codes}, send_notifications: #{@send_notifications}, sales_rep_id:"\
+      " #{@sales_rep_id}, payment_authentication_callback_url:"\
+      " #{@payment_authentication_callback_url}, payment_method_id: #{@payment_method_id}>"
+    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}, contract_id: #{@contract_id.inspect}, promotion_code:"\
+      " #{@promotion_code.inspect}, promotion_codes: #{@promotion_codes.inspect},"\
+      " send_notifications: #{@send_notifications.inspect}, sales_rep_id:"\
+      " #{@sales_rep_id.inspect}, payment_authentication_callback_url:"\
+      " #{@payment_authentication_callback_url.inspect}, payment_method_id:"\
+      " #{@payment_method_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/issue_request.rb

@@ -0,0 +1,71 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # POST UserToken/Issue request
+  class IssueRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The staff member’s username.
+    # @return [String]
+    attr_accessor :username
+
+    # The staff member’s password.
+    # @return [String]
+    attr_accessor :password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'Username'
+      @_hash['password'] = 'Password'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        username
+        password
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(username = SKIP, password = SKIP)
+      @username = username unless username == SKIP
+      @password = password unless password == 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.
+      username = hash.key?('Username') ? hash['Username'] : SKIP
+      password = hash.key?('Password') ? hash['Password'] : SKIP
+
+      # Create object from extracted values.
+      IssueRequest.new(username,
+                       password)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} username: #{@username}, password: #{@password}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} username: #{@username.inspect}, password: #{@password.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/issue_response.rb

@@ -0,0 +1,101 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # POST UserToken/Issue successful response
+  class IssueResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :token_type
+
+    # The authentication token value.
+    # @return [String]
+    attr_accessor :access_token
+
+    # Token expiration in UTC.
+    # @return [DateTime]
+    attr_accessor :expires
+
+    # Token expiration in UTC.
+    # @return [User]
+    attr_accessor :user
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token_type'] = 'TokenType'
+      @_hash['access_token'] = 'AccessToken'
+      @_hash['expires'] = 'Expires'
+      @_hash['user'] = 'User'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token_type
+        access_token
+        expires
+        user
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token_type = SKIP, access_token = SKIP, expires = SKIP,
+                   user = SKIP)
+      @token_type = token_type unless token_type == SKIP
+      @access_token = access_token unless access_token == SKIP
+      @expires = expires unless expires == SKIP
+      @user = user unless user == 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.
+      token_type = hash.key?('TokenType') ? hash['TokenType'] : SKIP
+      access_token = hash.key?('AccessToken') ? hash['AccessToken'] : SKIP
+      expires = if hash.key?('Expires')
+                  (DateTimeHelper.from_rfc3339(hash['Expires']) if hash['Expires'])
+                else
+                  SKIP
+                end
+      user = User.from_hash(hash['User']) if hash['User']
+
+      # Create object from extracted values.
+      IssueResponse.new(token_type,
+                        access_token,
+                        expires,
+                        user)
+    end
+
+    def to_custom_expires
+      DateTimeHelper.to_rfc3339(expires)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token_type: #{@token_type}, access_token: #{@access_token}, expires:"\
+      " #{@expires}, user: #{@user}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token_type: #{@token_type.inspect}, access_token: #{@access_token.inspect},"\
+      " expires: #{@expires.inspect}, user: #{@user.inspect}>"
+    end
+  end
+end