square.rb 33.0.0.20231018 → 42.1.0.20250416

data/lib/square/api/subscriptions_api.rb

@@ -14,7 +14,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_subscription(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -26,9 +26,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -40,7 +40,7 @@ module Square
     # @param [BulkSwapPlanRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
-    # @return [BulkSwapPlanResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_swap_plan(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -52,9 +52,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -74,7 +74,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_subscriptions(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -86,9 +86,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -99,7 +99,7 @@ module Square
     # related information to be included in the response.   The supported query
     # parameter values are:   - `actions`: to include scheduled actions on the
     # targeted subscription.
-    # @return [RetrieveSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_subscription(subscription_id:,
                               include: nil)
       new_api_call_builder
@@ -112,9 +112,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -126,7 +126,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_subscription(subscription_id:,
                             body:)
       new_api_call_builder
@@ -141,9 +141,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -152,7 +152,7 @@ module Square
     # subscription the targeted action is to act upon.
     # @param [String] action_id Required parameter: The ID of the targeted
     # action to be deleted.
-    # @return [DeleteSubscriptionActionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_subscription_action(subscription_id:,
                                    action_id:)
       new_api_call_builder
@@ -166,9 +166,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -181,7 +181,7 @@ module Square
     # @param [ChangeBillingAnchorDateRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [ChangeBillingAnchorDateResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def change_billing_anchor_date(subscription_id:,
                                    body:)
       new_api_call_builder
@@ -196,9 +196,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -208,7 +208,7 @@ module Square
     # the subscription status changes from ACTIVE to CANCELED.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to cancel.
-    # @return [CancelSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_subscription(subscription_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -219,9 +219,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -239,7 +239,7 @@ module Square
     # atterns/pagination).
     # @param [Integer] limit Optional parameter: The upper limit on the number
     # of subscription events to return in a paged response.
-    # @return [ListSubscriptionEventsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_subscription_events(subscription_id:,
                                  cursor: nil,
                                  limit: nil)
@@ -254,9 +254,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -266,7 +266,7 @@ module Square
     # @param [PauseSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [PauseSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def pause_subscription(subscription_id:,
                            body:)
       new_api_call_builder
@@ -281,9 +281,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -294,7 +294,7 @@ module Square
     # @param [ResumeSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [ResumeSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def resume_subscription(subscription_id:,
                             body:)
       new_api_call_builder
@@ -309,9 +309,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -325,7 +325,7 @@ module Square
     # @param [SwapPlanRequest] body Required parameter: An object containing the
     # fields to POST for the request.  See the corresponding object definition
     # for field details.
-    # @return [SwapPlanResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def swap_plan(subscription_id:,
                   body:)
       new_api_call_builder
@@ -340,9 +340,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
   end

data/lib/square/api/team_api.rb

@@ -12,7 +12,7 @@ module Square
     # @param [CreateTeamMemberRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateTeamMemberResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_team_member(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -24,9 +24,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -43,7 +43,7 @@ module Square
     # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [BulkCreateTeamMembersResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_create_team_members(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -55,9 +55,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -74,7 +74,7 @@ module Square
     # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [BulkUpdateTeamMembersResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_update_team_members(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -86,20 +86,119 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
+        .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.
-    # @return [SearchTeamMembersResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_team_members(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -111,9 +210,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -123,7 +222,7 @@ module Square
     # eam-member).
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to retrieve.
-    # @return [RetrieveTeamMemberResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_team_member(team_member_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -134,9 +233,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -150,7 +249,7 @@ module Square
     # @param [UpdateTeamMemberRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateTeamMemberResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_team_member(team_member_id:,
                            body:)
       new_api_call_builder
@@ -165,20 +264,23 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     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 [RetrieveWageSettingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_wage_setting(team_member_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -189,26 +291,30 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     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
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateWageSettingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_wage_setting(team_member_id:,
                             body:)
       new_api_call_builder
@@ -223,9 +329,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
   end