xero-ruby 3.5.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9964f9aa75af0300d58f3692608faec0fb1b630c31d124d1987afcdba34dc088
-  data.tar.gz: a486de4ffc35d64ef6ebdca5632badfcfbbdaefee574c3bee871c361695e42b2
+  metadata.gz: 2ca9c97d0563f7c0afdfd394027980e8e1c03fa8b976e89897b81bb4c70a8516
+  data.tar.gz: f664ff155e620b8b744ff781c7ee3292e44c0f272df4f1b2b9436a073cdaf599
 SHA512:
-  metadata.gz: c7cbedbabebb6390585b606e0988cbc257fcbcffae032909fcae0873f4f9966b6c4e837eb30ea0d5a9b8ad41b05c598264672afa14f73e3ab40f47ca7a6ea364
-  data.tar.gz: aebf03b88385398c8e042574c8c52207624b6aba25ae346964f9bfa135a7742fca3b8524565b9fc7899041b69d4bed9aeeb21451867f507eed2184d71d913fef
+  metadata.gz: 416eb3d2e28e3cd3be72fed48695f767f6c2e6db156cddbded08fd6c514efa7a9e6ce8f006d4eec5d81d18729c2c65f573f83b9d3897cc748f14d5557521bf4d
+  data.tar.gz: 0f405451c84c1f83ea23639e3c2648a905313cced2a482604af726f307c7ed8421c1dbea3bb38cfd780fe01dc07143367484bd2e09292361e9aaee11c70e19a3

data/lib/xero-ruby/api/finance_api.rb

@@ -315,6 +315,101 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Get Bank Statement Accounting
+    # For lenders that prefer using bank statement data as the source of truth.  We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well.  As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. 
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param bank_account_id [String] string, GUID    Bank account Id
+    # @param from_date [String] date, yyyy-MM-dd     Specifies the start date of the query period.   The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.
+    # @param to_date [String] date, yyyy-MM-dd     Specifies the end date of the query period.   If the end date is a future date, the request will be rejected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summary_only boolean, true/false    The default value is true if no parameter is provided.    In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.
+    # @return [BankStatementAccountingResponse]
+    def get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts = {})
+      data, _status_code, _headers = get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, opts)
+      data
+    end
+
+    # Get Bank Statement Accounting
+    # For lenders that prefer using bank statement data as the source of truth.  We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well.  As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. 
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param bank_account_id [String] string, GUID    Bank account Id
+    # @param from_date [String] date, yyyy-MM-dd     Specifies the start date of the query period.   The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.
+    # @param to_date [String] date, yyyy-MM-dd     Specifies the end date of the query period.   If the end date is a future date, the request will be rejected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summary_only boolean, true/false    The default value is true if no parameter is provided.    In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.
+    # @return [Array<(BankStatementAccountingResponse, Integer, Hash)>] BankStatementAccountingResponse data, response status code and response headers
+    def get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FinanceApi.get_bank_statement_accounting ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'bank_account_id' is set
+      if @api_client.config.client_side_validation && bank_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'from_date' is set
+      if @api_client.config.client_side_validation && from_date.nil?
+        fail ArgumentError, "Missing the required parameter 'from_date' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'to_date' is set
+      if @api_client.config.client_side_validation && to_date.nil?
+        fail ArgumentError, "Missing the required parameter 'to_date' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # resource path
+      local_var_path = '/BankStatementsPlus/statements'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'BankAccountID'] = bank_account_id
+      query_params[:'FromDate'] = from_date
+      query_params[:'ToDate'] = to_date
+      query_params[:'SummaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BankStatementAccountingResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FinanceApi#get_bank_statement_accounting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get cash validation
     # Summarizes the total cash position for each account for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant

data/lib/xero-ruby/api/payroll_uk_api.rb

@@ -3594,7 +3594,7 @@ module XeroRuby
     # Retrieves employees
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter by first name and/or lastname
+    # @option opts [String] :filter Filter by first name, lastname, and/or whether they are an off-payroll worker
     # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
     # @return [Employees]
     def get_employees(xero_tenant_id, opts = {})
@@ -3605,7 +3605,7 @@ module XeroRuby
     # Retrieves employees
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter by first name and/or lastname
+    # @option opts [String] :filter Filter by first name, lastname, and/or whether they are an off-payroll worker
     # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
     # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers
     def get_employees_with_http_info(xero_tenant_id, options = {})

data/lib/xero-ruby/api_client.rb

@@ -188,7 +188,7 @@ module XeroRuby
     end
 
     def validate_state(params)
-      if params[:state] != @state
+      if params['state'] != @state
         raise StandardError.new "WARNING: @config.state: #{@state} and OAuth callback state: #{params['state']} do not match!"
       end
       return true

data/lib/xero-ruby/models/accounting/account.rb

@@ -33,20 +33,20 @@ module XeroRuby::Accounting
     
     # Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
     attr_accessor :status
-    ACTIVE = "ACTIVE".freeze
-    ARCHIVED = "ARCHIVED".freeze
-    DELETED = "DELETED".freeze
+    ACTIVE ||= "ACTIVE".freeze
+    ARCHIVED ||= "ARCHIVED".freeze
+    DELETED ||= "DELETED".freeze
     
     # Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
     attr_accessor :description
     
     # For bank accounts only. See Bank Account types
     attr_accessor :bank_account_type
-    BANK = "BANK".freeze
-    CREDITCARD = "CREDITCARD".freeze
-    PAYPAL = "PAYPAL".freeze
-    NONE = "NONE".freeze
-    EMPTY = "".freeze
+    BANK ||= "BANK".freeze
+    CREDITCARD ||= "CREDITCARD".freeze
+    PAYPAL ||= "PAYPAL".freeze
+    NONE ||= "NONE".freeze
+    EMPTY ||= "".freeze
     
 
     attr_accessor :currency_code
@@ -62,35 +62,35 @@ module XeroRuby::Accounting
     
     # See Account Class Types
     attr_accessor :_class
-    ASSET = "ASSET".freeze
-    EQUITY = "EQUITY".freeze
-    EXPENSE = "EXPENSE".freeze
-    LIABILITY = "LIABILITY".freeze
-    REVENUE = "REVENUE".freeze
+    ASSET ||= "ASSET".freeze
+    EQUITY ||= "EQUITY".freeze
+    EXPENSE ||= "EXPENSE".freeze
+    LIABILITY ||= "LIABILITY".freeze
+    REVENUE ||= "REVENUE".freeze
     
     # If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.
     attr_accessor :system_account
-    DEBTORS = "DEBTORS".freeze
-    CREDITORS = "CREDITORS".freeze
-    BANKCURRENCYGAIN = "BANKCURRENCYGAIN".freeze
-    GST = "GST".freeze
-    GSTONIMPORTS = "GSTONIMPORTS".freeze
-    HISTORICAL = "HISTORICAL".freeze
-    REALISEDCURRENCYGAIN = "REALISEDCURRENCYGAIN".freeze
-    RETAINEDEARNINGS = "RETAINEDEARNINGS".freeze
-    ROUNDING = "ROUNDING".freeze
-    TRACKINGTRANSFERS = "TRACKINGTRANSFERS".freeze
-    UNPAIDEXPCLM = "UNPAIDEXPCLM".freeze
-    UNREALISEDCURRENCYGAIN = "UNREALISEDCURRENCYGAIN".freeze
-    WAGEPAYABLES = "WAGEPAYABLES".freeze
-    CISASSETS = "CISASSETS".freeze
-    CISASSET = "CISASSET".freeze
-    CISLABOUR = "CISLABOUR".freeze
-    CISLABOUREXPENSE = "CISLABOUREXPENSE".freeze
-    CISLABOURINCOME = "CISLABOURINCOME".freeze
-    CISLIABILITY = "CISLIABILITY".freeze
-    CISMATERIALS = "CISMATERIALS".freeze
-    # EMPTY = "".freeze
+    DEBTORS ||= "DEBTORS".freeze
+    CREDITORS ||= "CREDITORS".freeze
+    BANKCURRENCYGAIN ||= "BANKCURRENCYGAIN".freeze
+    GST ||= "GST".freeze
+    GSTONIMPORTS ||= "GSTONIMPORTS".freeze
+    HISTORICAL ||= "HISTORICAL".freeze
+    REALISEDCURRENCYGAIN ||= "REALISEDCURRENCYGAIN".freeze
+    RETAINEDEARNINGS ||= "RETAINEDEARNINGS".freeze
+    ROUNDING ||= "ROUNDING".freeze
+    TRACKINGTRANSFERS ||= "TRACKINGTRANSFERS".freeze
+    UNPAIDEXPCLM ||= "UNPAIDEXPCLM".freeze
+    UNREALISEDCURRENCYGAIN ||= "UNREALISEDCURRENCYGAIN".freeze
+    WAGEPAYABLES ||= "WAGEPAYABLES".freeze
+    CISASSETS ||= "CISASSETS".freeze
+    CISASSET ||= "CISASSET".freeze
+    CISLABOUR ||= "CISLABOUR".freeze
+    CISLABOUREXPENSE ||= "CISLABOUREXPENSE".freeze
+    CISLABOURINCOME ||= "CISLABOURINCOME".freeze
+    CISLIABILITY ||= "CISLIABILITY".freeze
+    CISMATERIALS ||= "CISMATERIALS".freeze
+    EMPTY ||= "".freeze
     
     # Shown if set
     attr_accessor :reporting_code

data/lib/xero-ruby/models/accounting/account_type.rb

@@ -14,28 +14,28 @@ require 'date'
 
 module XeroRuby::Accounting
   class AccountType
-    BANK = "BANK".freeze
-    CURRENT = "CURRENT".freeze
-    CURRLIAB = "CURRLIAB".freeze
-    DEPRECIATN = "DEPRECIATN".freeze
-    DIRECTCOSTS = "DIRECTCOSTS".freeze
-    EQUITY = "EQUITY".freeze
-    EXPENSE = "EXPENSE".freeze
-    FIXED = "FIXED".freeze
-    INVENTORY = "INVENTORY".freeze
-    LIABILITY = "LIABILITY".freeze
-    NONCURRENT = "NONCURRENT".freeze
-    OTHERINCOME = "OTHERINCOME".freeze
-    OVERHEADS = "OVERHEADS".freeze
-    PREPAYMENT = "PREPAYMENT".freeze
-    REVENUE = "REVENUE".freeze
-    SALES = "SALES".freeze
-    TERMLIAB = "TERMLIAB".freeze
-    PAYGLIABILITY = "PAYGLIABILITY".freeze
-    PAYG = "PAYG".freeze
-    SUPERANNUATIONEXPENSE = "SUPERANNUATIONEXPENSE".freeze
-    SUPERANNUATIONLIABILITY = "SUPERANNUATIONLIABILITY".freeze
-    WAGESEXPENSE = "WAGESEXPENSE".freeze
+    BANK ||= "BANK".freeze
+    CURRENT ||= "CURRENT".freeze
+    CURRLIAB ||= "CURRLIAB".freeze
+    DEPRECIATN ||= "DEPRECIATN".freeze
+    DIRECTCOSTS ||= "DIRECTCOSTS".freeze
+    EQUITY ||= "EQUITY".freeze
+    EXPENSE ||= "EXPENSE".freeze
+    FIXED ||= "FIXED".freeze
+    INVENTORY ||= "INVENTORY".freeze
+    LIABILITY ||= "LIABILITY".freeze
+    NONCURRENT ||= "NONCURRENT".freeze
+    OTHERINCOME ||= "OTHERINCOME".freeze
+    OVERHEADS ||= "OVERHEADS".freeze
+    PREPAYMENT ||= "PREPAYMENT".freeze
+    REVENUE ||= "REVENUE".freeze
+    SALES ||= "SALES".freeze
+    TERMLIAB ||= "TERMLIAB".freeze
+    PAYGLIABILITY ||= "PAYGLIABILITY".freeze
+    PAYG ||= "PAYG".freeze
+    SUPERANNUATIONEXPENSE ||= "SUPERANNUATIONEXPENSE".freeze
+    SUPERANNUATIONLIABILITY ||= "SUPERANNUATIONLIABILITY".freeze
+    WAGESEXPENSE ||= "WAGESEXPENSE".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/xero-ruby/models/accounting/action.rb

@@ -21,8 +21,8 @@ module XeroRuby::Accounting
     
     # Status of the action for this organisation
     attr_accessor :status
-    ALLOWED = "ALLOWED".freeze
-    NOT_ALLOWED = "NOT-ALLOWED".freeze
+    ALLOWED ||= "ALLOWED".freeze
+    NOT_ALLOWED ||= "NOT-ALLOWED".freeze
     
     class EnumAttributeValidator
       attr_reader :datatype

data/lib/xero-ruby/models/accounting/address.rb

@@ -18,8 +18,8 @@ module XeroRuby::Accounting
   class Address
     # define the type of address
     attr_accessor :address_type
-    POBOX = "POBOX".freeze
-    STREET = "STREET".freeze
+    POBOX ||= "POBOX".freeze
+    STREET ||= "STREET".freeze
     
     # max length = 500
     attr_accessor :address_line1

data/lib/xero-ruby/models/accounting/address_for_organisation.rb

@@ -18,9 +18,9 @@ module XeroRuby::Accounting
   class AddressForOrganisation
     # define the type of address
     attr_accessor :address_type
-    POBOX = "POBOX".freeze
-    STREET = "STREET".freeze
-    DELIVERY = "DELIVERY".freeze
+    POBOX ||= "POBOX".freeze
+    STREET ||= "STREET".freeze
+    DELIVERY ||= "DELIVERY".freeze
     
     # max length = 500
     attr_accessor :address_line1

data/lib/xero-ruby/models/accounting/bank_transaction.rb

@@ -18,14 +18,14 @@ module XeroRuby::Accounting
   class BankTransaction
     # See Bank Transaction Types
     attr_accessor :type
-    RECEIVE = "RECEIVE".freeze
-    RECEIVE_OVERPAYMENT = "RECEIVE-OVERPAYMENT".freeze
-    RECEIVE_PREPAYMENT = "RECEIVE-PREPAYMENT".freeze
-    SPEND = "SPEND".freeze
-    SPEND_OVERPAYMENT = "SPEND-OVERPAYMENT".freeze
-    SPEND_PREPAYMENT = "SPEND-PREPAYMENT".freeze
-    RECEIVE_TRANSFER = "RECEIVE-TRANSFER".freeze
-    SPEND_TRANSFER = "SPEND-TRANSFER".freeze
+    RECEIVE ||= "RECEIVE".freeze
+    RECEIVE_OVERPAYMENT ||= "RECEIVE-OVERPAYMENT".freeze
+    RECEIVE_PREPAYMENT ||= "RECEIVE-PREPAYMENT".freeze
+    SPEND ||= "SPEND".freeze
+    SPEND_OVERPAYMENT ||= "SPEND-OVERPAYMENT".freeze
+    SPEND_PREPAYMENT ||= "SPEND-PREPAYMENT".freeze
+    RECEIVE_TRANSFER ||= "RECEIVE-TRANSFER".freeze
+    SPEND_TRANSFER ||= "SPEND-TRANSFER".freeze
     
 
     attr_accessor :contact
@@ -56,9 +56,9 @@ module XeroRuby::Accounting
     
     # See Bank Transaction Status Codes
     attr_accessor :status
-    AUTHORISED = "AUTHORISED".freeze
-    DELETED = "DELETED".freeze
-    VOIDED = "VOIDED".freeze
+    AUTHORISED ||= "AUTHORISED".freeze
+    DELETED ||= "DELETED".freeze
+    VOIDED ||= "VOIDED".freeze
     
 
     attr_accessor :line_amount_types

data/lib/xero-ruby/models/accounting/batch_payment.rb

@@ -51,13 +51,13 @@ module XeroRuby::Accounting
     
     # PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
     attr_accessor :type
-    PAYBATCH = "PAYBATCH".freeze
-    RECBATCH = "RECBATCH".freeze
+    PAYBATCH ||= "PAYBATCH".freeze
+    RECBATCH ||= "RECBATCH".freeze
     
     # AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API.
     attr_accessor :status
-    AUTHORISED = "AUTHORISED".freeze
-    DELETED = "DELETED".freeze
+    AUTHORISED ||= "AUTHORISED".freeze
+    DELETED ||= "DELETED".freeze
     
     # The total of the payments that make up the batch (read-only)
     attr_accessor :total_amount

data/lib/xero-ruby/models/accounting/branding_theme.rb

@@ -27,7 +27,7 @@ module XeroRuby::Accounting
     
     # Always INVOICE
     attr_accessor :type
-    INVOICE = "INVOICE".freeze
+    INVOICE ||= "INVOICE".freeze
     
     # Integer – ranked order of branding theme. The default branding theme has a value of 0
     attr_accessor :sort_order

data/lib/xero-ruby/models/accounting/budget.rb

@@ -21,8 +21,8 @@ module XeroRuby::Accounting
     
     # Type of Budget. OVERALL or TRACKING
     attr_accessor :type
-    OVERALL = "OVERALL".freeze
-    TRACKING = "TRACKING".freeze
+    OVERALL ||= "OVERALL".freeze
+    TRACKING ||= "TRACKING".freeze
     
     # The Budget description
     attr_accessor :description

data/lib/xero-ruby/models/accounting/contact.rb

@@ -30,9 +30,9 @@ module XeroRuby::Accounting
     
     # Current status of a contact – see contact status types
     attr_accessor :contact_status
-    ACTIVE = "ACTIVE".freeze
-    ARCHIVED = "ARCHIVED".freeze
-    GDPRREQUEST = "GDPRREQUEST".freeze
+    ACTIVE ||= "ACTIVE".freeze
+    ARCHIVED ||= "ARCHIVED".freeze
+    GDPRREQUEST ||= "GDPRREQUEST".freeze
     
     # Full name of contact/organisation (max length = 255)
     attr_accessor :name
@@ -81,15 +81,15 @@ module XeroRuby::Accounting
     
     # The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
     attr_accessor :sales_default_line_amount_type
-    INCLUSIVE = "INCLUSIVE".freeze
-    EXCLUSIVE = "EXCLUSIVE".freeze
-    # NONE = "NONE".freeze
+    INCLUSIVE ||= "INCLUSIVE".freeze
+    EXCLUSIVE ||= "EXCLUSIVE".freeze
+    NONE ||= "NONE".freeze
     
     # The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
     attr_accessor :purchases_default_line_amount_type
-    # INCLUSIVE = "INCLUSIVE".freeze
-    # EXCLUSIVE = "EXCLUSIVE".freeze
-    # NONE = "NONE".freeze
+    INCLUSIVE ||= "INCLUSIVE".freeze
+    EXCLUSIVE ||= "EXCLUSIVE".freeze
+    NONE ||= "NONE".freeze
     
 
     attr_accessor :default_currency

data/lib/xero-ruby/models/accounting/contact_group.rb

@@ -21,8 +21,8 @@ module XeroRuby::Accounting
     
     # The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.
     attr_accessor :status
-    ACTIVE = "ACTIVE".freeze
-    DELETED = "DELETED".freeze
+    ACTIVE ||= "ACTIVE".freeze
+    DELETED ||= "DELETED".freeze
     
     # The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
     attr_accessor :contact_group_id