square_connect 2.4.0.175 → 2.5.0.180

data/lib/square_connect/models/refund.rb

@@ -39,6 +39,9 @@ module SquareConnect
     # The amount of Square processing fee money refunded to the *merchant*.
     attr_accessor :processing_fee_money
 
+    # Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.
+    attr_accessor :additional_recipients
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -72,7 +75,8 @@ module SquareConnect
         :'reason' => :'reason',
         :'amount_money' => :'amount_money',
         :'status' => :'status',
-        :'processing_fee_money' => :'processing_fee_money'
+        :'processing_fee_money' => :'processing_fee_money',
+        :'additional_recipients' => :'additional_recipients'
       }
     end
 
@@ -87,7 +91,8 @@ module SquareConnect
         :'reason' => :'String',
         :'amount_money' => :'Money',
         :'status' => :'String',
-        :'processing_fee_money' => :'Money'
+        :'processing_fee_money' => :'Money',
+        :'additional_recipients' => :'Array<AdditionalRecipient>'
       }
     end
 
@@ -135,6 +140,12 @@ module SquareConnect
         self.processing_fee_money = attributes[:'processing_fee_money']
       end
 
+      if attributes.has_key?(:'additional_recipients')
+        if (value = attributes[:'additional_recipients']).is_a?(Array)
+          self.additional_recipients = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -210,7 +221,8 @@ module SquareConnect
           reason == o.reason &&
           amount_money == o.amount_money &&
           status == o.status &&
-          processing_fee_money == o.processing_fee_money
+          processing_fee_money == o.processing_fee_money &&
+          additional_recipients == o.additional_recipients
     end
 
     # @see the `==` method
@@ -222,7 +234,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money].hash
+      [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money, additional_recipients].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/tender.rb

@@ -45,6 +45,9 @@ module SquareConnect
     # The details of the cash tender.  This value is present only if the value of `type` is `CASH`.
     attr_accessor :cash_details
 
+    # Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.
+    attr_accessor :additional_recipients
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -80,7 +83,8 @@ module SquareConnect
         :'customer_id' => :'customer_id',
         :'type' => :'type',
         :'card_details' => :'card_details',
-        :'cash_details' => :'cash_details'
+        :'cash_details' => :'cash_details',
+        :'additional_recipients' => :'additional_recipients'
       }
     end
 
@@ -97,7 +101,8 @@ module SquareConnect
         :'customer_id' => :'String',
         :'type' => :'String',
         :'card_details' => :'TenderCardDetails',
-        :'cash_details' => :'TenderCashDetails'
+        :'cash_details' => :'TenderCashDetails',
+        :'additional_recipients' => :'Array<AdditionalRecipient>'
       }
     end
 
@@ -153,6 +158,12 @@ module SquareConnect
         self.cash_details = attributes[:'cash_details']
       end
 
+      if attributes.has_key?(:'additional_recipients')
+        if (value = attributes[:'additional_recipients']).is_a?(Array)
+          self.additional_recipients = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -200,7 +211,8 @@ module SquareConnect
           customer_id == o.customer_id &&
           type == o.type &&
           card_details == o.card_details &&
-          cash_details == o.cash_details
+          cash_details == o.cash_details &&
+          additional_recipients == o.additional_recipients
     end
 
     # @see the `==` method
@@ -212,7 +224,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, location_id, transaction_id, created_at, note, amount_money, processing_fee_money, customer_id, type, card_details, cash_details].hash
+      [id, location_id, transaction_id, created_at, note, amount_money, processing_fee_money, customer_id, type, card_details, cash_details, additional_recipients].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/version.rb

@@ -8,5 +8,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module SquareConnect
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/spec/api/apple_pay_api_spec.rb

@@ -0,0 +1,44 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::ApplePayApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ApplePayApi' do
+  before do
+    # run before each test
+    @instance = SquareConnect::ApplePayApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ApplePayApi' do
+    it 'should create an instact of ApplePayApi' do
+      expect(@instance).to be_instance_of(SquareConnect::ApplePayApi)
+    end
+  end
+
+  # unit tests for register_domain
+  # RegisterDomain
+  # Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.  This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.  To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](https://docs.connect.squareup.com/articles/adding-payment-form) guide.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [RegisterDomainResponse]
+  describe 'register_domain test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/orders_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::OrdersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'OrdersApi' do
+  before do
+    # run before each test
+    @instance = SquareConnect::OrdersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrdersApi' do
+    it 'should create an instact of OrdersApi' do
+      expect(@instance).to be_instance_of(SquareConnect::OrdersApi)
+    end
+  end
+
+  # unit tests for batch_retrieve_orders
+  # BatchRetrieveOrders
+  # Retrieves a set of [Order](#type-order)s by their IDs. Only orders that have been successfully charged are included in the response.  If any of the order IDs in the request do not exist, or are associated with uncharged orders, then those orders will not be included in the set of orders in the response.  Note that in the future, uncharged orders may be returned by this endpoint.
+  # @param location_id The ID of the orders' associated location.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [BatchRetrieveOrdersResponse]
+  describe 'batch_retrieve_orders test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_order
+  # CreateOrder
+  # Creates an [Order](#type-order) that can then be referenced as `order_id` in a request to the [Charge](#endpoint-charge) endpoint. Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase.  To associate a created order with a request to the Charge endpoint, provide the order's `id` in the `order_id` field of your request.  You cannot modify an order after you create it. If you need to modify an order, instead create a new order with modified details.  To learn more about the Orders API, see the [Orders API Overview](https://docs.connect.squareup.com/articles/orders-api-overview).
+  # @param location_id The ID of the business location to associate the order with.
+  # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+  # @param [Hash] opts the optional parameters
+  # @return [CreateOrderResponse]
+  describe 'create_order test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/reporting_api_spec.rb

@@ -0,0 +1,88 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SquareConnect::ReportingApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ReportingApi' do
+  let(:accounts) { load_accounts() }
+  let(:account) { accounts['US-Prod'] }
+  let(:location_id) { account['location_id'] }
+  let(:instance) do
+    configuration = SquareConnect::Configuration.new do |config|
+      config.access_token = account['access_token']
+    end
+    client = SquareConnect::ApiClient.new(configuration)
+
+    SquareConnect::ReportingApi.new(client)
+  end
+
+  describe 'test an instance of ReportingApi' do
+    it 'should create an instance of ReportingApi' do
+      expect(instance).to be_instance_of(SquareConnect::ReportingApi)
+    end
+  end
+
+  # unit tests for list_additional_recipient_receivable_refunds
+  # ListAdditionalRecipientReceivableRefunds
+  # Lists Additional Recipient Receivable Refunds for a particular location.  Max results per [page](#paginatingresults): 50
+  # @param location_id The ID of the location to list AdditionalRecipientReceivableRefunds for.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
+  # @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  # @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
+  # @return [ListAdditionalRecipientReceivableRefundsResponse]
+  describe 'list_additional_recipient_receivable_refunds test' do
+    let(:request) do
+      {
+        begin_time: (DateTime.now - 30).rfc3339,
+        end_time: DateTime.now.rfc3339,
+        sort_order: 'DESC'
+      }
+    end
+
+    it 'should succeed' do
+      response = instance.list_additional_recipient_receivable_refunds(location_id, request)
+
+      expect(response.errors).to be_nil
+    end
+  end
+
+  # unit tests for list_additional_recipient_receivables
+  # ListAdditionalRecipientReceivables
+  # Lists Additional Recipient Receivables for a particular location.  Max results per [page](#paginatingresults): 50
+  # @param location_id The ID of the location to list AdditionalRecipientReceivables for.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
+  # @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
+  # @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
+  # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
+  # @return [ListAdditionalRecipientReceivablesResponse]
+  describe 'list_additional_recipient_receivables test' do
+    let(:request) do
+      {
+        begin_time: (DateTime.now - 30).rfc3339,
+        end_time: DateTime.now.rfc3339,
+        sort_order: 'DESC'
+      }
+    end
+
+    it 'should succeed' do
+      response = instance.list_additional_recipient_receivables(location_id, request)
+
+      expect(response.errors).to be_nil
+    end
+  end
+
+end

data/spec/api/transactions_api_spec.rb

@@ -32,8 +32,8 @@ describe 'TransactionsApi' do
   # unit tests for capture_transaction
   # CaptureTransaction
   # Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
-  # @param location_id 
-  # @param transaction_id 
+  # @param location_id
+  # @param transaction_id
   # @param [Hash] opts the optional parameters
   # @return [CaptureTransactionResponse]
   describe 'capture_transaction test' do
@@ -117,8 +117,8 @@ describe 'TransactionsApi' do
   # unit tests for void_transaction
   # VoidTransaction
   # Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`.  See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
-  # @param location_id 
-  # @param transaction_id 
+  # @param location_id
+  # @param transaction_id
   # @param [Hash] opts the optional parameters
   # @return [VoidTransactionResponse]
   describe 'void_transaction test' do

data/spec/models/additional_recipient_receivable_refund_spec.rb

@@ -0,0 +1,69 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SquareConnect::AdditionalRecipientReceivableRefund
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AdditionalRecipientReceivableRefund' do
+  before do
+    # run before each test
+    @instance = SquareConnect::AdditionalRecipientReceivableRefund.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AdditionalRecipientReceivableRefund' do
+    it 'should create an instact of AdditionalRecipientReceivableRefund' do
+      expect(@instance).to be_instance_of(SquareConnect::AdditionalRecipientReceivableRefund)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "receivable_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "refund_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "transaction_location_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "amount_money"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/additional_recipient_receivable_spec.rb

@@ -0,0 +1,69 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SquareConnect::AdditionalRecipientReceivable
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AdditionalRecipientReceivable' do
+  before do
+    # run before each test
+    @instance = SquareConnect::AdditionalRecipientReceivable.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AdditionalRecipientReceivable' do
+    it 'should create an instact of AdditionalRecipientReceivable' do
+      expect(@instance).to be_instance_of(SquareConnect::AdditionalRecipientReceivable)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "transaction_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "transaction_location_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "amount_money"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "refunds"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+