square.rb 40.0.0.20241120 → 40.1.0.20241218

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8393ed6eca406991807e1330dd142d2b5a346e856bc96832e908144efbf44b99
-  data.tar.gz: fdb42c86b5f181cff6998d4c49ddfb54c6c4c236729f2568d08b5b08a25b8cc4
+  metadata.gz: 4e7b1bb2c87e0ece74eca3aea1dce625d64ca37ca825a1d74a0b9dce2110b51b
+  data.tar.gz: 958e0831f484baa6a6ff74fe15a070404ac795d1385213e47073b10027a4c4ac
 SHA512:
-  metadata.gz: bff2ca7d43642adda84ee7d29dd4df592609c00648b9711c2f3febeb1f0c465f3d12af083b8ae238416ff7d79952aeac7dd91765ef80cb5fd911838390378c24
-  data.tar.gz: 1982eef48842069fd398d87617a9348ce703cbb9d439a78d2be51c75f3a6fa20dac9e613d1a5ca0744a2ee0861d83a24fac2dc1796de1229681209c79ef5a2a8
+  metadata.gz: c7b26e69c0f772ab764bbe875930cf275b0b03a32bb13aa7c4f7adc7e54d9805b1944b593ac8b0f244b2ae72ab357804d371c13198a23b4992e9edefb4491bc1
+  data.tar.gz: '00970c4e9fbad01d013a7dda89f69835a35e2fe6a8f8ad6784083df83672098c58fcc3cbc5f053af2c464314e8fe95306579d55be4c271cadf633c38c1a369f3'

data/lib/square/api/base_api.rb

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

data/lib/square/api/payments_api.rb

@@ -15,8 +15,8 @@ module Square
     # determined using the `created_at` field for each Payment.  Default: The
     # current time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` -
-    # Newest to oldest (default).
+    # are listed by `ListPaymentsRequest.sort_field`: - `ASC` - Oldest to
+    # newest. - `DESC` - Newest to oldest (default).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next
     # set of results for the original query.  For more information, see
@@ -53,6 +53,14 @@ module Square
     # set, payments without a value set in
     # `offline_payment_details.client_created_at` will not be returned.
     # Default: The current time.
+    # @param [String] updated_at_begin_time Optional parameter: Indicates the
+    # start of the time range to retrieve payments for, in RFC 3339 format.  The
+    # range is determined using the `updated_at` field for each Payment.
+    # @param [String] updated_at_end_time Optional parameter: Indicates the end
+    # of the time range to retrieve payments for, in RFC 3339 format.  The range
+    # is determined using the `updated_at` field for each Payment.
+    # @param [PaymentSortField] sort_field Optional parameter: The field used to
+    # sort results by. The default is `CREATED_AT`.
     # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_payments(begin_time: nil,
                       end_time: nil,
@@ -65,7 +73,10 @@ module Square
                       limit: nil,
                       is_offline_payment: false,
                       offline_begin_time: nil,
-                      offline_end_time: nil)
+                      offline_end_time: nil,
+                      updated_at_begin_time: nil,
+                      updated_at_end_time: nil,
+                      sort_field: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/payments',
@@ -82,6 +93,9 @@ module Square
                    .query_param(new_parameter(is_offline_payment, key: 'is_offline_payment'))
                    .query_param(new_parameter(offline_begin_time, key: 'offline_begin_time'))
                    .query_param(new_parameter(offline_end_time, key: 'offline_end_time'))
+                   .query_param(new_parameter(updated_at_begin_time, key: 'updated_at_begin_time'))
+                   .query_param(new_parameter(updated_at_end_time, key: 'updated_at_end_time'))
+                   .query_param(new_parameter(sort_field, key: 'sort_field'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler

data/lib/square/api/team_api.rb

@@ -92,10 +92,109 @@ module Square
         .execute
     end
 
+    # Lists jobs in a seller account. Results are sorted by title in ascending
+    # order.
+    # @param [String] cursor Optional parameter: The pagination cursor returned
+    # by the previous call to this endpoint. Provide this cursor to retrieve the
+    # next page of results for your original request. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def list_jobs(cursor: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/team-members/jobs',
+                                     'default')
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .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 job in a seller account. A job defines a title and tip
+    # eligibility. Note that
+    # compensation is defined in a [job assignment]($m/JobAssignment) in a team
+    # member's wage setting.
+    # @param [CreateJobRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def create_job(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/team-members/jobs',
+                                     '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
+
+    # Retrieves a specified job.
+    # @param [String] job_id Required parameter: The ID of the job to
+    # retrieve.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def retrieve_job(job_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/team-members/jobs/{job_id}',
+                                     'default')
+                   .template_param(new_parameter(job_id, key: 'job_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 title or tip eligibility of a job. Changes to the title
+    # propagate to all
+    # `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the
+    # job ID. Changes to
+    # tip eligibility propagate to all `TeamMemberWage` objects that reference
+    # the job ID.
+    # @param [String] job_id Required parameter: The ID of the job to update.
+    # @param [UpdateJobRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def update_job(job_id:,
+                   body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/team-members/jobs/{job_id}',
+                                     'default')
+                   .template_param(new_parameter(job_id, key: 'job_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
+
     # Returns a paginated list of `TeamMember` objects for a business.
-    # The list can be filtered by the following:
-    # - location IDs
-    # - `status`
+    # The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status,
+    # or whether
+    # the team member is the Square account owner.
     # @param [SearchTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -172,10 +271,13 @@ module Square
     end
 
     # Retrieves a `WageSetting` object for a team member specified
-    # by `TeamMember.id`.
-    # Learn about [Troubleshooting the Team
+    # by `TeamMember.id`. For more information, see
+    # [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#retrievewage
     # setting).
+    # Square recommends using [RetrieveTeamMember]($e/Team/RetrieveTeamMember)
+    # or [SearchTeamMembers]($e/Team/SearchTeamMembers)
+    # to get this information directly from the `TeamMember.wage_setting` field.
     # @param [String] team_member_id Required parameter: The ID of the team
     # member for which to retrieve the wage setting.
     # @return [ApiResponse]  the complete http response with raw body and status code.
@@ -196,13 +298,17 @@ module Square
     end
 
     # Creates or updates a `WageSetting` object. The object is created if a
-    # `WageSetting` with the specified `team_member_id` does not exist.
+    # `WageSetting` with the specified `team_member_id` doesn't exist.
     # Otherwise,
     # it fully replaces the `WageSetting` object for the team member.
-    # The `WageSetting` is returned on a successful update.
-    # Learn about [Troubleshooting the Team
+    # The `WageSetting` is returned on a successful update. For more
+    # information, see
+    # [Troubleshooting the Team
     # API](https://developer.squareup.com/docs/team/troubleshooting#create-or-up
     # date-a-wage-setting).
+    # Square recommends using [CreateTeamMember]($e/Team/CreateTeamMember) or
+    # [UpdateTeamMember]($e/Team/UpdateTeamMember)
+    # to manage the `TeamMember.wage_setting` field directly.
     # @param [String] team_member_id Required parameter: The ID of the team
     # member for which to update the `WageSetting` object.
     # @param [UpdateWageSettingRequest] body Required parameter: An object

data/lib/square/client.rb

@@ -5,7 +5,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '40.0.0.20241120'
+      '40.1.0.20241218'
     end
 
     def square_version
@@ -274,7 +274,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-11-20',
+      bearer_auth_credentials: nil, square_version: '2024-12-18',
       user_agent_detail: '', additional_headers: {}, config: nil
     )
       @config = if config.nil?

data/lib/square/configuration.rb

@@ -24,7 +24,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-11-20',
+      bearer_auth_credentials: nil, square_version: '2024-12-18',
       user_agent_detail: '', additional_headers: {}
     )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 40.0.0.20241120
+  version: 40.1.0.20241218
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.3.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.3.11
 - !ruby/object:Gem::Dependency
   name: apimatic_faraday_client_adapter
   requirement: !ruby/object:Gem::Requirement