lockstep_rails 0.3.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/README.md +216 -0
- data/Rakefile +31 -0
- data/app/assets/config/lockstep_rails_manifest.js +0 -0
- data/app/concepts/lockstep/active_records/association.rb +78 -0
- data/app/concepts/lockstep/api_record.rb +1118 -0
- data/app/concepts/lockstep/api_records/scopes.rb +20 -0
- data/app/concepts/lockstep/client.rb +162 -0
- data/app/concepts/lockstep/error.rb +50 -0
- data/app/concepts/lockstep/exceptions.rb +4 -0
- data/app/concepts/lockstep/query.rb +409 -0
- data/app/concepts/lockstep/query_methods.rb +75 -0
- data/app/concepts/lockstep/relation_array.rb +100 -0
- data/app/helpers/types.rb +3 -0
- data/app/models/lockstep/account.rb +15 -0
- data/app/models/lockstep/connection.rb +19 -0
- data/app/models/lockstep/contact.rb +9 -0
- data/app/models/lockstep/customer_summary.rb +6 -0
- data/app/models/lockstep/invoice.rb +7 -0
- data/app/models/lockstep/invoice_summary.rb +6 -0
- data/app/models/lockstep/invoices/address.rb +24 -0
- data/app/models/lockstep/note.rb +7 -0
- data/app/models/lockstep/payment.rb +7 -0
- data/app/models/lockstep/payment_summary.rb +6 -0
- data/app/models/lockstep/user.rb +10 -0
- data/app/platform_api/model_template.rb.erb +27 -0
- data/app/platform_api/schema/action_result.rb +15 -0
- data/app/platform_api/schema/activity.rb +141 -0
- data/app/platform_api/schema/activity_fetch_result.rb +26 -0
- data/app/platform_api/schema/activity_stream_item.rb +58 -0
- data/app/platform_api/schema/activity_x_ref.rb +37 -0
- data/app/platform_api/schema/aging.rb +24 -0
- data/app/platform_api/schema/api_key.rb +71 -0
- data/app/platform_api/schema/api_key_fetch_result.rb +26 -0
- data/app/platform_api/schema/app_enrollment.rb +88 -0
- data/app/platform_api/schema/app_enrollment_custom_field.rb +67 -0
- data/app/platform_api/schema/app_enrollment_custom_field_fetch_result.rb +26 -0
- data/app/platform_api/schema/app_enrollment_fetch_result.rb +26 -0
- data/app/platform_api/schema/application.rb +89 -0
- data/app/platform_api/schema/application_fetch_result.rb +26 -0
- data/app/platform_api/schema/ar_aging_header_info.rb +47 -0
- data/app/platform_api/schema/ar_header_info.rb +118 -0
- data/app/platform_api/schema/assembly.rb +68 -0
- data/app/platform_api/schema/at_risk_invoice_summary.rb +90 -0
- data/app/platform_api/schema/at_risk_invoice_summary_fetch_result.rb +26 -0
- data/app/platform_api/schema/attachment.rb +92 -0
- data/app/platform_api/schema/attachment_fetch_result.rb +26 -0
- data/app/platform_api/schema/attachment_header_info.rb +41 -0
- data/app/platform_api/schema/batch_sync.rb +18 -0
- data/app/platform_api/schema/bulk_currency_conversion.rb +19 -0
- data/app/platform_api/schema/cashflow_report.rb +35 -0
- data/app/platform_api/schema/code_definition.rb +58 -0
- data/app/platform_api/schema/code_definition_fetch_result.rb +26 -0
- data/app/platform_api/schema/company.rb +243 -0
- data/app/platform_api/schema/company_fetch_result.rb +26 -0
- data/app/platform_api/schema/company_sync.rb +142 -0
- data/app/platform_api/schema/connector_info.rb +27 -0
- data/app/platform_api/schema/constructor_info.rb +128 -0
- data/app/platform_api/schema/contact.rb +148 -0
- data/app/platform_api/schema/contact_fetch_result.rb +26 -0
- data/app/platform_api/schema/contact_sync.rb +109 -0
- data/app/platform_api/schema/country.rb +62 -0
- data/app/platform_api/schema/country_fetch_result.rb +26 -0
- data/app/platform_api/schema/credit_memo_applied.rb +104 -0
- data/app/platform_api/schema/credit_memo_applied_fetch_result.rb +26 -0
- data/app/platform_api/schema/credit_memo_applied_sync.rb +67 -0
- data/app/platform_api/schema/credit_memo_invoice.rb +77 -0
- data/app/platform_api/schema/currency.rb +31 -0
- data/app/platform_api/schema/currency_fetch_result.rb +26 -0
- data/app/platform_api/schema/currency_rate.rb +28 -0
- data/app/platform_api/schema/custom_attribute_data.rb +18 -0
- data/app/platform_api/schema/custom_attribute_named_argument.rb +24 -0
- data/app/platform_api/schema/custom_attribute_typed_argument.rb +16 -0
- data/app/platform_api/schema/custom_field_definition.rb +76 -0
- data/app/platform_api/schema/custom_field_definition_fetch_result.rb +26 -0
- data/app/platform_api/schema/custom_field_sync.rb +71 -0
- data/app/platform_api/schema/custom_field_value.rb +75 -0
- data/app/platform_api/schema/custom_field_value_fetch_result.rb +26 -0
- data/app/platform_api/schema/customer_details.rb +98 -0
- data/app/platform_api/schema/customer_details_payment.rb +60 -0
- data/app/platform_api/schema/customer_summary.rb +88 -0
- data/app/platform_api/schema/customer_summary_fetch_result.rb +26 -0
- data/app/platform_api/schema/daily_sales_outstanding_report.rb +25 -0
- data/app/platform_api/schema/developer_account_submit.rb +23 -0
- data/app/platform_api/schema/email.rb +160 -0
- data/app/platform_api/schema/email_fetch_result.rb +26 -0
- data/app/platform_api/schema/erp.rb +23 -0
- data/app/platform_api/schema/erp_fetch_result.rb +26 -0
- data/app/platform_api/schema/erp_info.rb +18 -0
- data/app/platform_api/schema/erp_info_data.rb +23 -0
- data/app/platform_api/schema/event_info.rb +59 -0
- data/app/platform_api/schema/exception.rb +41 -0
- data/app/platform_api/schema/field_info.rb +105 -0
- data/app/platform_api/schema/financial_account.rb +90 -0
- data/app/platform_api/schema/financial_account_balance_history.rb +90 -0
- data/app/platform_api/schema/financial_account_balance_history_fetch_result.rb +26 -0
- data/app/platform_api/schema/financial_account_fetch_result.rb +26 -0
- data/app/platform_api/schema/financial_year_setting.rb +74 -0
- data/app/platform_api/schema/financial_year_setting_fetch_result.rb +26 -0
- data/app/platform_api/schema/invite.rb +25 -0
- data/app/platform_api/schema/invite_data.rb +18 -0
- data/app/platform_api/schema/invite_submit.rb +15 -0
- data/app/platform_api/schema/invoice.rb +226 -0
- data/app/platform_api/schema/invoice_address.rb +97 -0
- data/app/platform_api/schema/invoice_fetch_result.rb +29 -0
- data/app/platform_api/schema/invoice_history.rb +188 -0
- data/app/platform_api/schema/invoice_history_fetch_result.rb +26 -0
- data/app/platform_api/schema/invoice_line.rb +142 -0
- data/app/platform_api/schema/invoice_line_sync.rb +208 -0
- data/app/platform_api/schema/invoice_payment_detail.rb +65 -0
- data/app/platform_api/schema/invoice_summary.rb +85 -0
- data/app/platform_api/schema/invoice_summary_fetch_result.rb +26 -0
- data/app/platform_api/schema/invoice_sync.rb +280 -0
- data/app/platform_api/schema/lead.rb +32 -0
- data/app/platform_api/schema/member_info.rb +36 -0
- data/app/platform_api/schema/method_base.rb +128 -0
- data/app/platform_api/schema/method_info.rb +137 -0
- data/app/platform_api/schema/module.rb +44 -0
- data/app/platform_api/schema/module_handle.rb +15 -0
- data/app/platform_api/schema/note.rb +72 -0
- data/app/platform_api/schema/note_fetch_result.rb +26 -0
- data/app/platform_api/schema/parameter_info.rb +64 -0
- data/app/platform_api/schema/payment.rb +147 -0
- data/app/platform_api/schema/payment_applied.rb +95 -0
- data/app/platform_api/schema/payment_applied_fetch_result.rb +26 -0
- data/app/platform_api/schema/payment_applied_sync.rb +74 -0
- data/app/platform_api/schema/payment_detail.rb +110 -0
- data/app/platform_api/schema/payment_detail_fetch_result.rb +26 -0
- data/app/platform_api/schema/payment_detail_header.rb +43 -0
- data/app/platform_api/schema/payment_fetch_result.rb +26 -0
- data/app/platform_api/schema/payment_summary.rb +79 -0
- data/app/platform_api/schema/payment_summary_fetch_result.rb +26 -0
- data/app/platform_api/schema/payment_sync.rb +112 -0
- data/app/platform_api/schema/problem_details.rb +31 -0
- data/app/platform_api/schema/property_info.rb +60 -0
- data/app/platform_api/schema/provisioning.rb +28 -0
- data/app/platform_api/schema/provisioning_finalize_request.rb +28 -0
- data/app/platform_api/schema/provisioning_response.rb +42 -0
- data/app/platform_api/schema/risk_rate.rb +57 -0
- data/app/platform_api/schema/runtime_field_handle.rb +13 -0
- data/app/platform_api/schema/runtime_method_handle.rb +13 -0
- data/app/platform_api/schema/runtime_type_handle.rb +13 -0
- data/app/platform_api/schema/state.rb +22 -0
- data/app/platform_api/schema/state_fetch_result.rb +26 -0
- data/app/platform_api/schema/status.rb +72 -0
- data/app/platform_api/schema/struct_layout_attribute.rb +16 -0
- data/app/platform_api/schema/sync_entity_result.rb +34 -0
- data/app/platform_api/schema/sync_request.rb +71 -0
- data/app/platform_api/schema/sync_request_fetch_result.rb +26 -0
- data/app/platform_api/schema/sync_submit.rb +15 -0
- data/app/platform_api/schema/test_argument_exception.rb +41 -0
- data/app/platform_api/schema/test_timeout_exception.rb +41 -0
- data/app/platform_api/schema/transfer_owner.rb +16 -0
- data/app/platform_api/schema/transfer_owner_submit.rb +15 -0
- data/app/platform_api/schema/type.rb +278 -0
- data/app/platform_api/schema/type_info.rb +287 -0
- data/app/platform_api/schema/uri.rb +15 -0
- data/app/platform_api/schema/user_account.rb +152 -0
- data/app/platform_api/schema/user_account_fetch_result.rb +26 -0
- data/app/platform_api/schema/user_role.rb +50 -0
- data/app/platform_api/schema/user_role_fetch_result.rb +26 -0
- data/app/platform_api/schema/webhook.rb +96 -0
- data/app/platform_api/schema/webhook_fetch_result.rb +26 -0
- data/app/platform_api/schema/webhook_history_table_storage.rb +64 -0
- data/app/platform_api/schema/webhook_history_table_storage_fetch_result.rb +26 -0
- data/app/platform_api/swagger.json +22056 -0
- data/config/routes.rb +2 -0
- data/lib/lockstep_rails/engine.rb +4 -0
- data/lib/lockstep_rails/version.rb +3 -0
- data/lib/lockstep_rails.rb +5 -0
- data/lib/tasks/lockstep_rails_tasks.rake +4 -0
- data/lib/tasks/update_api_schema.rake +159 -0
- metadata +230 -0
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::CustomFieldValueFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::CustomFieldValue", :included=>true}
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
class Schema::CustomerDetails < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
|
9
|
+
# account will share the same GroupKey value. GroupKey values cannot be changed once created.
|
10
|
+
#
|
11
|
+
# For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
12
|
+
# @type: string
|
13
|
+
# @format: uuid
|
14
|
+
field :group_key
|
15
|
+
|
16
|
+
# The unique ID of this customer
|
17
|
+
# @type: string
|
18
|
+
# @format: uuid
|
19
|
+
field :customer_id
|
20
|
+
|
21
|
+
# The unique ID of this customer
|
22
|
+
# @type: string
|
23
|
+
field :name
|
24
|
+
|
25
|
+
# Customer address info
|
26
|
+
# @type: string
|
27
|
+
field :address1
|
28
|
+
|
29
|
+
# Customer address info
|
30
|
+
# @type: string
|
31
|
+
field :address2
|
32
|
+
|
33
|
+
# Customer address info
|
34
|
+
# @type: string
|
35
|
+
field :address3
|
36
|
+
|
37
|
+
# Customer address info
|
38
|
+
# @type: string
|
39
|
+
field :city
|
40
|
+
|
41
|
+
# Customer address info
|
42
|
+
# @type: string
|
43
|
+
field :state
|
44
|
+
|
45
|
+
# Customer address info
|
46
|
+
# @type: string
|
47
|
+
field :postal_code
|
48
|
+
|
49
|
+
# Customer address country
|
50
|
+
# @type: string
|
51
|
+
field :country
|
52
|
+
|
53
|
+
# Customer phone number
|
54
|
+
# @type: string
|
55
|
+
field :phone_number
|
56
|
+
|
57
|
+
# Customer fax number
|
58
|
+
# @type: string
|
59
|
+
field :fax_number
|
60
|
+
|
61
|
+
# Customer AR email address
|
62
|
+
# @type: string
|
63
|
+
field :email
|
64
|
+
|
65
|
+
# Customer primary contact id
|
66
|
+
# @type: string
|
67
|
+
# @format: uuid
|
68
|
+
field :contact_id
|
69
|
+
|
70
|
+
# Customer primary contact name
|
71
|
+
# @type: string
|
72
|
+
field :contact_name
|
73
|
+
|
74
|
+
# Customer primary contact email address
|
75
|
+
# @type: string
|
76
|
+
field :contact_email
|
77
|
+
|
78
|
+
# Customer number of outstanding invoices
|
79
|
+
# @type: integer
|
80
|
+
# @format: int32
|
81
|
+
field :outstanding_invoices
|
82
|
+
|
83
|
+
# Customer total outstanding invoice amount
|
84
|
+
# @type: number
|
85
|
+
# @format: double
|
86
|
+
field :outstanding_amount
|
87
|
+
|
88
|
+
# Customer total past due amount
|
89
|
+
# @type: number
|
90
|
+
# @format: double
|
91
|
+
field :amount_past_due
|
92
|
+
|
93
|
+
belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
|
94
|
+
belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
|
95
|
+
|
96
|
+
has_many :payments, {:class_name=>"Schema::CustomerDetailsPayment", :included=>true}
|
97
|
+
|
98
|
+
end
|
@@ -0,0 +1,60 @@
|
|
1
|
+
class Schema::CustomerDetailsPayment < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
|
9
|
+
# account will share the same GroupKey value. GroupKey values cannot be changed once created.
|
10
|
+
#
|
11
|
+
# For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
12
|
+
# @type: string
|
13
|
+
# @format: uuid
|
14
|
+
field :group_key
|
15
|
+
|
16
|
+
# Unique identifier for payment
|
17
|
+
# @type: string
|
18
|
+
# @format: uuid
|
19
|
+
field :payment_id
|
20
|
+
|
21
|
+
# Unique identifier for payment applied
|
22
|
+
# @type: string
|
23
|
+
# @format: uuid
|
24
|
+
field :payment_applied_id
|
25
|
+
|
26
|
+
# Payment type
|
27
|
+
# @type: string
|
28
|
+
field :payment_type
|
29
|
+
|
30
|
+
# Unique identifier for invoice payment is associated with
|
31
|
+
# @type: string
|
32
|
+
# @format: uuid
|
33
|
+
field :invoice_id
|
34
|
+
|
35
|
+
# Invoice type payment is associated with
|
36
|
+
# @type: string
|
37
|
+
field :invoice_type_code
|
38
|
+
|
39
|
+
# Invoice reference code payment is associated with
|
40
|
+
# @type: string
|
41
|
+
field :invoice_reference_code
|
42
|
+
|
43
|
+
# Invoice total amount payment is associated with
|
44
|
+
# @type: number
|
45
|
+
# @format: double
|
46
|
+
field :invoice_total_amount
|
47
|
+
|
48
|
+
# Date payment placed
|
49
|
+
# @type: string
|
50
|
+
# @format: date-time
|
51
|
+
field :payment_date, Types::Params::DateTime
|
52
|
+
|
53
|
+
# Amount payment was made for
|
54
|
+
# @type: number
|
55
|
+
# @format: double
|
56
|
+
field :payment_amount
|
57
|
+
|
58
|
+
|
59
|
+
|
60
|
+
end
|
@@ -0,0 +1,88 @@
|
|
1
|
+
class Schema::CustomerSummary < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
|
9
|
+
# account will share the same GroupKey value. GroupKey values cannot be changed once created.
|
10
|
+
#
|
11
|
+
# For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
12
|
+
# @type: string
|
13
|
+
# @format: uuid
|
14
|
+
field :group_key
|
15
|
+
|
16
|
+
# The unique ID of this company.
|
17
|
+
# @type: string
|
18
|
+
# @format: uuid
|
19
|
+
field :company_id
|
20
|
+
|
21
|
+
# The name of the company.
|
22
|
+
# @type: string
|
23
|
+
field :company_name
|
24
|
+
|
25
|
+
# The name of the primary contact.
|
26
|
+
# @type: string
|
27
|
+
field :primary_contact
|
28
|
+
|
29
|
+
# The number of outstanding invoices for this customer.
|
30
|
+
# @type: integer
|
31
|
+
# @format: int32
|
32
|
+
field :outstanding_invoices
|
33
|
+
|
34
|
+
# The number of open invoices.
|
35
|
+
# @type: integer
|
36
|
+
# @format: int32
|
37
|
+
field :total_invoices_open
|
38
|
+
|
39
|
+
# The number of past due invoices.
|
40
|
+
# @type: integer
|
41
|
+
# @format: int32
|
42
|
+
field :total_invoices_past_due
|
43
|
+
|
44
|
+
# The number of closed invoices for this customer.
|
45
|
+
# @type: integer
|
46
|
+
# @format: int32
|
47
|
+
field :closed_invoices
|
48
|
+
|
49
|
+
# The total from collected payments.
|
50
|
+
# @type: number
|
51
|
+
# @format: double
|
52
|
+
field :amount_collected
|
53
|
+
|
54
|
+
# The total balance of outstanding invoices.
|
55
|
+
# @type: number
|
56
|
+
# @format: double
|
57
|
+
field :outstanding_amount
|
58
|
+
|
59
|
+
# The total amount past due for this customer.
|
60
|
+
# @type: number
|
61
|
+
# @format: double
|
62
|
+
field :amount_past_due
|
63
|
+
|
64
|
+
# The total value of unapplied Payments for this Customer.
|
65
|
+
# @type: number
|
66
|
+
# @format: double
|
67
|
+
field :unapplied_payments
|
68
|
+
|
69
|
+
# Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).
|
70
|
+
# @type: number
|
71
|
+
# @format: double
|
72
|
+
field :percent_of_total_ar
|
73
|
+
|
74
|
+
# Daily sales outstanding value for this Customer.
|
75
|
+
# @type: number
|
76
|
+
# @format: double
|
77
|
+
field :dso
|
78
|
+
|
79
|
+
# The date stamp for the newest Activity on this Customer.
|
80
|
+
# @type: string
|
81
|
+
# @format: date
|
82
|
+
field :newest_activity
|
83
|
+
|
84
|
+
belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
|
85
|
+
belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
|
86
|
+
|
87
|
+
|
88
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::CustomerSummaryFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::CustomerSummary", :included=>true}
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
class Schema::DailySalesOutstandingReport < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# Timeframe (month) the daily sales outstanding values are associated with
|
9
|
+
# @type: string
|
10
|
+
# @format: date-time
|
11
|
+
field :timeframe, Types::Params::DateTime
|
12
|
+
|
13
|
+
# Number of invoices the average daily sales outstanding is calculated on
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :invoice_count
|
17
|
+
|
18
|
+
# Time (in days) between an invoice was completed paid off and when the invoice was issued
|
19
|
+
# @type: number
|
20
|
+
# @format: double
|
21
|
+
field :daily_sales_outstanding
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
class Schema::DeveloperAccountSubmit < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The name of the developer.
|
9
|
+
# @type: string
|
10
|
+
field :name
|
11
|
+
|
12
|
+
# The email address of the developer.
|
13
|
+
# @type: string
|
14
|
+
# @format: email
|
15
|
+
field :email
|
16
|
+
|
17
|
+
# The company name of the developer.
|
18
|
+
# @type: string
|
19
|
+
field :company_name
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
end
|
@@ -0,0 +1,160 @@
|
|
1
|
+
class Schema::Email < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The unique ID of this record, automatically assigned by Lockstep when this record is
|
9
|
+
# added to the Lockstep platform.
|
10
|
+
# @type: string
|
11
|
+
# @format: uuid
|
12
|
+
field :email_id
|
13
|
+
|
14
|
+
# The unique ID number of this email's conversation thread.
|
15
|
+
# @type: string
|
16
|
+
# @format: uuid
|
17
|
+
field :thread_id
|
18
|
+
|
19
|
+
# The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
|
20
|
+
# account will share the same GroupKey value. GroupKey values cannot be changed once created.
|
21
|
+
#
|
22
|
+
# For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
23
|
+
# @type: string
|
24
|
+
# @format: uuid
|
25
|
+
field :group_key
|
26
|
+
|
27
|
+
# The ID number of the company that created this email.
|
28
|
+
# @type: string
|
29
|
+
# @format: uuid
|
30
|
+
field :company_id
|
31
|
+
|
32
|
+
# The email address for the sender of this email.
|
33
|
+
# @type: string
|
34
|
+
field :email_from
|
35
|
+
|
36
|
+
# The email address for the recipient(s) of this email.
|
37
|
+
# @type: string
|
38
|
+
field :email_to
|
39
|
+
|
40
|
+
# The email address for the CC recipient(s) of this email
|
41
|
+
# @type: string
|
42
|
+
field :email_cc
|
43
|
+
|
44
|
+
# The subject line of this email.
|
45
|
+
# @type: string
|
46
|
+
field :email_subject
|
47
|
+
|
48
|
+
# The body content of this email.
|
49
|
+
# @type: string
|
50
|
+
field :email_body
|
51
|
+
|
52
|
+
# The date on which this email was sent.
|
53
|
+
# @type: string
|
54
|
+
# @format: date-time
|
55
|
+
field :sent_date, Types::Params::DateTime
|
56
|
+
|
57
|
+
# A status flag indicating if this email is unread.
|
58
|
+
# @type: boolean
|
59
|
+
field :is_unread
|
60
|
+
|
61
|
+
# A status flag indicating if this email is priority status.
|
62
|
+
# @type: boolean
|
63
|
+
field :is_priority
|
64
|
+
|
65
|
+
# A status flag indicating if this email is marked as spam.
|
66
|
+
# @type: boolean
|
67
|
+
field :is_spam
|
68
|
+
|
69
|
+
# The date on which this email was created.
|
70
|
+
# @type: string
|
71
|
+
# @format: date-time
|
72
|
+
field :created, Types::Params::DateTime
|
73
|
+
|
74
|
+
# The ID number of the user who created this email.
|
75
|
+
# @type: string
|
76
|
+
# @format: uuid
|
77
|
+
field :created_user_id
|
78
|
+
|
79
|
+
# A status flag indicating if this email is to be sent.
|
80
|
+
# @type: boolean
|
81
|
+
field :to_be_sent
|
82
|
+
|
83
|
+
# The ID number of the customer that sent this email.
|
84
|
+
# @type: string
|
85
|
+
# @format: uuid
|
86
|
+
field :customer_id
|
87
|
+
|
88
|
+
# The date on which this email was received.
|
89
|
+
# @type: string
|
90
|
+
# @format: date-time
|
91
|
+
field :received_time_stamp, Types::Params::DateTime
|
92
|
+
|
93
|
+
# The date on which this email was opened.
|
94
|
+
# @type: string
|
95
|
+
# @format: date-time
|
96
|
+
field :opened_timestamp, Types::Params::DateTime
|
97
|
+
|
98
|
+
# The number of times this email was viewed.
|
99
|
+
# @type: integer
|
100
|
+
# @format: int32
|
101
|
+
field :view_count
|
102
|
+
|
103
|
+
# The AppEnrollmentId of the application that imported this record. For accounts
|
104
|
+
# with more than one financial system connected, this field identifies the originating
|
105
|
+
# financial system that produced this record. This value is null if this record
|
106
|
+
# was not loaded from an external ERP or financial system.
|
107
|
+
# @type: string
|
108
|
+
# @format: uuid
|
109
|
+
field :app_enrollment_id
|
110
|
+
|
111
|
+
# The id of the email in an external system if imported.
|
112
|
+
# @type: string
|
113
|
+
field :external_email_id
|
114
|
+
|
115
|
+
# The id of the email thread in an external system if imported.
|
116
|
+
# @type: string
|
117
|
+
field :external_thread_id
|
118
|
+
|
119
|
+
# The email address(es) for the BCC recipient(s) of this email
|
120
|
+
# @type: string
|
121
|
+
field :email_bcc
|
122
|
+
|
123
|
+
# The type message being sent (New, Reply, Forward) or null for messages not being sent.
|
124
|
+
# @type: string
|
125
|
+
field :send_type
|
126
|
+
|
127
|
+
# The date on which this email was modified.
|
128
|
+
# Email modification should only be done by internal services.
|
129
|
+
# @type: string
|
130
|
+
# @format: date-time
|
131
|
+
field :modified, Types::Params::DateTime
|
132
|
+
|
133
|
+
# The ID of the user who modified this email.
|
134
|
+
# Email modification should only be done by internal services.
|
135
|
+
# @type: string
|
136
|
+
# @format: uuid
|
137
|
+
field :modified_user_id
|
138
|
+
|
139
|
+
# If the message being sent is a reply or a forward, the id of the the email being replied to or forwarded.
|
140
|
+
# Otherwise null.
|
141
|
+
# @type: string
|
142
|
+
# @format: uuid
|
143
|
+
field :response_origin_id
|
144
|
+
|
145
|
+
# The email object associated with the response origin id.
|
146
|
+
field :response_origin
|
147
|
+
|
148
|
+
belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
|
149
|
+
belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
|
150
|
+
belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
|
151
|
+
belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
|
152
|
+
belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
|
153
|
+
belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
|
154
|
+
|
155
|
+
has_many :notes, {:class_name=>"Lockstep::Note", :included=>true, :foreign_key=>:object_key, :polymorphic=>{:table_key=>"Email"}}
|
156
|
+
has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
|
157
|
+
has_many :custom_field_definitions, {:class_name=>"Schema::CustomFieldDefinition", :included=>true}
|
158
|
+
has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
|
159
|
+
|
160
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::EmailFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::Email", :included=>true}
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
class Schema::Erp < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# Unique ID for this ERP
|
9
|
+
# @type: string
|
10
|
+
# @format: uuid
|
11
|
+
field :erp_system_id
|
12
|
+
|
13
|
+
# Name of ERP
|
14
|
+
# @type: string
|
15
|
+
field :name
|
16
|
+
|
17
|
+
# Flag to indicate if ERP is supported
|
18
|
+
# @type: boolean
|
19
|
+
field :is_supported
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::ErpFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::Erp", :included=>true}
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
class Schema::ErpInfo < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The id of the ERP's App
|
9
|
+
# @type: string
|
10
|
+
# @format: uuid
|
11
|
+
field :app_id
|
12
|
+
|
13
|
+
# The data required to store for connector access
|
14
|
+
field :data
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
class Schema::ErpInfoData < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# The authorization code returned from the first step of the OAuth2 flow
|
9
|
+
# https://oauth.net/2/grant-types/authorization-code/
|
10
|
+
# @type: string
|
11
|
+
field :auth_code
|
12
|
+
|
13
|
+
# The realm id of the account being granted permissions to access
|
14
|
+
# @type: string
|
15
|
+
field :realm_id
|
16
|
+
|
17
|
+
# The redirect uri used for step one of the OAuth2.0 flow.
|
18
|
+
# @type: string
|
19
|
+
field :redirect_uri
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
class Schema::EventInfo < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: string
|
10
|
+
field :name
|
11
|
+
|
12
|
+
|
13
|
+
field :declaring_type
|
14
|
+
|
15
|
+
|
16
|
+
field :reflected_type
|
17
|
+
|
18
|
+
|
19
|
+
field :module
|
20
|
+
|
21
|
+
|
22
|
+
# @type: boolean
|
23
|
+
field :is_collectible
|
24
|
+
|
25
|
+
|
26
|
+
# @type: integer
|
27
|
+
# @format: int32
|
28
|
+
field :metadata_token
|
29
|
+
|
30
|
+
|
31
|
+
field :member_type
|
32
|
+
|
33
|
+
|
34
|
+
field :attributes
|
35
|
+
|
36
|
+
|
37
|
+
# @type: boolean
|
38
|
+
field :is_special_name
|
39
|
+
|
40
|
+
|
41
|
+
field :add_method
|
42
|
+
|
43
|
+
|
44
|
+
field :remove_method
|
45
|
+
|
46
|
+
|
47
|
+
field :raise_method
|
48
|
+
|
49
|
+
|
50
|
+
# @type: boolean
|
51
|
+
field :is_multicast
|
52
|
+
|
53
|
+
|
54
|
+
field :event_handler_type
|
55
|
+
|
56
|
+
|
57
|
+
has_many :custom_attributes, {:class_name=>"Schema::CustomAttributeData", :included=>true}
|
58
|
+
|
59
|
+
end
|