square.rb 6.1.0.20200722 → 6.2.0.20200812

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 274c6809492acf86fd49adee12a1ccc2045d394dfff9612914de1bc010eeb1cb
-  data.tar.gz: 99e6be9ca77af585b64213a3e607ac36f935182bbf9dc8529546548f37d2023c
+  metadata.gz: 491aaaccfa43e7c8d9d17a2d48624c28207bbea80dc75359d525b3d4cd64b0cf
+  data.tar.gz: 645d97dc4dcef2655903ad1f89dee5e361c6b072794bf2920d83fe66dfae1723
 SHA512:
-  metadata.gz: c13b32a0109ebd31d40394547775814ddb2aed9f50141b1cd36e3339d2c5e9b43d6f9cce2e0c3cc7775ad69034d3f0908c78c873d930f7d6cd7bfe4a20888e6c
-  data.tar.gz: eb897df878e5f4d861405c2580fb581ad28ce11e3d6ae467b193bc68822d88161238a111022c94d93d67c052c9321e90874550838723840de664313f02121003
+  metadata.gz: 41bc326ab367dae322de2187a0fb3d509384f5af88787e75ab37db42db1263833f65fd0bf39e48ecd60d437970752eb5380cba65eeee02a113c39ae48692e74d
+  data.tar.gz: d2f6cd63f7a4475ae78c64a980831c4f3b2b23ca8e657deb6dc737b188906987f2b67a21966ed74f7001c25553d5590b1a619c923713f25e9000d199f6196e21

data/README.md

@@ -38,6 +38,9 @@ gem 'square.rb'
 ### Orders
 * [Orders]
 
+### Subscriptions
+* [Subscriptions]
+
 ### Invoices
 * [Invoices]
 
@@ -312,4 +315,5 @@ You can also use the Square API to create applications or services that work wit
 [V1 Employees]: doc/v1-employees.md
 [V1 Transactions]: doc/v1-transactions.md
 [V1 Items]: doc/v1-items.md
-[Transactions]: doc/transactions.md
+[Transactions]: doc/transactions.md
+[Subscriptions]: doc/subscriptions.md

data/lib/square.rb

@@ -57,5 +57,6 @@ require_relative 'square/api/loyalty_api.rb'
 require_relative 'square/api/merchants_api.rb'
 require_relative 'square/api/payments_api.rb'
 require_relative 'square/api/refunds_api.rb'
+require_relative 'square/api/subscriptions_api.rb'
 require_relative 'square/api/team_api.rb'
 require_relative 'square/api/terminal_api.rb'

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/6.1.0.20200722',
+        'user-agent' => 'Square-Ruby-SDK/6.2.0.20200812',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/subscriptions_api.rb

@@ -0,0 +1,262 @@
+module Square
+  # SubscriptionsApi
+  class SubscriptionsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a subscription for a customer to a subscription plan.
+    # If you provide a card on file in the request, Square charges the card for
+    # the subscription. Otherwise, Square bills an invoice to the customer's
+    # email
+    # address. The subscription starts immediately, unless the request includes
+    # the optional `start_date`. Each individual subscription is associated with
+    # a particular location.
+    # For more information,
+    # see [Subscription API
+    # Overview](https://developer.squareup.com/docs/docs/subscriptions-api/overv
+    # iew).
+    # @param [CreateSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateSubscriptionResponse Hash] response from the API call
+    def create_subscription(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Searches for subscriptions.
+    # Results are ordered chronologically by subscription creation date. If
+    # the request specifies more than one location ID,
+    # the endpoint orders the result
+    # by location ID, and then by creation date within each location. If no
+    # locations are given
+    # in the query, all locations are searched.
+    # You can also optionally specify `customer_ids` to search by customer.
+    # If left unset, all customers
+    # associated with the specified locations are returned.
+    # If the request specifies customer IDs, the endpoint orders results
+    # first by location, within location by customer ID, and within
+    # customer by subscription creation date.
+    # For more information, see
+    # [Retrieve
+    # subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/
+    # overview#retrieve-subscriptions).
+    # @param [SearchSubscriptionsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchSubscriptionsResponse Hash] response from the API call
+    def search_subscriptions(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/search'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Retrieves a subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to retrieve.
+    # @return [RetrieveSubscriptionResponse Hash] response from the API call
+    def retrieve_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => subscription_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Updates a subscription. You can set, modify, and clear the
+    # `subscription` field values. For more information and examples, see
+    # [Update
+    # subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/
+    # overview#update-subscriptions).
+    # @param [String] subscription_id Required parameter: The ID for the
+    # subscription to update.
+    # @param [UpdateSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateSubscriptionResponse Hash] response from the API call
+    def update_subscription(subscription_id:,
+                            body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => subscription_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Cancels a subscription immediately and sets the subscription
+    # `status` to `CANCELED`. You can also use the `UpdateSubscription`
+    # endpoint to cancel a subscription at a future date. For more
+    # information, see
+    # [CancelSubscriptions](https://developer.squareup.com/docs/docs/subscriptio
+    # ns-api/overview#cancel-subscriptions).
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to cancel.
+    # @return [CancelSubscriptionResponse Hash] response from the API call
+    def cancel_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => subscription_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+
+    # Lists all events for a specific subscription.
+    # In the current implementation, only `START_SUBSCRIPTION` and
+    # `STOP_SUBSCRIPTION` (when the subscription was canceled) events are
+    # returned.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to retrieve the events for.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint. Provide this to retrieve the next set of
+    # results for the original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
+    # gination).
+    # @param [Integer] limit Optional parameter: The upper limit on the number
+    # of subscription events to return  in the response.   Default: `200`
+    # @return [ListSubscriptionEventsResponse Hash] response from the API call
+    def list_subscription_events(subscription_id:,
+                                 cursor: nil,
+                                 limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/subscriptions/{subscription_id}/events'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => subscription_id
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'limit' => limit
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(_response, data: decoded, errors: _errors)
+    end
+  end
+end

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.1.0.20200722'
+      '6.2.0.20200812'
     end
 
     def square_version
@@ -179,6 +179,12 @@ module Square
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to subscriptions controller.
+    # @return [SubscriptionsApi] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsApi.new config
+    end
+
     # Access to team controller.
     # @return [TeamApi] Returns the controller instance.
     def team
@@ -193,7 +199,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-07-22', access_token: 'TODO: Replace',
+                   square_version: '2020-08-12', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,

data/lib/square/configuration.rb

@@ -22,7 +22,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-07-22', access_token: 'TODO: Replace',
+                   square_version: '2020-08-12', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 6.1.0.20200722
+  version: 6.2.0.20200812
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -142,6 +142,7 @@ files:
 - lib/square/api/payments_api.rb
 - lib/square/api/refunds_api.rb
 - lib/square/api/reporting_api.rb
+- lib/square/api/subscriptions_api.rb
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb
 - lib/square/api/transactions_api.rb