supersaas-api-client 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f6ba86e7f24695dc5e409697c2e51e6eacbc8a4f092a4905d761c13349e397
-  data.tar.gz: 595c57b1f7bd7ffef07e69f20fdd094335822698600af75dcc68941b78c3cf84
+  metadata.gz: 2eb43732d50c7dcefda2438017a37bd2fc26c47ec74f4406a1ef18dca412ca9a
+  data.tar.gz: d82438701b3abcb5a79132685554278194bc0477861147779d40595b81374472
 SHA512:
-  metadata.gz: fc9a86a050f306cd6d8a845453d41ea124e4202531c5a2fe7483a8ea693fa522963e7bd0f15d36905b8689bd4e7338ed72ee72db4bbb31b872719ceb3da5155d
-  data.tar.gz: cd85cf6f149ed8c42026bd1c3f3397428d0de95c753553e93c3c4f2927abdec6d1e27702d568cf84d5b448d5d4be80d9a86d76ccd3a004f3825aee6b7768b85d
+  metadata.gz: 853d8c92cddfc0ee7f59b238f56d21ca9e706bcb2c4126fe5b3bdb0f03369d1fb1f05b42d1451aad84f7b2954a7e4330ffadbf467236746e1a7d43f1de04b571
+  data.tar.gz: 8000f1ba94f1f79c3d1cc8709ceaf220218d9aaca003a5c59ccd1adbbf512b3e8983dd5510da3a22c99740b069052b3de9addd63723174da362f5161a547775c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    supersaas-api-client (2.0.0)
+    supersaas-api-client (2.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -172,15 +172,14 @@ Get recently changed appointments by `schedule_id`, with `from` time, `to` time,
 
     Supersaas::Client.instance.appointments.changes(12345, '2018-01-31 00:00:00', '2019-01-31 00:00:00',  true) #=> [<Supersaas::Appointment>, ...]
 
+#### Get range of appointments
 
-#### Get list of appointments
-
-Get list of appointments by `schedule_id`, with `today`,`from` time, `to` time and `slot` view params (see [docs](https://www.supersaas.com/info/dev/appointment_api#range)),
+Get range of appointments by `schedule_id`, with `today`, `from` time, `to` time and `slot` view params (see [docs](https://www.supersaas.com/info/dev/appointment_api#range)),
 `range(schedule_id, today = false, from_time = nil, to = nil, slot = false, user = nil, resource_id = nil, service_id = nil, limit = nil, offset = nil)`:
 
     Supersaas::Client.instance.appointments.range(12345, false, '2018-01-31 00:00:00', '2019-01-31 00:00:00', true) #=> [<Supersaas::Appointment>, ...]/[<Supersaas::Slot>, ...]
 
-#### List Forms
+#### 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)):
 
@@ -200,8 +199,8 @@ Get a list of Form templates (SuperForms):
 
 #### List Promotions
 
-Get a list of promotional coupon codes with paging parameters `limit` and `offset` (see [docs](https://www.supersaas.com/info/dev/promotion_api)),
-`list(template_form_id, from_time = nil, user = nil)`:
+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)`:
 
     Supersaas::Client.instance.promotions.list #=> [<Supersaas::Promotion>, ...]
 
@@ -213,9 +212,11 @@ Retrieve information about a single coupon code use with `promotion_code`:
 
 #### Duplicate promotion code
 
-Duplicate a template promotion by giving (new) `id` and `template_code` in that order:
+Duplicate a template promotion by giving (new) `promotion_code` and `template_code` in that order,
+duplicate_promotion_code(promotion_code, template_code):
+
 
-    Supersaas::Client.instance.promotions.duplicate_promotion_code(12345) #=> nil
+    Supersaas::Client.instance.promotions.duplicate_promotion_code(12345, 94832838) #=> nil
 
 #### List Groups in an account
 

data/examples/appointments.rb

@@ -4,11 +4,11 @@
 require 'date'
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Appointments Example"
+puts '# SuperSaaS Appointments Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<api_key> ./examples/appointments.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts 'SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<api_key> ./examples/appointments.rb'
   return
 end
 
@@ -21,8 +21,8 @@ if ENV['SSS_API_SCHEDULE']
   schedule_id = ENV['SSS_API_SCHEDULE']
   show_slot = ENV['SSS_API_SLOT'] ? true : false
 else
-  puts "ERROR! Missing schedule id. Rerun the script with your schedule id, e.g."
-  puts "    SSS_API_SCHEDULE=<scheduleid> ./examples/appointments.rb"
+  puts 'ERROR! Missing schedule id. Rerun the script with your schedule id, e.g.'
+  puts '    SSS_API_SCHEDULE=<scheduleid> ./examples/appointments.rb'
   return
 end
 
@@ -30,14 +30,13 @@ end
 user_id = ENV.fetch('SSS_API_USER', nil)
 
 unless user_id
-  puts "User is created and then deleted at the end"
+  puts 'User is created and then deleted at the end'
   params = { full_name: 'Example', name: 'example@example.com', email: 'example@example.com', api_key: 'example' }
   user = Supersaas::Client.instance.users.create(params)
-  user_id = user.match(/users\/(\d+)\.json/)[1]
+  user_id = user.match(%r{users/(\d+)\.json})[1]
   puts "#New user created #{user_id}"
 end
 
-
 description = nil
 if user_id
   description = '1234567890.'
@@ -50,26 +49,26 @@ if user_id
     params[:start] = Time.now + (days * 24 * 60 * 60)
     params[:finish] = params[:start] + (60 * 60)
   end
-  puts "creating new appointment..."
+  puts 'creating new appointment...'
   puts "#### Supersaas::Client.instance.appointments.create(#{schedule_id}, #{user_id}, {...})"
   Supersaas::Client.instance.appointments.create(schedule_id, user_id, params)
 else
-  puts "skipping create/update/delete (NO DESTRUCTIVE ACTIONS FOR SCHEDULE DATA)..."
+  puts 'skipping create/update/delete (NO DESTRUCTIVE ACTIONS FOR SCHEDULE DATA)...'
 end
 
-puts "listing appointments..."
+puts 'listing appointments...'
 puts "#### Supersaas::Client.instance.appointments.list(#{schedule_id}, nil, nil, 25)"
 
 appointments = Supersaas::Client.instance.appointments.list(schedule_id, nil, nil, 25)
 
 if appointments.size.positive?
   appointment_id = appointments.sample.id
-  puts "getting appointment..."
+  puts 'getting appointment...'
   puts "#### Supersaas::Client.instance.appointments.get(#{appointment_id})"
   Supersaas::Client.instance.appointments.get(schedule_id, appointment_id)
 end
 
-puts "listing changes..."
+puts 'listing changes...'
 from = DateTime.now - 120
 to = DateTime.now + 360_000
 puts "#### Supersaas::Client.instance.appointments.changes(#{schedule_id},
@@ -77,14 +76,14 @@ puts "#### Supersaas::Client.instance.appointments.changes(#{schedule_id},
 
 Supersaas::Client.instance.appointments.changes(schedule_id, from, show_slot)
 
-puts "listing available..."
+puts 'listing available...'
 from = DateTime.now
 puts "#### Supersaas::Client.instance.appointments.available(#{schedule_id},
   '#{from.strftime('%Y-%m-%d %H:%M:%S')}')"
 
 Supersaas::Client.instance.appointments.available(schedule_id, from)
 
-puts "Appointments for a single user..."
+puts 'Appointments for a single user...'
 user = Supersaas::Client.instance.users.list(nil, 1).first
 from = DateTime.now
 puts "#### Supersaas::Client.instance.appointments.agenda(#{schedule_id}, user.id,
@@ -96,17 +95,15 @@ appointments.each do |appointment|
   puts "#{description} == #{appointment.description}"
   next unless description == appointment.description
 
-  puts "updating appointment..."
+  puts 'updating appointment...'
   puts "#### Supersaas::Client.instance.appointments.update(#{schedule_id}, #{appointment.id}, {...})"
   Supersaas::Client.instance.appointments.update(schedule_id, appointment.id, { country: 'FR', address: 'Rue 1' })
 
-  puts "deleting appointment..."
+  puts 'deleting appointment...'
   puts "#### Supersaas::Client.instance.appointments.delete(#{schedule_id}. #{appointment.id})"
   Supersaas::Client.instance.appointments.delete(schedule_id, appointment.id)
   break
 end
 
 # Puts delete user
-unless ENV.fetch('SSS_API_USER', nil)
-  Supersaas::Client.instance.users.delete(user_id)
-end
+Supersaas::Client.instance.users.delete(user_id) unless ENV.fetch('SSS_API_USER', nil)

data/examples/forms.rb

@@ -3,11 +3,11 @@
 
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Forms Example"
+puts '# SuperSaaS Forms Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/appointments.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts '    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/appointments.rb'
   return
 end
 
@@ -16,22 +16,22 @@ puts "## API Key: #{'*' * Supersaas::Client.instance.api_key.size}"
 
 Supersaas::Client.instance.verbose = true
 
-puts "You will need to create a form, and also attach the form to a booking, see documentation on how to do that"
-puts "The below example will take a form in random, and if it is not attached to something then 404 error will be raised"
+puts 'You will need to create a form, and also attach the form to a booking, see documentation on how to do that'
+puts 'The below example will take a form in random, and if it is not attached to something then 404 error will be raised'
 
-puts "listing forms..."
-puts "#### Supersaas::Client.instance.forms.forms"
+puts 'listing forms...'
+puts '#### Supersaas::Client.instance.forms.forms'
 
 template_forms = Supersaas::Client.instance.forms.forms
 
 if template_forms.size.positive?
   template_form_id = template_forms.sample.id
 
-  puts "listing forms from account"
-  puts "#### Supersaas::Client.instance.forms.list"
+  puts 'listing forms from account'
+  puts '#### Supersaas::Client.instance.forms.list'
   form_id = Supersaas::Client.instance.forms.list(template_form_id).sample.id
 end
 
-puts "getting form..."
+puts 'getting form...'
 puts "#### Supersaas::Client.instance.forms.get(#{form_id})"
 Supersaas::Client.instance.forms.get(form_id)

data/examples/groups.rb

@@ -2,11 +2,11 @@
 
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Groups Example"
+puts '# SuperSaaS Groups Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts 'SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb'
   return
 end
 
@@ -15,6 +15,6 @@ puts "## API KEY: #{'*' * Supersaas::Client.instance.api_key.size}"
 
 Supersaas::Client.instance.verbose = true
 
-puts "listing groups..."
-puts "#### Supersaas::Client.instance.groups.list"
+puts 'listing groups...'
+puts '#### Supersaas::Client.instance.groups.list'
 Supersaas::Client.instance.groups.list

data/examples/promotions.rb

@@ -2,11 +2,11 @@
 
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Promotions Example"
+puts '# SuperSaaS Promotions Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts 'SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb'
   return
 end
 
@@ -15,12 +15,12 @@ puts "## API KEY: #{'*' * Supersaas::Client.instance.api_key.size}"
 
 Supersaas::Client.instance.verbose = true
 
-puts "listing promotions..."
-puts "#### Supersaas::Client.instance.promotions.list"
+puts 'listing promotions...'
+puts '#### Supersaas::Client.instance.promotions.list'
 promotions = Supersaas::Client.instance.promotions.list
 
 [10, promotions.size].min&.times do |i|
-  puts "A promotion"
+  puts 'A promotion'
   puts "#### Supersaas::Client.instance.promotion(#{promotions[i].id})"
   Supersaas::Client.instance.promotions.promotion(promotions[i].code)
 end

data/examples/schedules.rb

@@ -3,11 +3,11 @@
 
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Schedules Example"
+puts '# SuperSaaS Schedules Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts 'SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb'
   return
 end
 
@@ -16,22 +16,22 @@ puts "## API KEY: #{'*' * Supersaas::Client.instance.api_key.size}"
 
 Supersaas::Client.instance.verbose = true
 
-puts "listing schedules..."
-puts "#### Supersaas::Client.instance.schedules.list"
+puts 'listing schedules...'
+puts '#### Supersaas::Client.instance.schedules.list'
 schedules = Supersaas::Client.instance.schedules.list
 
-puts "listing schedule resources..."
+puts 'listing schedule resources...'
 [10, schedules.size].min&.times do |i|
   puts "#### Supersaas::Client.instance.schedules.resources(#{schedules[i].id})"
   # Capacity schedules bomb
   begin
-  Supersaas::Client.instance.schedules.resources(schedules[i].id)
-  rescue
+    Supersaas::Client.instance.schedules.resources(schedules[i].id)
+  rescue StandardError
     next
   end
 end
 
-puts "puts listing fields..."
+puts 'puts listing fields...'
 [10, schedules.size].min&.times do |i|
   puts "#### Supersaas::Client.instance.schedules.field_list(#{schedules[i].id})"
   Supersaas::Client.instance.schedules.field_list(schedules[i].id)

data/examples/users.rb

@@ -3,11 +3,11 @@
 
 require 'supersaas-api-client'
 
-puts "# SuperSaaS Users Example"
+puts '# SuperSaaS Users Example'
 
 unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
-  puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g."
-  puts "SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb"
+  puts 'ERROR! Missing account credentials. Rerun the script with your credentials, e.g.'
+  puts 'SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb'
   return
 end
 
@@ -17,13 +17,13 @@ puts "## API Key: #{'*' * Supersaas::Client.instance.api_key.size}"
 Supersaas::Client.instance.verbose = true
 
 puts 'creating new user...'
-puts "#### Supersaas::Client.instance.users.create({...})"
+puts '#### Supersaas::Client.instance.users.create({...})'
 params = { full_name: 'Example', name: 'example@example.com', email: 'example@example.com', api_key: 'example' }
 Supersaas::Client.instance.users.create(params)
 new_user_id = nil
 
-puts "listing users..."
-puts "#### Supersaas::Client.instance.users.list(nil, 50)"
+puts 'listing users...'
+puts '#### Supersaas::Client.instance.users.list(nil, 50)'
 
 users = Supersaas::Client.instance.users.list(nil, 50)
 users.each do |user|
@@ -31,29 +31,29 @@ users.each do |user|
 end
 
 if new_user_id
-  puts "getting user..."
+  puts 'getting user...'
   puts "#### Supersaas::Client.instance.users.get(#{new_user_id})"
   user = Supersaas::Client.instance.users.get(new_user_id)
 
-  puts "updating user..."
+  puts 'updating user...'
   puts "#### Supersaas::Client.instance.users.update(#{new_user_id})"
   Supersaas::Client.instance.users.update(new_user_id, { country: 'FR', address: 'Rue 1' })
 
-  puts "deleting user..."
+  puts 'deleting user...'
   puts "#### Supersaas::Client.instance.users.delete(#{user.id})"
   Supersaas::Client.instance.users.delete(user.id)
 else
-  puts "... did not find user in list"
+  puts '... did not find user in list'
 end
 
-puts "creating user with errors..."
-puts "#### Supersaas::Client.instance.users.create"
+puts 'creating user with errors...'
+puts '#### Supersaas::Client.instance.users.create'
 begin
   Supersaas::Client.instance.users.create({ name: 'error' })
 rescue Supersaas::Exception => e
   puts "This raises an error #{e.message}"
 end
 
-puts "#### Supersaas::Client.instance.users.field_list"
+puts '#### Supersaas::Client.instance.users.field_list'
 Supersaas::Client.instance.users.field_list
 puts

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

@@ -31,9 +31,9 @@ module Supersaas
         length: length_minutes && validate_number(length_minutes),
         from: validate_datetime(from_time),
         resource: resource,
-        full: full ? true : nil,
-        maxresults: limit && validate_number(limit)
+        full: full ? true : nil
       }
+      params.merge!(maxresults: validate_number(limit)) if limit
       res = client.get(path, params)
       map_slots_or_bookings(res)
     end
@@ -43,9 +43,9 @@ module Supersaas
       params = {
         schedule_id: validate_id(schedule_id),
         form: form ? true : nil,
-        start: start_time ? validate_datetime(start_time) : nil,
-        limit: limit && validate_number(limit)
+        start: start_time ? validate_datetime(start_time) : nil
       }
+      params.merge!(maxresults: validate_number(limit)) if limit
       res = client.get(path, params)
       map_slots_or_bookings(res)
     end
@@ -134,8 +134,8 @@ module Supersaas
               limit = nil, offset = nil)
       path = "/range/#{validate_id(schedule_id)}"
       params = {}
-      params.merge!(today: true) if today
       params = build_param(params, from_time, to, slot, user, limit, offset, resource_id, service_id)
+      params.merge!(today: true) if today
       res = client.get(path, params)
       map_slots_or_bookings(res)
     end

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

@@ -5,10 +5,9 @@ module Supersaas
     # REF: https://www.supersaas.com/info/dev/promotion_api
     def list(limit = nil, offset = nil)
       path = '/promotions'
-      params = {
-        limit: limit && validate_number(limit),
-        offset: offset && validate_number(offset)
-      }
+      params = {}
+      params.merge!(limit: validate_number(limit)) if limit
+      params.merge!(offset: validate_number(offset)) if offset
       res = client.get(path, params)
       res.map { |attributes| Supersaas::Promotion.new(attributes) }
     end

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

@@ -86,9 +86,9 @@ module Supersaas
       # 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
-      if oldest_request && (d = Time.now - oldest_request) < WINDOW_SIZE
-        sleep WINDOW_SIZE - d
-      end
+      return unless oldest_request && (d = Time.now - oldest_request) < WINDOW_SIZE
+
+      sleep WINDOW_SIZE - d
     end
 
     def request(http_method, path, params = {}, query = {})
@@ -146,7 +146,7 @@ module Supersaas
       begin
         res = http.request(req)
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
-        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
         raise Supersaas::Exception, "HTTP Request Error (#{uri}#{path}): #{e.message}"
       end
 

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

@@ -2,5 +2,5 @@
 
 module Supersaas
   API_VERSION = '3'
-  VERSION = '2.0.1'
+  VERSION = '2.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supersaas-api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Kaarle Kulvik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler