square.rb 3.20190624.0 → 3.20190814.0

data/lib/square/client.rb

@@ -1,127 +1,139 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  #  square client class.
-  class Client
-    attr_reader :config
-
-    # Access to mobile_authorization controller.
-    # @return [MobileAuthorizationApi] Returns the controller instance.
-    def mobile_authorization
-      @mobile_authorization ||= MobileAuthorizationApi.new config
-    end
-
-    # Access to o_auth controller.
-    # @return [OAuthApi] Returns the controller instance.
-    def o_auth
-      @o_auth ||= OAuthApi.new config
-    end
-
-    # Access to v1_locations controller.
-    # @return [V1LocationsApi] Returns the controller instance.
-    def v1_locations
-      @v1_locations ||= V1LocationsApi.new config
-    end
-
-    # Access to v1_employees controller.
-    # @return [V1EmployeesApi] Returns the controller instance.
-    def v1_employees
-      @v1_employees ||= V1EmployeesApi.new config
-    end
-
-    # Access to v1_transactions controller.
-    # @return [V1TransactionsApi] Returns the controller instance.
-    def v1_transactions
-      @v1_transactions ||= V1TransactionsApi.new config
-    end
-
-    # Access to v1_items controller.
-    # @return [V1ItemsApi] Returns the controller instance.
-    def v1_items
-      @v1_items ||= V1ItemsApi.new config
-    end
-
-    # Access to apple_pay controller.
-    # @return [ApplePayApi] Returns the controller instance.
-    def apple_pay
-      @apple_pay ||= ApplePayApi.new config
-    end
-
-    # Access to catalog controller.
-    # @return [CatalogApi] Returns the controller instance.
-    def catalog
-      @catalog ||= CatalogApi.new config
-    end
-
-    # Access to customers controller.
-    # @return [CustomersApi] Returns the controller instance.
-    def customers
-      @customers ||= CustomersApi.new config
-    end
-
-    # Access to employees controller.
-    # @return [EmployeesApi] Returns the controller instance.
-    def employees
-      @employees ||= EmployeesApi.new config
-    end
-
-    # Access to inventory controller.
-    # @return [InventoryApi] Returns the controller instance.
-    def inventory
-      @inventory ||= InventoryApi.new config
-    end
-
-    # Access to labor controller.
-    # @return [LaborApi] Returns the controller instance.
-    def labor
-      @labor ||= LaborApi.new config
-    end
-
-    # Access to locations controller.
-    # @return [LocationsApi] Returns the controller instance.
-    def locations
-      @locations ||= LocationsApi.new config
-    end
-
-    # Access to reporting controller.
-    # @return [ReportingApi] Returns the controller instance.
-    def reporting
-      @reporting ||= ReportingApi.new config
-    end
-
-    # Access to checkout controller.
-    # @return [CheckoutApi] Returns the controller instance.
-    def checkout
-      @checkout ||= CheckoutApi.new config
-    end
-
-    # Access to orders controller.
-    # @return [OrdersApi] Returns the controller instance.
-    def orders
-      @orders ||= OrdersApi.new config
-    end
-
-    # Access to transactions controller.
-    # @return [TransactionsApi] Returns the controller instance.
-    def transactions
-      @transactions ||= TransactionsApi.new config
-    end
-
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace', config: nil)
-      @config = if config.nil?
-                  Configuration.new(timeout: timeout, max_retries: max_retries,
-                                    retry_interval: retry_interval,
-                                    backoff_factor: backoff_factor,
-                                    environment: environment,
-                                    access_token: access_token)
-                else
-                  config
-                end
-    end
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  #  square client class.
+  class Client
+    attr_reader :config
+
+    # Access to mobile_authorization controller.
+    # @return [MobileAuthorizationApi] Returns the controller instance.
+    def mobile_authorization
+      @mobile_authorization ||= MobileAuthorizationApi.new config
+    end
+
+    # Access to o_auth controller.
+    # @return [OAuthApi] Returns the controller instance.
+    def o_auth
+      @o_auth ||= OAuthApi.new config
+    end
+
+    # Access to v1_locations controller.
+    # @return [V1LocationsApi] Returns the controller instance.
+    def v1_locations
+      @v1_locations ||= V1LocationsApi.new config
+    end
+
+    # Access to v1_employees controller.
+    # @return [V1EmployeesApi] Returns the controller instance.
+    def v1_employees
+      @v1_employees ||= V1EmployeesApi.new config
+    end
+
+    # Access to v1_transactions controller.
+    # @return [V1TransactionsApi] Returns the controller instance.
+    def v1_transactions
+      @v1_transactions ||= V1TransactionsApi.new config
+    end
+
+    # Access to v1_items controller.
+    # @return [V1ItemsApi] Returns the controller instance.
+    def v1_items
+      @v1_items ||= V1ItemsApi.new config
+    end
+
+    # Access to apple_pay controller.
+    # @return [ApplePayApi] Returns the controller instance.
+    def apple_pay
+      @apple_pay ||= ApplePayApi.new config
+    end
+
+    # Access to catalog controller.
+    # @return [CatalogApi] Returns the controller instance.
+    def catalog
+      @catalog ||= CatalogApi.new config
+    end
+
+    # Access to customers controller.
+    # @return [CustomersApi] Returns the controller instance.
+    def customers
+      @customers ||= CustomersApi.new config
+    end
+
+    # Access to employees controller.
+    # @return [EmployeesApi] Returns the controller instance.
+    def employees
+      @employees ||= EmployeesApi.new config
+    end
+
+    # Access to inventory controller.
+    # @return [InventoryApi] Returns the controller instance.
+    def inventory
+      @inventory ||= InventoryApi.new config
+    end
+
+    # Access to labor controller.
+    # @return [LaborApi] Returns the controller instance.
+    def labor
+      @labor ||= LaborApi.new config
+    end
+
+    # Access to locations controller.
+    # @return [LocationsApi] Returns the controller instance.
+    def locations
+      @locations ||= LocationsApi.new config
+    end
+
+    # Access to reporting controller.
+    # @return [ReportingApi] Returns the controller instance.
+    def reporting
+      @reporting ||= ReportingApi.new config
+    end
+
+    # Access to checkout controller.
+    # @return [CheckoutApi] Returns the controller instance.
+    def checkout
+      @checkout ||= CheckoutApi.new config
+    end
+
+    # Access to orders controller.
+    # @return [OrdersApi] Returns the controller instance.
+    def orders
+      @orders ||= OrdersApi.new config
+    end
+
+    # Access to transactions controller.
+    # @return [TransactionsApi] Returns the controller instance.
+    def transactions
+      @transactions ||= TransactionsApi.new config
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsApi] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsApi.new config
+    end
+
+    # Access to refunds controller.
+    # @return [RefundsApi] Returns the controller instance.
+    def refunds
+      @refunds ||= RefundsApi.new config
+    end
+
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 1, environment: 'production',
+                   access_token: 'TODO: Replace', config: nil)
+      @config = if config.nil?
+                  Configuration.new(timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    environment: environment,
+                                    access_token: access_token)
+                else
+                  config
+                end
+    end
+  end
+end

data/lib/square/configuration.rb

@@ -1,85 +1,88 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  # All configuration including auth info and base URI for the API access
-  # are configured in this class.
-  class Configuration
-    # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    attr_reader :max_retries
-    attr_reader :retry_interval
-    attr_reader :backoff_factor
-    attr_reader :environment
-    attr_reader :access_token
-
-    class << self
-      attr_reader :environments
-    end
-
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 1, environment: 'production',
-                   access_token: 'TODO: Replace')
-      # The value to use for connection timeout
-      @timeout = timeout
-
-      # The number of times to retry an endpoint call if it fails
-      @max_retries = max_retries
-
-      # Pause in seconds between retries
-      @retry_interval = retry_interval
-
-      # The amount to multiply each successive retry's interval amount
-      # by in order to provide backoff
-      @backoff_factor = backoff_factor
-
-      # Current API environment
-      @environment = environment
-
-      # OAuth 2.0 Access Token
-      @access_token = access_token
-
-      # The Http Client to use for making requests.
-      @http_client = create_http_client
-    end
-
-    def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, access_token: nil)
-      timeout ||= self.timeout
-      max_retries ||= self.max_retries
-      retry_interval ||= self.retry_interval
-      backoff_factor ||= self.backoff_factor
-      environment ||= self.environment
-      access_token ||= self.access_token
-
-      Configuration.new(timeout: timeout, max_retries: max_retries,
-                        retry_interval: retry_interval,
-                        backoff_factor: backoff_factor,
-                        environment: environment, access_token: access_token)
-    end
-
-    def create_http_client
-      FaradayClient.new(timeout: timeout, max_retries: max_retries,
-                        retry_interval: retry_interval,
-                        backoff_factor: backoff_factor)
-    end
-
-    # All the environments the SDK can run in.
-    @environments = {
-      'production' => {
-        'default' => 'https://connect.squareup.com'
-      }
-    }
-
-    # Generates the appropriate base URI for the environment and the server.
-    # @param [Configuration::Server] The server enum for which the base URI is
-    # required.
-    # @return [String] The base URI.
-    def get_base_uri(server = 'default')
-      self.class.environments[environment][server].clone
-    end
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration
+    # The attribute readers for properties.
+    attr_reader :http_client
+    attr_reader :timeout
+    attr_reader :max_retries
+    attr_reader :retry_interval
+    attr_reader :backoff_factor
+    attr_reader :environment
+    attr_reader :access_token
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 1, environment: 'production',
+                   access_token: 'TODO: Replace')
+      # The value to use for connection timeout
+      @timeout = timeout
+
+      # The number of times to retry an endpoint call if it fails
+      @max_retries = max_retries
+
+      # Pause in seconds between retries
+      @retry_interval = retry_interval
+
+      # The amount to multiply each successive retry's interval amount
+      # by in order to provide backoff
+      @backoff_factor = backoff_factor
+
+      # Current API environment
+      @environment = environment
+
+      # OAuth 2.0 Access Token
+      @access_token = access_token
+
+      # The Http Client to use for making requests.
+      @http_client = create_http_client
+    end
+
+    def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
+                   backoff_factor: nil, environment: nil, access_token: nil)
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      environment ||= self.environment
+      access_token ||= self.access_token
+
+      Configuration.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        environment: environment, access_token: access_token)
+    end
+
+    def create_http_client
+      FaradayClient.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor)
+    end
+
+    # All the environments the SDK can run in.
+    @environments = {
+      'production' => {
+        'default' => 'https://connect.squareup.com'
+      },
+      'sandbox' => {
+        'default' => 'https://connect.squareupsandbox.com'
+      }
+    }
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = 'default')
+      self.class.environments[environment][server].clone
+    end
+  end
+end

data/lib/square/exceptions/api_exception.rb

@@ -1,20 +1,20 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  # Class for exceptions when there is a network error, status code error, etc.
-  class APIException < StandardError
-    attr_reader :response, :response_code
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason)
-      @response = response
-      @response_code = response.status_code
-    end
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :response, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason)
+      @response = response
+      @response_code = response.status_code
+    end
+  end
+end

data/lib/square/http/api_response.rb

@@ -1,50 +1,50 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  # Http response received.
-  class ApiResponse
-    attr_reader(:status_code, :reason_phrase, :headers, :raw_body, :request,
-                :data, :errors, :body, :cursor)
-
-    # The constructor
-    # @param [HttpResponse] The original, raw response from the api.
-    # @param [Object] The data field specified for the response.
-    # @param [Array<String>] Any errors returned by the server.
-    def initialize(http_response,
-                   data: nil,
-                   errors: nil)
-      @status_code = http_response.status_code
-      @reason_phrase = http_response.reason_phrase
-      @headers = http_response.headers
-      @raw_body = http_response.raw_body
-      @request = http_response.request
-      @errors = errors
-
-      if data.is_a? Hash
-        if data.keys.any?
-          @body = Struct.new(*data.keys) do
-            define_method(:to_s) { http_response.raw_body }
-          end.new(*data.values)
-
-          @cursor = data.fetch(:cursor, nil)
-          data.reject! { |k| k == :cursor || k == :errors }
-          @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
-        end
-      else
-        @data = data
-        @body = data
-      end
-    end
-
-    def success?
-      status_code >= 200 && status_code < 300
-    end
-
-    def error?
-      status_code >= 400 && status_code < 600
-    end
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # Http response received.
+  class ApiResponse
+    attr_reader(:status_code, :reason_phrase, :headers, :raw_body, :request,
+                :data, :errors, :body, :cursor)
+
+    # The constructor
+    # @param [HttpResponse] The original, raw response from the api.
+    # @param [Object] The data field specified for the response.
+    # @param [Array<String>] Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      @status_code = http_response.status_code
+      @reason_phrase = http_response.reason_phrase
+      @headers = http_response.headers
+      @raw_body = http_response.raw_body
+      @request = http_response.request
+      @errors = errors
+
+      if data.is_a? Hash
+        if data.keys.any?
+          @body = Struct.new(*data.keys) do
+            define_method(:to_s) { http_response.raw_body }
+          end.new(*data.values)
+
+          @cursor = data.fetch(:cursor, nil)
+          data.reject! { |k| k == :cursor || k == :errors }
+          @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
+        end
+      else
+        @data = data
+        @body = data
+      end
+    end
+
+    def success?
+      status_code >= 200 && status_code < 300
+    end
+
+    def error?
+      status_code >= 400 && status_code < 600
+    end
+  end
+end

data/lib/square/http/auth/o_auth2.rb

@@ -1,17 +1,17 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  # Utility class for OAuth 2 authorization and token management.
-  class OAuth2
-    # Add OAuth2 authentication to the http request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(config, http_request)
-      token = config.access_token
-      http_request.headers['Authorization'] = "Bearer #{token}"
-    end
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2
+    # Add OAuth2 authentication to the http request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      token = config.access_token
+      http_request.headers['Authorization'] = "Bearer #{token}"
+    end
+  end
+end