square.rb 34.0.0.20231115 → 35.0.0.20240118

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 782b164931df9b858596a44072900426a8602cdf90bb151d91e456c3ce0bf000
-  data.tar.gz: 3f42b29aff8f32c74bb59d48d358a8ffab6fa668e1ce79d1e737850c3f9f1eb1
+  metadata.gz: 249614d84c1818c028f583951e3fa380f1533985909801204a1ee94eb0a91733
+  data.tar.gz: 4ae2b2cceb63628934b529fff05bd58f2cd27d8f22ae10a44ec26e0bc40f087d
 SHA512:
-  metadata.gz: 931a8f0def1a0eda533df2cbeca7407c76e9e4d16c8086e12fcde25b0ad3f4cc547dad95b14b4c243cbf9ccee7bd99e11f45733286a9856fe723a509b21dd2d8
-  data.tar.gz: 1a3e3acb369443df965fb5447d650368a93cba33a9a5439cfb48ae0ba425b86915366eb64027656fcb406081462e20b1e48b3d8b6428d7fb1c553eab04654cdd
+  metadata.gz: 7ebdb416a8041d2d70a9d8108ce432ec26f2558bc67589a5f5e5625625f4366f4998d20575e0a8ac9e872b11a37133180ee6b27d7fffc9147674ff89a638f05e
+  data.tar.gz: 8fe1a39713a031a36023433a9a84c7492654a28adbd1c02a5130513cfd936336ad2c9c7d53ec707623498f8fc4bc3972bd9a2c45756664d2b628350c45b0ee45

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 Square, Inc.
+Copyright 2024 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/lib/square/api/base_api.rb

@@ -4,7 +4,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/34.0.0.20231115 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/35.0.0.20240118 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/catalog_api.rb

@@ -328,10 +328,19 @@ module Square
     # of an object can be found in the version field of
     # [CatalogObject]($m/CatalogObject)s. If not included, results will be from
     # the current version of the catalog.
+    # @param [TrueClass | FalseClass] include_category_path_to_root Optional
+    # parameter: Specifies whether or not to include the `path_to_root` list for
+    # each returned category instance. The `path_to_root` list consists of
+    # `CategoryPathToRootNode` objects and specifies the path that starts with
+    # the immediate parent category of the returned category and ends with its
+    # root category. If the returned category is a top-level category, the
+    # `path_to_root` list is empty and is not returned in the response
+    # payload.
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,
-                                catalog_version: nil)
+                                catalog_version: nil,
+                                include_category_path_to_root: false)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/catalog/object/{object_id}',
@@ -340,6 +349,7 @@ module Square
                                     .should_encode(true))
                    .query_param(new_parameter(include_related_objects, key: 'include_related_objects'))
                    .query_param(new_parameter(catalog_version, key: 'catalog_version'))
+                   .query_param(new_parameter(include_category_path_to_root, key: 'include_category_path_to_root'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler

data/lib/square/api/checkout_api.rb

@@ -35,6 +35,91 @@ module Square
         .execute
     end
 
+    # Retrieves the location-level settings for a Square-hosted checkout page.
+    # @param [String] location_id Required parameter: The ID of the location for
+    # which to retrieve settings.
+    # @return [RetrieveLocationSettingsResponse Hash] response from the API call
+    def retrieve_location_settings(location_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/online-checkout/location-settings/{location_id}',
+                                     'default')
+                   .template_param(new_parameter(location_id, key: 'location_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Updates the location-level settings for a Square-hosted checkout page.
+    # @param [String] location_id Required parameter: The ID of the location for
+    # which to retrieve settings.
+    # @param [UpdateLocationSettingsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateLocationSettingsResponse Hash] response from the API call
+    def update_location_settings(location_id:,
+                                 body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/online-checkout/location-settings/{location_id}',
+                                     'default')
+                   .template_param(new_parameter(location_id, key: 'location_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves the merchant-level settings for a Square-hosted checkout page.
+    # @return [RetrieveMerchantSettingsResponse Hash] response from the API call
+    def retrieve_merchant_settings
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/online-checkout/merchant-settings',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Updates the merchant-level settings for a Square-hosted checkout page.
+    # @param [UpdateMerchantSettingsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateMerchantSettingsResponse Hash] response from the API call
+    def update_merchant_settings(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/online-checkout/merchant-settings',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Lists all payment links.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next

data/lib/square/api/customers_api.rb

@@ -177,7 +177,7 @@ module Square
     # Updates a customer profile. This endpoint supports sparse updates, so only
     # new or changed fields are required in the request.
     # To add or update a field, specify the new value. To remove a field,
-    # specify `null` and include the `X-Clear-Null` header set to `true`
+    # specify `null`
     # (recommended) or specify an empty string (string fields only).
     # As a best practice, include the `version` field in the request to enable
     # [optimistic

data/lib/square/api/invoices_api.rb

@@ -171,6 +171,71 @@ module Square
         .execute
     end
 
+    # Uploads a file and attaches it to an invoice. This endpoint accepts HTTP
+    # multipart/form-data file uploads
+    # with a JSON `request` part and a `file` part. The `file` part must be a
+    # `readable stream` that contains a file
+    # in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.
+    # Invoices can have up to 10 attachments with a total file size of 25 MB.
+    # Attachments can be added only to invoices
+    # in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.
+    # @param [String] invoice_id Required parameter: The ID of the
+    # [invoice](entity:Invoice) to attach the file to.
+    # @param [CreateInvoiceAttachmentRequest] request Optional parameter:
+    # Represents a
+    # [CreateInvoiceAttachment]($e/Invoices/CreateInvoiceAttachment) request.
+    # @param [File | UploadIO] image_file Optional parameter: Example:
+    # @return [CreateInvoiceAttachmentResponse Hash] response from the API call
+    def create_invoice_attachment(invoice_id:,
+                                  request: nil,
+                                  image_file: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/invoices/{invoice_id}/attachments',
+                                     'default')
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .should_encode(true))
+                   .multipart_param(new_parameter(StringIO.new(request.to_json), key: 'request')
+                                     .default_content_type('application/json; charset=utf-8'))
+                   .multipart_param(new_parameter(image_file, key: 'image_file')
+                                     .default_content_type('image/jpeg'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Removes an attachment from an invoice and permanently deletes the file.
+    # Attachments can be removed only
+    # from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID`
+    # state.
+    # @param [String] invoice_id Required parameter: The ID of the
+    # [invoice](entity:Invoice) to delete the attachment from.
+    # @param [String] attachment_id Required parameter: The ID of the
+    # [attachment](entity:InvoiceAttachment) to delete.
+    # @return [DeleteInvoiceAttachmentResponse Hash] response from the API call
+    def delete_invoice_attachment(invoice_id:,
+                                  attachment_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/invoices/{invoice_id}/attachments/{attachment_id}',
+                                     'default')
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(attachment_id, key: 'attachment_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Cancels an invoice. The seller cannot collect payments for
     # the canceled invoice.
     # You cannot cancel an invoice in the `DRAFT` state or in a terminal state:

data/lib/square/api/terminal_api.rb

@@ -94,7 +94,7 @@ module Square
     # Actions](https://developer.squareup.com/docs/terminal-api/advanced-feature
     # s/custom-workflows/link-and-dismiss-actions) for more details.
     # @param [String] action_id Required parameter: Unique ID for the
-    # `TerminalAction` associated with the waiting dialog to be dismissed.
+    # `TerminalAction` associated with the action to be dismissed.
     # @return [DismissTerminalActionResponse Hash] response from the API call
     def dismiss_terminal_action(action_id:)
       new_api_call_builder
@@ -203,6 +203,27 @@ module Square
         .execute
     end
 
+    # Dismisses a Terminal checkout request if the status and type of the
+    # request permits it.
+    # @param [String] checkout_id Required parameter: Unique ID for the
+    # `TerminalCheckout` associated with the checkout to be dismissed.
+    # @return [DismissTerminalCheckoutResponse Hash] response from the API call
+    def dismiss_terminal_checkout(checkout_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/terminals/checkouts/{checkout_id}/dismiss',
+                                     'default')
+                   .template_param(new_parameter(checkout_id, key: 'checkout_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Creates a request to refund an Interac payment completed on a Square
     # Terminal. Refunds for Interac payments on a Square Terminal are supported
     # only for Interac debit cards in Canada. Other refunds for Terminal
@@ -294,5 +315,26 @@ module Square
                    .convertor(ApiResponse.method(:create)))
         .execute
     end
+
+    # Dismisses a Terminal refund request if the status and type of the request
+    # permits it.
+    # @param [String] terminal_refund_id Required parameter: Unique ID for the
+    # `TerminalRefund` associated with the refund to be dismissed.
+    # @return [DismissTerminalRefundResponse Hash] response from the API call
+    def dismiss_terminal_refund(terminal_refund_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/terminals/refunds/{terminal_refund_id}/dismiss',
+                                     'default')
+                   .template_param(new_parameter(terminal_refund_id, key: 'terminal_refund_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
   end
 end

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '34.0.0.20231115'
+      '35.0.0.20240118'
     end
 
     def square_version
@@ -267,7 +267,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-11-15', user_agent_detail: '',
+                   square_version: '2024-01-18', user_agent_detail: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -19,7 +19,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-11-15', user_agent_detail: '',
+                   square_version: '2024-01-18', user_agent_detail: '',
                    additional_headers: {})
 
       super connection: connection, adapter: adapter, timeout: timeout,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 34.0.0.20231115
+  version: 35.0.0.20240118
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces