supersaas-api-client 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a76aa1e660d7f1f2a1dc6e1dd18481c2e7c7e9379415bc0b51ca22b7dcb956b
-  data.tar.gz: f9a223e22689e31728453603e78f5b7dcfe5985f1e6008ffb6e30c7a93cef536
+  metadata.gz: 5c1167242f50872bf5bcce7d66d0e66af3f5ce2e6e90d9c14142c5c41536b83c
+  data.tar.gz: 3e93e114c2778055521baa9aa0828d3dd01ad9409af0796f60f22d0a55c20ff3
 SHA512:
-  metadata.gz: 849d3cf00e778f134a828bbeb12d446039471b50e858372c6838e99c8c5726f1f8d83700f43821e7249658608cc2159c979ec3a265f0846eff8bc3ff64f503ad
-  data.tar.gz: c7c203d37fc281821226b6d06da70abde33e3535a4111b2eb2149a8751f2b42abb9620777bc3f223f0a05c726d7f33b1c5ffc2299c01f785f3cfe8977c7abcad
+  metadata.gz: f530da06419d03c7eba52a8a8fe8971e70d6aad06ea71e99d612c6cf1954ff66e8737bf2c26e77c447fb28f19a032f98637d0ee5a0698d6649ee3581b15ef214
+  data.tar.gz: 159298164a8e0b4af53a7c424495d3a8752edac213068aaa30c87fb53546d9b93069fa924f98a35c00d34d73c4d125043aa78fef854271ad5fa9585332ee3186

data/.rubocop_todo.yml

@@ -62,9 +62,11 @@ Naming/VariableNumber:
     - 'lib/supersaas-api-client/api/appointments.rb'
     - 'lib/supersaas-api-client/api/users.rb'
     - 'lib/supersaas-api-client/models/appointment.rb'
+    - 'lib/supersaas-api-client/models/user.rb'
     - 'test/appointments_test.rb'
     - 'test/users_test.rb'
 
+
 # Offense count: 18
 # Configuration parameters: AllowedConstants.
 Style/Documentation:

data/Gemfile.lock

@@ -1,37 +1,37 @@
 PATH
   remote: .
   specs:
-    supersaas-api-client (2.0.4)
+    supersaas-api-client (2.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    minitest (5.20.0)
-    parallel (1.24.0)
-    parser (3.3.0.4)
+    minitest (5.24.1)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.60.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     unicode-display_width (2.5.0)
 
@@ -46,4 +46,4 @@ DEPENDENCIES
   supersaas-api-client!
 
 BUNDLED WITH
-   2.3.12
+   2.5.11

data/README.md

@@ -87,12 +87,13 @@ You only need to specify the attributes you wish to update:
 #### Delete User
 
 Delete a single user by `user_id`, and if the user does not exist 404 error will be raised.
+If webhook=true is present it will trigger any webhooks connected to the account.
 
     Supersaas::Client.instance.users.delete(12345) #=> nil
     
 #### Get User
 
-Get a single user by `user_id`, and if the user does not exist 404 error will be raised:
+Get a single user by `user_id`, and if the user does not exist 404 error will be raised, you may use optional `form`:
 
     Supersaas::Client.instance.users.get(12345) #=> <Supersaas::User>
 
@@ -125,7 +126,7 @@ Update an appointment by `schedule_id` and `appointment_id` with appointment att
 
 #### Delete Appointment/Booking
 
-Delete a single appointment by `schedule_id` and `appointment_id`:
+Delete a single appointment by `schedule_id` and `appointment_id` with optional `webhook`:
 
     Supersaas::Client.instance.appointments.delete(12345, 67890) #=> nil
 
@@ -151,6 +152,7 @@ Get agenda (upcoming) appointments by `schedule_id` and `user_id`, with `from_ti
 
 #### Get Agenda Slots
 
+This method is deprecated and will be removed in the future.
 Get agenda (upcoming) slots by `schedule_id` and `user_id`, with `from_time` view param,
 `agenda_slots(schedule_id, user_id, from_time = nil)`:
 
@@ -181,7 +183,7 @@ Get range of appointments by `schedule_id`, with `today`, `from` time, `to` time
 
 #### List Template Forms
 
-Get all forms by template `superform_id`, with `from_time`, and `user` params ([see](https://www.supersaas.com/info/dev/form_api)):
+Get all forms by template `superform_id`, with `from_time`, and `user` params ([see](https://www.supersaas.com/info/dev/form_api)) and `limit`/`offset` pagination params:
 
     Supersaas::Client.instance.forms.list(12345, '2018-01-31 00:00:00') #=> [<Supersaas::Form>, ...]
 
@@ -200,7 +202,7 @@ Get a list of Form templates (SuperForms):
 #### List Promotions
 
 Get a list of promotional coupon codes with pagination parameters `limit` and `offset` (see [docs](https://www.supersaas.com/info/dev/promotion_api)),
-`list(from_time = nil, user = nil)`:
+`list(limit = nil, offset = nil)`:
 
     Supersaas::Client.instance.promotions.list #=> [<Supersaas::Promotion>, ...]
 
@@ -213,8 +215,7 @@ Retrieve information about a single coupon code use with `promotion_code`:
 #### Duplicate promotion code
 
 Duplicate a template promotion by giving (new) `promotion_code` and `template_code` in that order,
-duplicate_promotion_code(promotion_code, template_code):
-
+`duplicate_promotion_code(promotion_code, template_code)`:
 
     Supersaas::Client.instance.promotions.duplicate_promotion_code(12345, 94832838) #=> nil
 

data/lib/supersaas-api-client/api/appointments.rb

@@ -3,10 +3,10 @@
 module Supersaas
   # REF: https://www.supersaas.com/info/dev/appointment_api
   class Appointments < BaseApi
-    def agenda(schedule_id, user_id, from_time = nil, slot = false)
+    def agenda(schedule_id, user, from_time = nil, slot = false)
       path = "/agenda/#{validate_id(schedule_id)}"
       params = {
-        user: validate_present(user_id),
+        user: validate_present(user),
         from: from_time && validate_datetime(from_time)
       }
       params.merge!(slot: true) if slot
@@ -14,6 +14,7 @@ module Supersaas
       map_slots_or_bookings(res)
     end
 
+    # LEGACY METHOD WILL BE REMOVED USE AGENDA
     def agenda_slots(schedule_id, user_id, from_time = nil)
       path = "/agenda/#{validate_id(schedule_id)}"
       params = {
@@ -38,14 +39,16 @@ module Supersaas
       map_slots_or_bookings(res)
     end
 
-    def list(schedule_id, form = nil, start_time = nil, limit = nil)
+    def list(schedule_id, form = nil, start_time = nil, limit = nil, finish = nil, offset = nil)
       path = '/bookings'
       params = {
         schedule_id: validate_id(schedule_id),
         form: form ? true : nil,
-        start: start_time ? validate_datetime(start_time) : nil
+        start: start_time ? validate_datetime(start_time) : nil,
+        finish: finish ? validate_datetime(finish) : nil
       }
       params.merge!(limit: validate_number(limit)) if limit
+      params.merge!(offset: validate_number(offset)) if offset
       res = client.get(path, params)
       map_slots_or_bookings(res)
     end
@@ -67,8 +70,8 @@ module Supersaas
         booking: {
           start: attributes[:start],
           finish: attributes[:finish],
-          name: attributes[:name],
           email: attributes[:email],
+          res_name: attributes[:name],
           full_name: attributes[:full_name],
           address: attributes[:address],
           mobile: attributes[:mobile],
@@ -94,8 +97,8 @@ module Supersaas
         booking: {
           start: attributes[:start],
           finish: attributes[:finish],
-          name: attributes[:name],
           email: attributes[:email],
+          res_name: attributes[:name],
           full_name: attributes[:full_name],
           address: attributes[:address],
           mobile: attributes[:mobile],
@@ -117,9 +120,10 @@ module Supersaas
       client.put(path, params)
     end
 
-    def delete(schedule_id, appointment_id)
+    def delete(schedule_id, appointment_id, webhook = nil)
       path = "/bookings/#{validate_id(appointment_id)}"
       params = { schedule_id: validate_id(schedule_id) }
+      params.merge!(webhook: webhook) if webhook
       client.delete(path, nil, params)
     end
 
@@ -130,8 +134,8 @@ module Supersaas
       map_slots_or_bookings(res)
     end
 
-    def range(schedule_id, today = false, from_time = nil, to = nil, slot = false, user = nil, resource_id = nil, service_id = nil,
-              limit = nil, offset = nil)
+    def range(schedule_id, today = false, from_time = nil, to = nil, slot = false, user = nil, resource_id = nil,
+              service_id = nil, limit = nil, offset = nil)
       path = "/range/#{validate_id(schedule_id)}"
       params = {}
       params = build_param(params, from_time, to, slot, user, limit, offset, resource_id, service_id)

data/lib/supersaas-api-client/api/forms.rb

@@ -3,11 +3,13 @@
 module Supersaas
   # REF: https://www.supersaas.com/info/dev/form_api
   class Forms < BaseApi
-    def list(template_form_id, from_time = nil, user = nil)
+    def list(template_form_id, from_time = nil, user = nil, limit = nil, offset = nil)
       path = '/forms'
       params = { form_id: validate_id(template_form_id) }
       params.merge!(from: validate_datetime(from_time)) if from_time
       params.merge!(user: validate_user(user)) if user
+      params.merge!(limit: limit) if limit
+      params.merge!(offset: offset) if offset
       res = client.get(path, params)
       res.map { |attributes| Supersaas::Form.new(attributes) }
     end

data/lib/supersaas-api-client/api/users.rb

@@ -10,13 +10,17 @@ module Supersaas
         limit: limit && validate_number(limit),
         offset: offset && validate_number(offset)
       }
+      params.compact!
       res = client.get(path, params)
       res.map { |attributes| Supersaas::User.new(attributes) }
     end
 
-    def get(user_id)
+    def get(user_id, form = nil)
       path = user_path(user_id)
-      res = client.get(path)
+      params = {
+        form: form ? true : nil
+      }
+      res = client.get(path, params)
       Supersaas::User.new(res)
     end
 
@@ -39,9 +43,11 @@ module Supersaas
           field_2: attributes[:field_2],
           super_field: attributes[:super_field],
           credit: attributes[:credit] && validate_number(attributes[:credit]),
-          role: attributes[:role] && validate_options(attributes[:role], User::ROLES)
+          role: attributes[:role] && validate_options(attributes[:role], User::ROLES),
+          group: attributes[:group] && validate_number(attributes[:group])
         }
       }
+      params[:user].compact!
       client.post(path, params, query)
     end
 
@@ -64,16 +70,18 @@ module Supersaas
           field_2: attributes[:field_2],
           super_field: attributes[:super_field],
           credit: attributes[:credit] && validate_number(attributes[:credit]),
-          role: attributes[:role] && validate_options(attributes[:role], User::ROLES)
+          role: attributes[:role] && validate_options(attributes[:role], User::ROLES),
+          group: attributes[:group] && validate_number(attributes[:group])
         }
       }
       params[:user].compact!
       client.put(path, params, query)
     end
 
-    def delete(user_id)
+    def delete(user_id, webhook = nil)
       path = user_path(user_id)
-      client.delete(path)
+      params = { webhook: webhook }
+      client.delete(path, nil, params)
     end
 
     def field_list

data/lib/supersaas-api-client/client.rb

@@ -77,12 +77,14 @@ module Supersaas
 
     private
 
-    # The rate limiter allows a maximum of 4 requests within the specified time window
+    # The rate limiter allows a maximum of 1 requests within the specified time window
     WINDOW_SIZE = 1 # seconds
-    MAX_PER_WINDOW = 4
+    MAX_REQUESTS = 4
+
     def throttle
       # A queue to store timestamps of requests made within the rate limiting window
-      @queue ||= Array.new(MAX_PER_WINDOW)
+      @queue ||= Array.new(MAX_REQUESTS)
+
       # Represents the timestamp of the oldest request within the time window
       oldest_request = @queue.push(Time.now).shift
       # This ensures that the client does not make requests faster than the defined rate limit

data/lib/supersaas-api-client/models/appointment.rb

@@ -2,10 +2,11 @@
 
 module Supersaas
   class Appointment < BaseModel
-    attr_accessor :address, :country, :created_by, :created_on, :deleted, :description, :email, :field_1, :field_2,
-                  :field_1_r, :field_2_r, :finish, :form_id, :full_name, :id, :mobile, :name, :phone, :price, :res_name,
-                  :resource_id, :schedule_id, :schedule_name, :service_id, :service_name, :slot_id, :start, :status,
-                  :super_field, :updated_by, :updated_on, :user_id, :waitlisted
+    attr_accessor :field_1, :field_2, :field_2_r, :field_1_r, :country, :address, :mobile, :phone, :email, :price_cents,
+                  :finish, :start, :service_name, :res_name, :id, :quantity, :status_message, :deleted,
+                  :created_on, :slot_id, :created_by, :price, :status, :full_name, :super_field, :updated_by, :form_id,
+                  :updated_on, :user_id, :waitlisted, :resource_id, :schedule_name, :schedule_id, :service_id
+
     attr_reader :form, :slot
 
     def form=(value)

data/lib/supersaas-api-client/models/form.rb

@@ -2,7 +2,6 @@
 
 module Supersaas
   class Form < BaseModel
-    attr_accessor :content, :created_on, :deleted, :id, :reservation_process_id, :super_form_id, :uniq, :updated_name,
-                  :updated_on, :user_id
+    attr_accessor :content, :created_on, :deleted, :id, :reservation_process_id, :super_form_id, :updated_on, :user_id
   end
 end

data/lib/supersaas-api-client/models/user.rb

@@ -5,6 +5,8 @@ module Supersaas
     ROLES = [3, 4, -1].freeze
 
     attr_reader :form
+    attr_accessor :name, :email, :password, :full_name, :address, :mobile, :phone, :country, :timezone, :field_1,
+                  :field_2, :super_field, :credit, :role, :group, :webhook, :id, :fk, :created_on, :updated_on
 
     def form=(value)
       @form = value.is_a?(Hash) ? Supersaas::Form.new(value) : value

data/lib/supersaas-api-client/version.rb

@@ -2,5 +2,5 @@
 
 module Supersaas
   API_VERSION = '3'
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supersaas-api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Kaarle Kulvik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Manage appointments and users on the SuperSaaS scheduling platform