youcanbookme 0.0.1.alpha → 0.0.6.alpha

data/lib/youcanbookme/error.rb

@@ -3,7 +3,7 @@
 module YouCanBookMe
   # YouCanBookMe module's base error object
   class Error < StandardError
-    include CommonModule
+    include Loggable
 
     def initialize(message = nil)
       msg = "#{self.class} occured."

data/lib/youcanbookme/http_command.rb

@@ -6,7 +6,7 @@ require 'faraday_middleware'
 module YouCanBookMe
   # Command for HTTP request.
   class HttpCommand
-    include CommonModule
+    include Loggable
 
     def initialize(account_id, password_or_token, host = nil)
       @account_id = account_id
@@ -19,6 +19,7 @@ module YouCanBookMe
     #
     # @param [String] path String or URI to access.
     # @param [Hash] params Hash of URI query unencoded key/value pairs.
+    # @since 0.0.1
     def get(path, params = {})
       debug_log "GET #{connection.build_url("#{@host}#{path}", params)}"
       res = connection.get path, params
@@ -32,6 +33,7 @@ module YouCanBookMe
     # @param [String] path String or URI to access.
     # @param [Hash] body_params
     # The request body that will eventually be converted to JSON.
+    # @since 0.0.1
     def post(path, body_params = {})
       debug_log "POST #{@host}#{path} body:#{body_params}"
       headers = { 'Content-Type' => 'application/json' }
@@ -46,6 +48,7 @@ module YouCanBookMe
     # @param [String] path String or URI to access.
     # @param [Hash] body_params
     # The request body that will eventually be converted to JSON.
+    # @since 0.0.1
     def put(path, body_params = {})
       debug_log "PUT #{@host}#{path} body:#{body_params}"
       headers = { 'Content-Type' => 'application/json' }
@@ -60,6 +63,7 @@ module YouCanBookMe
     # @param [String] path String or URI to access.
     # @param [Hash] body_params
     # The request body that will eventually be converted to JSON.
+    # @since 0.0.1
     def patch(path, body_params = {})
       debug_log "PATCH #{@host}#{path} body:#{body_params}"
       headers = { 'Content-Type' => 'application/json' }
@@ -73,6 +77,7 @@ module YouCanBookMe
     #
     # @param [String] path String or URI to access.
     # @param [Hash] params Hash of URI query unencoded key/value pairs.
+    # @since 0.0.1
     def delete(path, params = {})
       debug_log "DELETE #{@host}#{path} params:#{params}"
       res = connection.delete path, params

data/lib/youcanbookme/{common_module.rb → loggable.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBook.me utility module.
-  module CommonModule
+  # YouCanBook.me logger utility module.
+  module Loggable
     def error_log(msg)
       log msg, :error
     end

data/lib/youcanbookme/models/account.rb

@@ -1,23 +1,49 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBookMe's Account model.
-  class Account
+  class Account # rubocop:disable Metrics/ClassLength
     include ModelUtils
 
     ASSOCIATION = {
-      children: Account,
-      localAccount: CaligraphLocalAccount,
-      parent: Account,
+      allocations: AccountAllocation,
+      billingNameAndAddress: NameAndAddress,
+      cards: Card,
+      children: AccountChild,
+      loggedIn: Account,
+      nextPurchase: Purchase,
+      parent: AccountParent,
+      parentForBilling: AccountParent,
+      permissionsIn: Permission,
+      permissionsOut: Permission,
       profiles: Profile,
+      purchases: Purchase,
+      remoteAccounts: RemoteAccount,
+      syncToPurchasesChanges: PurchasesSyncChanges,
       warnings: Warning
     }.freeze
 
     # @return [String]
-    attr_accessor :caligraphKey
-    # @return [Array<YouCanBookMe::Account>]
+    # ['standard', 'master', 'administrator', 'editor', 'contributor', 'child', 'booker']
+    attr_accessor :accountType
+    # @return [String]
+    attr_accessor :addressHibernate
+    # @return [Array<YouCanBookMe::AccountAllocation>]
+    attr_accessor :allocations
+    # @return [String]
+    attr_accessor :apiKey
+    # @return [YouCanBookMe::NameAndAddress]
+    attr_accessor :billingNameAndAddress
+    # @return [boolean]
+    attr_accessor :blocked
+    # @return [String]
+    attr_accessor :caligraphId
+    # @return [Array<YouCanBookMe::Card>]
+    attr_accessor :cards
+    # @return [Array<YouCanBookMe::AccountChild>]
     attr_accessor :children
     # @return [String]
+    attr_accessor :cityHibernate
+    # @return [String]
     attr_accessor :clientState
     # @return [Boolean]
     attr_accessor :contactHigh
@@ -28,8 +54,24 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :contactMobile
     # @return [String]
+    attr_accessor :countryHibernate
+    # @return [String]
+    attr_accessor :covidStatus
+    # @return [String]
     attr_accessor :createdAt
     # @return [Integer]
+    attr_accessor :credit
+    # @return [Integer]
+    attr_accessor :creditEUR
+    # @return [Integer]
+    attr_accessor :creditGBP
+    # @return [Integer]
+    attr_accessor :creditUSD
+    # @return [String]
+    attr_accessor :currency
+    # @return [String]
+    attr_accessor :debugModeUntil
+    # @return [Integer]
     attr_accessor :deleteBookingsAfterDays
     # @return [Integer]
     attr_accessor :deletedBookingsCount
@@ -37,11 +79,17 @@ module YouCanBookMe
     attr_accessor :email
     # @return [String]
     attr_accessor :familyName
+    # @return [String]
+    attr_accessor :familyNameHibernate
     # @return [Integer]
     attr_accessor :feeCredit
+    # @return [Boolean]
+    attr_accessor :ghost
     # @return [String]
     attr_accessor :givenName
     # @return [String]
+    attr_accessor :givenNameHibernate
+    # @return [String]
     attr_accessor :gmailAccessToken
     # @return [String]
     attr_accessor :gmailAccessTokenExpires
@@ -57,27 +105,99 @@ module YouCanBookMe
     attr_accessor :hasBookings
     # @return [String]
     attr_accessor :id
-    # @return [YouCanBookMe::CaligraphLocalAccount]
-    attr_accessor :localAccount
+    # @return [Boolean]
+    attr_accessor :inDebugMode
+    # @return [String]
+    attr_accessor :killBillId
+    # @return [String]
+    attr_accessor :lastWarningPushAt
+    # @return [Integer]
+    attr_accessor :lastWarningPushLevel
+    # @return [String]
+    # ['free', 'trial', 'subscriber', 'churning', 'paused', 'churned', 'deleted']
+    attr_accessor :lifecycle
     # @return [String]
     attr_accessor :locale
-    # @return [Account]
+    # @return [YouCanBookMe::Account]
     attr_accessor :loggedIn
+    # @return [Boolean]
+    attr_accessor :needsSyncToPurchases
+    # @return [Integer]
+    attr_accessor :negotiatedDiscountPermyriad
+    # @return [YouCanBookMe::Purchase]
+    attr_accessor :nextPurchase
+    # @return [String]
+    attr_accessor :oneTimeToken
+    # @return [String]
+    attr_accessor :oneTimeTokenExpiresAt
     # @return [String]
     attr_accessor :organisation
-    # @return [YouCanBookMe::Account]
+    # @return [String]
+    attr_accessor :organizationNameHibernate
+    # @return [YouCanBookMe::AccountParent]
     attr_accessor :parent
     # @return [String]
-    attr_accessor :parentId
+    attr_accessor :parentEmail
+    # @return [YouCanBookMe::AccountParent]
+    attr_accessor :parentForBilling
+    # @return [Integer]
+    attr_accessor :parentQuantityPaidFor
+    # @return [String]
+    attr_accessor :password
+    # @return [String]
+    attr_accessor :passwordHash
+    # @return [Boolean]
+    attr_accessor :pastDue
+    # @return [Integer]
+    attr_accessor :pausePlanMonths
+    # @return [Integer]
+    attr_accessor :pauseQuantity
+    # @return [Integer]
+    attr_accessor :pauseRemainingSeconds
     # @return [Boolean]
-    attr_accessor :privilegedLogin
+    attr_accessor :paused
+    # @return [Array<YouCanBookMe::Permission>]
+    attr_accessor :permissionsIn
+    # @return [Array<YouCanBookMe::Permission>]
+    attr_accessor :permissionsOut
+    # @return [String]
+    attr_accessor :plan
+    # @return [String]
+    attr_accessor :planExpiresAt
+    # @return [Integer]
+    attr_accessor :planMonths
+    # @return [Integer]
+    attr_accessor :planMonthsWas
+    # @return [String]
+    attr_accessor :postalCodeHibernate
     # @return [Array<YouCanBookMe::Profile>]
     attr_accessor :profiles
+    # @return [Array<YouCanBookMe::Purchase>]
+    attr_accessor :purchases
+    # @return [Integer]
+    attr_accessor :quantityAllocated
+    # @return [Integer]
+    attr_accessor :quantityForFree
+    # @return [Integer]
+    attr_accessor :quantityFreeTrial
+    # @return [Integer]
+    attr_accessor :quantityPaidFor
     # @return [String]
     attr_accessor :realtimeTopic
     # @return [String]
+    attr_accessor :regionHibernate
+    # @return [Array<YouCanBookMe::RemoteAccount>]
+    attr_accessor :remoteAccounts
+    # @return [String]
+    # ['churn', 'pause', 'resetApiKey', 'resetOneTimeToken', 'resetQuota', 'resetSessionToken',
+    #  'resetZapierIntegration', review', 'revokeGmailAddon', 'revokeOneTimeToken',
+    #  'revokeSalesforceIntegration', 'revokeSessionToken', 'revokeStripeIntegration',
+    #  'revokeParentPermissions', 'revokeTermsDate', 'revokeZapierIntegration', 'revokeZoomIntegration',
+    #  'startTrial', 'syncToPurchases']
     attr_accessor :requestedAction
     # @return [String]
+    attr_accessor :reviewAt
+    # @return [String]
     attr_accessor :salesforceAccessToken
     # @return [String]
     attr_accessor :salesforceEmailAddress
@@ -87,18 +207,30 @@ module YouCanBookMe
     attr_accessor :salesforceRefreshToken
     # @return [String]
     attr_accessor :sector
+    # @return [String]
+    attr_accessor :sessionToken
+    # @return [String]
+    attr_accessor :sessionTokenExpiresAt
     # @return [Integer]
     attr_accessor :smsCredits
     # @return [String]
+    attr_accessor :source
+    # @return [String]
     attr_accessor :stripeAccessToken
     # @return [String]
+    attr_accessor :stripeId
+    # @return [String]
     attr_accessor :stripePublishableKey
     # @return [String]
     attr_accessor :stripeRefreshToken
     # @return [String]
     attr_accessor :stripeUserId
+    # @return [YouCanBookMe::PurchasesSyncChanges]
+    attr_accessor :syncToPurchasesChanges
     # @return [String]
     attr_accessor :tags
+    # @return [String]
+    attr_accessor :taxNumber
     # @return [Boolean]
     attr_accessor :terms
     # @return [String]
@@ -106,12 +238,20 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :timeZone
     # @return [String]
+    attr_accessor :trialEndsAt
+    # @return [String]
+    attr_accessor :type
+    # @return [String]
+    attr_accessor :updatedAt
+    # @return [String]
     attr_accessor :uploadCode
     # @return [Array<YouCanBookMe::Warning>]
     attr_accessor :warnings
     # @return [Boolean]
     attr_accessor :welcomed
     # @return [String]
+    attr_accessor :xeroId
+    # @return [String]
     attr_accessor :zapierKey
     # @return [String]
     attr_accessor :zoomAccessToken

data/lib/youcanbookme/models/account_allocation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  class AccountAllocation
+    include ModelUtils
+
+    # @return [String]
+    attr_accessor :caligraphId
+    # @return [String]
+    attr_accessor :email
+    # @return [Boolean]
+    attr_accessor :ghost
+    # @return [String]
+    attr_accessor :id
+    # @return [String]
+    attr_accessor :parentCaligraphId
+    # @return [String]
+    attr_accessor :parentId
+    # @return [Integer]
+    attr_accessor :quantityAllocated
+  end
+end

data/lib/youcanbookme/models/account_child.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  class AccountChild
+    include ModelUtils
+
+    ASSOCIATION = {
+      profiles: Profile
+    }.freeze
+
+    # @return [String]
+    attr_accessor :email
+    # @return [String]
+    attr_accessor :id
+    # @return [Boolean]
+    attr_accessor :parentId
+    # @return [Array<Profile>]
+    attr_accessor :profiles
+  end
+end

data/lib/youcanbookme/models/{caligraph_safe_local_account.rb → account_parent.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBookMe's CaligraphSafeLocalAccount model.
-  class CaligraphSafeLocalAccount
+  class AccountParent
     include ModelUtils
 
     # @return [String]
     attr_accessor :email
     # @return [String]
     attr_accessor :id
+    # @return [Integer]
+    attr_accessor :quantityPaidFor
   end
 end

data/lib/youcanbookme/models/action.rb

@@ -8,6 +8,9 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :accountId
     # @return [String]
+    # ['BOOKING_CREATED', 'BOOKING_RESCHEDULED', 'BOOKING_CANCELLED', 'BOOKING_RESCHEDULED_BY_OWNER',
+    #  'BOOKING_RESCHEDULED_BY_BOOKER', 'BOOKING_CANCELLED_BY_OWNER', 'BOOKING_CANCELLED_BY_BOOKER', 'BOOKING_ACCEPTED',
+    #  'BOOKING_REJECTED', 'BOOKING_STARTS', 'BOOKING_ENDS', 'booked', 'rescheduled', 'cancelled', 'start', 'end']
     attr_accessor :anchor
     # @return [Boolean]
     attr_accessor :attachIcs
@@ -66,6 +69,7 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :profileId
     # @return [String]
+    # ['PREDICTION', 'TEMPLATE', 'OVERRIDEN', 'SKIPPED', 'SUCCEEDED', 'FAILED']
     attr_accessor :status
     # @return [String]
     attr_accessor :stylingTemplate
@@ -80,6 +84,7 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :to
     # @return [String]
+    # ['ZAP', 'WEBHOOK', 'EMAIL', 'SMS', 'SALESFORCE_TASK', 'SALESFORCE_UPSERT']
     attr_accessor :type
     # @return [String]
     attr_accessor :updated

data/lib/youcanbookme/models/answer.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBookMe's Answer model.
   class Answer
     include ModelUtils
 

data/lib/youcanbookme/models/booking.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBookMe's Booking model.
   class Booking
     include ModelUtils
 
@@ -9,8 +8,8 @@ module YouCanBookMe
       actions: Action,
       answers: Answer,
       appointmentTypes: ProfileAppointmentType,
-      caligraphEvent: CaligraphEvent,
       databaseVersion: Booking,
+      event: Event,
       lobby: BookingLobby,
       profile: Profile,
       services: ProfileAppointmentType,
@@ -33,8 +32,6 @@ module YouCanBookMe
     attr_accessor :appointmentTypesIds
     # @return [String]
     attr_accessor :bookerSecret
-    # @return [YouCanBookMe::CaligraphEvent]
-    attr_accessor :caligraphEvent
     # @return [Boolean]
     attr_accessor :cancelReasonRequired
     # @return [Boolean]
@@ -48,6 +45,7 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :cancelledAt
     # @return [String]
+    # ['BOOKER', 'OWNER']
     attr_accessor :cancelledBy
     # @return [String]
     attr_accessor :createdAt
@@ -87,6 +85,8 @@ module YouCanBookMe
     attr_accessor :endsAt
     # @return [String]
     attr_accessor :endsAtUTC
+    # @return [YouCanBookMe::Event]
+    attr_accessor :event
     # @return [Integer]
     attr_accessor :expectedPrice
     # @return [String]
@@ -132,6 +132,7 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :rescheduledAt
     # @return [String]
+    # ['BOOKER', 'OWNER']
     attr_accessor :rescheduledBy
     # @return [String]
     attr_accessor :reviewAt
@@ -154,6 +155,7 @@ module YouCanBookMe
     # @return [String]
     attr_accessor :teamMemberId
     # @return [String]
+    # ['NOT_USED', 'UNDECIDED', 'REJECTED', 'ACCEPTED']
     attr_accessor :tentative
     # @return [String]
     attr_accessor :timeZone
@@ -163,5 +165,7 @@ module YouCanBookMe
     attr_accessor :title
     # @return [Integer]
     attr_accessor :units
+    # @return [String]
+    attr_accessor :updatedAt
   end
 end