Client::Add

.rubocop.yml

@@ -452,3 +452,6 @@ Style/SymbolProc:
 
 Style/ZeroLengthPredicate:
   Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     xpm_ruby (0.1.0)
       faraday (~> 1)
+      nokogiri
       ox (~> 2.13)
 
 GEM
@@ -16,7 +17,10 @@ GEM
       multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.4)
     method_source (1.0.0)
+    mini_portile2 (2.4.0)
     multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
     ox (2.13.2)
     parallel (1.19.1)
     parser (2.7.1.1)

lib/xpm_ruby.rb

@@ -3,8 +3,12 @@ class Error < StandardError; end
   class Unauthorized < Error; end
 end
 
+require "nokogiri"
+
+require "xpm_ruby/version"
 require "xpm_ruby/connection"
 require "xpm_ruby/job"
 require "xpm_ruby/staff"
+require "xpm_ruby/client"
 require "xpm_ruby/template"
 require "xpm_ruby/version"

lib/xpm_ruby/client.rb

@@ -0,0 +1,49 @@
+require "faraday"
+require "base64"
+require "ox"
+
+require_relative "client/get"
+require_relative "client/add"
+
+module XpmRuby
+  module Client
+    extend self
+
+    module GstPeriod
+      ONE = "1"
+      TWO = "2"
+      SIX = "6"
+    end
+
+    module GstBasis
+      INVOICE = "Invoice"
+      PAYMENT = "Payment"
+      HYBRID = "Hybrid"
+    end
+
+    module ProvisionalTaxBasis
+      STANDARD_OPTION = "Standard Option"
+      ESTIMATE_OPTION = "Estimate Option"
+      RATIO_OPTION = "Ratio Option"
+    end
+
+    module AgencyStatus
+      WITH_EOT = "With EOT"
+      WITHOUT_EOT = "Without EOT"
+      UNLINKED = "Unlinked"
+    end
+
+    module ReturnType
+      IR3 = "IR3"
+      IR3NR = "IR3NR"
+      IR4 = "IR4"
+      IR6 = "IR6"
+      IR7 = "IR7"
+      IR9 = "IR9"
+      PTS = "PTS"
+    end
+
+    class Error < StandardError; end
+    class Unauthorized < Error; end
+  end
+end

lib/xpm_ruby/client/add.rb

@@ -0,0 +1,245 @@
+# client.api/add
+#
+# <Client>
+#   <Name>Bloggs Electrical Ltd</Name>
+#   <Email></Email>  <!-- optional -->
+#   <Address></Address>  <!-- optional -->
+#   <City></City>  <!-- optional -->
+#   <Region></Region>  <!-- optional -->
+#   <PostCode></PostCode>  <!-- optional -->
+#   <Country></Country>  <!-- optional -->
+#   <PostalAddress></PostalAddress>  <!-- optional -->
+#   <PostalCity></PostalCity>  <!-- optional -->
+#   <PostalRegion></PostalRegion>  <!-- optional -->
+#   <PostalPostCode></PostalPostCode>  <!-- optional -->
+#   <PostalCountry></PostalCountry>  <!-- optional -->
+#   <Phone></Phone>  <!-- optional -->
+#   <Fax></Fax>  <!-- optional -->
+#   <WebSite></WebSite>  <!-- optional -->
+#   <ReferralSource></ReferralSource>  <!-- optional -->
+#   <ExportCode></ExportCode>  <!-- optional -->
+#   <IsProspect>No</IsProspect>    <!-- Yes | No -->
+#   <AccountManagerUUID />  <!-- optional - UUID of staff member -->
+#   <Contacts>
+#     <Contact>
+#       <Name>Jo Bloggs</Name>
+#       <IsPrimary>yes</IsPrimary> <!-- If multiple contacts defined, method will interpret last primary client as Primary -->
+#       <Salutation></Salutation>  <!-- optional -->
+#       <Addressee></Addressee>  <!-- optional -->
+#       <Phone></Phone>  <!-- optional -->
+#       <Mobile></Mobile>  <!-- optional -->
+#       <Email></Email>  <!-- optional -->
+#       <Position></Position>  <!-- optional -->
+#     </Contact>
+#   </Contacts>
+#   <BillingClientUUID /> <!-- optional UUID of billing client -->
+
+#   <!-- The following fields are only applicable if the Practice Management module is enabled -->
+
+#   <FirstName />   <!-- optional, for individuals only -->
+#   <LastName />   <!-- optional, for individuals only -->
+#   <OtherName />   <!-- optional, for individuals only -->
+#   <DateOfBirth />   <!-- optional, for individuals only -->
+
+#   <JobManagerUUID />  <!-- optional - UUID of staff member -->
+#   <TaxNumber />
+#   <CompanyNumber />
+#   <BusinessNumber />
+#   <BusinessStructure />   <!-- Name of Business Structure (as per Admin) -->
+#   <BalanceMonth />  <!-- e.g. Jan, 1, Feb, 2, Mar, 3 etc  -->
+#   <PrepareGST />   <!-- Yes or No -->
+#   <GSTRegistered />   <!-- Yes or No -->
+#   <GSTPeriod />  <!-- 1, 2, 6 -->
+#   <GSTBasis />  <!-- Invoice, Payment, Hybrid  -->
+#   <ProvisionalTaxBasis />  <!-- Standard Option, Estimate Option, Ratio Option  -->
+#   <ProvisionalTaxRatio />
+
+#   <!-- The following fields apply to NZ clients only -->
+#   <SignedTaxAuthority />  <!-- Yes or No -->
+#   <TaxAgent />  <!-- Name of Tax Agent (as per Admin) -->
+#   <AgencyStatus />  <!-- With EOT, Without EOT, Unlinked -->
+#   <ReturnType />  <!-- IR3, IR3NR, IR4, IR6, IR7, IR9, PTS  -->
+
+#   <!-- The following fields apply to AU clients only -->
+#   <PrepareActivityStatement />  <!-- Yes or No -->
+#   <PrepareTaxReturn />  <!-- Yes or No -->
+# </Client>
+
+module XpmRuby
+  module Client
+    module Add
+      extend self
+
+      def call(api_key:, account_key:, api_url:, client:)
+        builder = ::Nokogiri::XML::Builder.new do |xml|
+          xml.Client do
+            xml.Name do
+              xml.text(client.name)
+            end
+          end
+        end
+
+        response = Connection
+          .new(api_key: api_key, account_key: account_key, api_url: api_url)
+          .post(endpoint: "client.api/add", data: builder.doc.root.to_xml)
+
+        case response.status
+        when 401
+          hash = Ox.load(response.body, mode: :hash_no_attrs, symbolize_keys: false)
+
+          raise Unauthorized.new(hash["html"]["head"]["title"])
+        when 200
+          hash = Ox.load(response.body, mode: :hash_no_attrs, symbolize_keys: false)
+
+          case hash["Response"]["Status"]
+          when "OK"
+            Get::Client.new(
+              uuid: hash["Response"]["Client"]["UUID"],
+              name: hash["Response"]["Client"]["Name"],
+              email: hash["Response"]["Client"]["Email"])
+          when "ERROR"
+            raise Error.new(response["ErrorDescription"])
+          end
+        else
+          raise Error.new(response.status)
+        end
+      end
+
+      class Client
+        attr_accessor :name, :email, :address, :city, :region, :post_code, :country,
+          :postal_address, :postal_city, :postal_region, :postal_post_code, :postal_country,
+          :phone, :fax, :web_site, :referral_source, :export_code, :is_prospect,
+          :account_manager_uuid, :contacts, :billing_client_uuid,
+          :first_name, :last_name, :other_name, :date_of_birth, :job_manager_uuid,
+          :tax_number, :company_number, :business_number, :business_structure, :balance_month,
+          :prepare_gst, :gst_registered, :gst_period, :gst_basis,
+          :provisional_tax_basis, :provisional_tax_ratio,
+          :signed_tax_authority, :tax_agent, :agency_status, :return_type,
+          :prepare_activity_statement, :prepare_tax_return
+
+        # rubocop:disable Metrics/AbcSize
+        def initialize(name:, email: nil,
+                      address: nil, city: nil, region: nil, post_code: nil, country: nil,
+                      postal_address: nil, postal_city: nil, postal_region: nil,
+                      postal_post_code: nil, postal_country: nil,
+                      phone: nil, fax: nil, web_site: nil,
+                      referral_source: nil, export_code: nil, is_prospect: nil,
+                      account_manager_uuid: nil, contacts: nil, billing_client_uuid: nil,
+                      first_name: nil, last_name: nil, other_name: nil, date_of_birth: nil,
+                      job_manager_uuid: nil, tax_number: nil, company_number: nil,
+                      business_number: nil, business_structure: nil, balance_month: nil,
+                      prepare_gst: nil, gst_registered: nil, gst_period: nil, gst_basis: nil,
+                      provisional_tax_basis: nil, provisional_tax_ratio: nil,
+                      signed_tax_authority: nil, tax_agent: nil, agency_status: nil,
+                      return_type: nil, prepare_activity_statement: nil, prepare_tax_return: nil)
+          @name =  name
+          @email = email
+          @address = address
+          @city = city
+          @region = region
+          @post_code = post_code
+          @country = country
+          @postal_address = postal_address
+          @postal_city = postal_city
+          @postal_region = postal_region
+          @postal_post_code = postal_post_code
+          @postal_country = postal_country
+          @phone = phone
+          @fax = fax
+          @web_site = web_site
+          @referral_source = referral_source
+          @export_code = export_code
+          @is_prospect = is_prospect
+          @account_manager_uuid = account_manager_uuid
+          @contacts = contacts
+          @billing_client_uuid = billing_client_uuid
+          @first_name = first_name
+          @last_name = last_name
+          @other_name = other_name
+          @date_of_birth = date_of_birth
+          @job_manager_uuid = job_manager_uuid
+          @tax_number = tax_number
+          @company_number = company_number
+          @business_number = business_number
+          @business_structure = business_structure
+          @balance_month = balance_month
+          @prepare_gst = prepare_gst
+          @gst_registered = gst_registered
+          @gst_period = gst_period
+          @gst_basis = gst_basis
+          @provisional_tax_basis = provisional_tax_basis
+          @provisional_tax_rate = provisional_tax_ratio
+          @signed_tax_authority = signed_tax_authority
+          @tax_agent = tax_agent
+          @agency_status = agency_status
+          @return_type = return_type
+          @prepare_activity_statement = prepare_activity_statement
+          @prepare_tax_return = prepare_tax_return
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        class AccountManager
+          attr_reader :uuid, :name
+
+          def initialize(uuid: nil, name: nil)
+            @uuid = uuid
+            @name = name
+          end
+
+          def ==(other)
+            uuid == other.uuid
+          end
+
+          def eql?(other)
+            self == other
+          end
+        end
+
+        class Type
+          attr_reader :name, :cost_markup, :payment_term, :payment_day
+
+          def initialize(name: nil, cost_markup: nil, payment_term: nil, payment_day: nil)
+            @name = name
+            @cost_markup = cost_markup
+            @payment_term = payment_term
+            @payment_day = payment_day
+          end
+
+          def ==(other)
+            name == other.name &&
+            cost_markup == other.cost_markup &&
+            payment_term == other.payment_term &&
+            payment_day == other.payment_day
+          end
+
+          def eql?(other)
+            self == other
+          end
+        end
+
+        class Contact
+          def initialize(uuid: nil, is_primary: nil, name: nil, salutation: nil,
+                        addressee: nil, mobile: nil, email: nil, phone: nil, position: nil)
+            @uuid = uuid
+            @is_primary = is_primary
+            @name = name
+            @salutation = salutation
+            @addressee = addressee
+            @mobile = mobile
+            @email = email
+            @phone = phone
+            @position = position
+          end
+
+          def ==(other)
+            uuid == other.uuid
+          end
+
+          def eql?(other)
+            self == other
+          end
+        end
+      end
+    end
+  end
+end