lockstep_rails 0.3.68 → 0.3.69

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 30bd1402599f256e2ddbf905c1a69109c6ced07b14fcca59e0e9c89aab48bf3c
4
- data.tar.gz: 314ca2d138cb0612b223857a084b259acf5d28485d30806b464fb9ca572a546a
3
+ metadata.gz: be229b382111dc6ed4c5abee4d372a09cadee483567a91dee3ed187f68e816a6
4
+ data.tar.gz: f3c19f0557e2b586cab31dff0e04c8c1846acb354adb474fa8c061a8d847dc2d
5
5
  SHA512:
6
- metadata.gz: 5f684eb6844a106cd5fae3d4cc1a6dc3dbcdb42a2977ec630087fb40a3629784fa2b085d119da69ac8cea104034df57451f3cf9ec7f4bfeafff76afef8f8772a
7
- data.tar.gz: 7b9090e647a6707cfbf5ddd7169e16552cb73dc6396fba243c5bdb5a86f594ddb099fa5759da2f26f2b0cff84dd3def96a1a3160c7061c425676eae426e0e0f6
6
+ metadata.gz: 14341156a0d680149d0fda239c5b3fa388512787e9c58f8fd5feaf1ba8afa2b578dfed511237d3d4c29f2b3ef70020d3b3ed52c61a299da093b6eca14f65f7bd
7
+ data.tar.gz: 871c9274955aa5692bc779602987f31e1fbe0d4972787b9290c610093f59db5d5d175ba2f562d59789440f4c441d33f4c64ecfd152cf320b3b4a95f3d2bbe7f6
data/README.md CHANGED
@@ -46,6 +46,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
46
46
  * Lockstep::Connection
47
47
  * Lockstep::Contact
48
48
  * Lockstep::CustomerSummary
49
+ * Lockstep::CompanyMagicLinkSummary
49
50
  * Lockstep::FeatureFlag
50
51
  * Lockstep::Invoice
51
52
  * Lockstep::InvoiceAtRiskSummary
@@ -0,0 +1,6 @@
1
+ class Lockstep::CompanyMagicLinkSummary < Lockstep::ApiRecord
2
+ self.model_name_uri = "v1/Companies/views/magic-link-summary"
3
+ self.id_ref = "company_id"
4
+ self.query_path = ""
5
+ load_schema(Schema::CompanyMagicLinkSummary)
6
+ end
@@ -79,5 +79,6 @@ end
79
79
  has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
80
80
  has_many :custom_field_definitions, {:class_name=>"Schema::CustomFieldDefinition", :included=>true}
81
81
  has_many :custom_field_values, {:class_name=>"Schema::CustomFieldValue", :included=>true}
82
+ has_many :enrollments, {:class_name=>"Schema::AppEnrollment", :included=>true}
82
83
 
83
84
  end
@@ -0,0 +1,89 @@
1
+ class Schema::CompanyMagicLinkSummary < 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 for this company
9
+ # @type: string
10
+ # @format: uuid
11
+ field :company_id
12
+
13
+ # The short name of the company.
14
+ # @type: string
15
+ field :company_name
16
+
17
+ # This field indicates the type of company. It can be one of a limited number of values:
18
+ # Company, Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor
19
+ # is identified as a CustomerVendor.
20
+ #
21
+ # * `Company` - This record represents a company that is part of the organization of the account holder.
22
+ # * `Customer` - This record represents a business entity that purchases things from the account holder.
23
+ # * `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile.
24
+ # * `Vendor` - This record represents a business entity that sells things to the account holder.
25
+ # * `Third Party` - This record represents a business entity that is neither a customer nor vendor.
26
+ # * `CustomerVendor` - Both a customer and a vendor.
27
+ # * `CompanyProfile` - Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.
28
+ # @type: string
29
+ field :company_type
30
+
31
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
32
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
33
+ #
34
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
35
+ # @type: string
36
+ # @format: uuid
37
+ field :group_key
38
+
39
+ # The name of the primary contact for this company
40
+ # @type: string
41
+ field :primary_contact_name
42
+
43
+ # The email of the primary contact for this company
44
+ # @type: string
45
+ field :primary_contact_email_address
46
+
47
+ # The total outstanding amount for this company
48
+ # @type: integer
49
+ # @format: int32
50
+ field :outstanding_amount
51
+
52
+ # The total number of open invoices for this company
53
+ # @type: integer
54
+ # @format: int32
55
+ field :total_open_invoices
56
+
57
+ # The total number of invoices that are past due for this company
58
+ # @type: integer
59
+ # @format: int32
60
+ field :past_due
61
+
62
+ # Total number of visits for all magic links sent for this company
63
+ # @type: integer
64
+ # @format: int32
65
+ field :total_visits
66
+
67
+ # Total number of sent links for this company
68
+ # @type: integer
69
+ # @format: int32
70
+ field :links_sent
71
+
72
+ # Created date of the most recent magic link made for this company
73
+ # @type: string
74
+ # @format: date-time
75
+ field :latest_magic_link_date, Types::Params::DateTime
76
+
77
+ # Id of the most recent magic link made for this company
78
+ # @type: string
79
+ # @format: uuid
80
+ field :latest_magic_link_id
81
+
82
+ # Possible statuses for a Magic Link.
83
+ field :latest_magic_link_status
84
+
85
+ belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
86
+ belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
87
+
88
+
89
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::CompanyMagicLinkSummaryFetchResult < 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::CompanyMagicLinkSummary", :included=>true}
25
+
26
+ end
@@ -0,0 +1,72 @@
1
+ class Schema::DirectoryCompany < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The field indicates the dataset type used to generate the directory company.
9
+ field :data_set
10
+
11
+ # Unique identifier of this record based on the dataset.
12
+ # <remarks>
13
+ # Examples of this would be:
14
+ # * DataSet = Siren, Identifier = string
15
+ # * DataSet = Siret, Identifier = string
16
+ # </remarks>
17
+ # @type: string
18
+ field :id
19
+
20
+ # This field indicates the type of company.
21
+ # @type: string
22
+ field :company_type
23
+
24
+ # The name of the directory company entity.
25
+ # @type: string
26
+ field :name
27
+
28
+ # Address info
29
+ # @type: string
30
+ field :address1
31
+
32
+ # Address info
33
+ # @type: string
34
+ field :address2
35
+
36
+ # Address info
37
+ # @type: string
38
+ field :address3
39
+
40
+ # Address info
41
+ # @type: string
42
+ field :city
43
+
44
+ # Address info
45
+ # @type: string
46
+ field :country
47
+
48
+ # Address info
49
+ # @type: string
50
+ field :postal_code
51
+
52
+ # Phone number
53
+ # @type: string
54
+ field :phone_number
55
+
56
+ # Email address
57
+ # @type: string
58
+ field :email_address
59
+
60
+ # The date this directory company entity was created
61
+ # @type: string
62
+ # @format: date-time
63
+ field :created_date_time, Types::Params::DateTime
64
+
65
+ # The date this directory company entity was modified
66
+ # @type: string
67
+ # @format: date-time
68
+ field :modified_date_time, Types::Params::DateTime
69
+
70
+
71
+
72
+ end
@@ -0,0 +1,30 @@
1
+ class Schema::ExternalConnector < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # External Connector ID
9
+ # @type: string
10
+ field :id
11
+
12
+ # External connector name
13
+ # @type: string
14
+ field :name
15
+
16
+ # URL to start onboarding with the given external connector
17
+ # @type: string
18
+ field :onboarding_url
19
+
20
+ # Information about the external connector.
21
+ # @type: string
22
+ field :description
23
+
24
+ # Categories external connector is associated with
25
+ # @type: array
26
+ field :categories
27
+
28
+
29
+
30
+ end
@@ -0,0 +1,14 @@
1
+ class Schema::ExternalConnectorAuth < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # The URL to open a browser with. This begins the user authentication process driven by a provider.
9
+ # @type: string
10
+ field :authentication_url
11
+
12
+
13
+
14
+ end
@@ -0,0 +1,22 @@
1
+ class Schema::ExternalConnectorAuthRequest < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # An array of scopes requested from 3rd-party provider.
9
+ # @type: array
10
+ field :scopes
11
+
12
+ # The URL the browser is redirected to after a user grants, or denies, permissions for Sage software.
13
+ # @type: string
14
+ field :redirect_url
15
+
16
+ # Opaque value that a secret will be tagged with on the service side when created
17
+ # @type: string
18
+ field :connection_context_id
19
+
20
+
21
+
22
+ end
@@ -0,0 +1,36 @@
1
+ class Schema::ExternalConnectorToken < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # ID of the token reference.
9
+ # @type: string
10
+ field :id
11
+
12
+ # When the user was authenticated.
13
+ # @type: string
14
+ # @format: date-time
15
+ field :authenticated_at, Types::Params::DateTime
16
+
17
+ # An array of scopes requested from 3rd-party external connector.
18
+ # @type: array
19
+ field :scopes
20
+
21
+ # When the token expires. This can be earlier if the token is revoked.
22
+ # @type: string
23
+ # @format: date-time
24
+ field :expires_at, Types::Params::DateTime
25
+
26
+ # External Connector ID
27
+ # @type: string
28
+ field :external_connector_id
29
+
30
+ # Connection context ID set by the product when starting onboarding with a external connector
31
+ # @type: string
32
+ field :connection_context_id
33
+
34
+
35
+
36
+ end
@@ -23,5 +23,7 @@ end
23
23
  # For more information on Invoices, see [InvoiceModel](https://developer.lockstep.io/reference/get_api-v1-invoices-id).
24
24
  # @type: array
25
25
  field :records
26
-
27
- end
26
+
27
+
28
+
29
+ end
@@ -0,0 +1,101 @@
1
+ class Schema::JournalEntry < 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
+ #
11
+ # For the ID of this record in its originating financial system, see `ErpKey`.
12
+ # @type: string
13
+ # @format: uuid
14
+ field :journal_entry_id
15
+
16
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
17
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
18
+ #
19
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
20
+ # @type: string
21
+ # @format: uuid
22
+ field :group_key
23
+
24
+ # The AppEnrollmentId of the application that imported this record. For accounts
25
+ # with more than one financial system connected, this field identifies the originating
26
+ # financial system that produced this record. This value is null if this record
27
+ # was not loaded from an external ERP or financial system.
28
+ # @type: string
29
+ # @format: uuid
30
+ field :app_enrollment_id
31
+
32
+ # The unique ID of this record as it was known in its originating financial system.
33
+ #
34
+ # If this journal entry record was imported from a financial system, it will have the value `ErpKey`
35
+ # set to the original primary key number of the record as it was known in the originating financial
36
+ # system. If this record was not imported, this value will be `null`.
37
+ #
38
+ # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
39
+ # @type: string
40
+ field :erp_key
41
+
42
+ # The ERP’s identifier for this journal entry, usually has meaning to the user.
43
+ # May be the same value of the ERP Key.
44
+ # @type: string
45
+ field :journal_id
46
+
47
+ # Possible sources for a Journal Entry.
48
+ field :source
49
+
50
+ # The UTC date and time when this journal entry was posted.
51
+ # @type: string
52
+ # @format: date-time
53
+ field :posting_date, Types::Params::DateTime
54
+
55
+ # Possible statuses for a Journal Entry.
56
+ field :status
57
+
58
+ # A brief description explaining the purpose of the journal entry.
59
+ # @type: string
60
+ field :description
61
+
62
+ # An additional comment related to the entry.
63
+ # @type: string
64
+ field :comment
65
+
66
+ # Any reference number or identifier associated with the entry, such as an invoice number or purchase order.
67
+ # @type: string
68
+ field :reference_number
69
+
70
+ # The raw posting date from the source.
71
+ # @type: string
72
+ # @format: date-time
73
+ field :source_posting_date, Types::Params::DateTime
74
+
75
+ # The date that the journal entry was created.
76
+ # @type: string
77
+ # @format: date-time
78
+ field :created, Types::Params::DateTime
79
+
80
+ # The ID of the user who created the journal entry.
81
+ # @type: string
82
+ # @format: uuid
83
+ field :created_user_id
84
+
85
+ # The date that the journal entry was last modified.
86
+ # @type: string
87
+ # @format: date-time
88
+ field :modified, Types::Params::DateTime
89
+
90
+ # The ID of the user who last modified the journal entry.
91
+ # @type: string
92
+ # @format: uuid
93
+ field :modified_user_id
94
+
95
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
96
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
97
+
98
+ has_many :lines, {:class_name=>"Schema::JournalEntryLine", :included=>true}
99
+ has_many :attachments, {:class_name=>"Schema::Attachment", :included=>true}
100
+
101
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::JournalEntryFetchResult < 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::JournalEntry", :included=>true}
25
+
26
+ end
@@ -0,0 +1,120 @@
1
+ class Schema::JournalEntryLine < 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
+ #
11
+ # For the ID of this record in its originating financial system, see `ErpKey`.
12
+ # @type: string
13
+ # @format: uuid
14
+ field :journal_entry_line_id
15
+
16
+ # The Journal Entry with which this line is associated.
17
+ # @type: string
18
+ # @format: uuid
19
+ field :journal_entry_id
20
+
21
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
22
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
23
+ #
24
+ # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
25
+ # @type: string
26
+ # @format: uuid
27
+ field :group_key
28
+
29
+ # The AppEnrollmentId of the application that imported this record. For accounts
30
+ # with more than one financial system connected, this field identifies the originating
31
+ # financial system that produced this record. This value is null if this record
32
+ # was not loaded from an external ERP or financial system.
33
+ # @type: string
34
+ # @format: uuid
35
+ field :app_enrollment_id
36
+
37
+ # The unique ID of this record as it was known in its originating financial system.
38
+ #
39
+ # If this journal entry record was imported from a financial system, it will have the value `ErpKey`
40
+ # set to the original primary key number of the record as it was known in the originating financial
41
+ # system. If this record was not imported, this value will be `null`.
42
+ #
43
+ # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
44
+ # @type: string
45
+ field :erp_key
46
+
47
+ # The Financial Account with which this line is associated.
48
+ # @type: string
49
+ # @format: uuid
50
+ field :financial_account_id
51
+
52
+ # The unique code/identifier assigned to each account in the chart of accounts.
53
+ # @type: string
54
+ field :account_number
55
+
56
+ # The name of the account.
57
+ # @type: string
58
+ field :account_name
59
+
60
+ # Debit to account.
61
+ # @type: number
62
+ # @format: double
63
+ field :debit
64
+
65
+ # Credit to account.
66
+ # @type: number
67
+ # @format: double
68
+ field :credit
69
+
70
+ # The transaction currency in which the entry is recorded, especially useful for multi-currency environments.
71
+ # @type: string
72
+ field :currency
73
+
74
+ # The base currency debit amount for the account.
75
+ # @type: number
76
+ # @format: double
77
+ field :base_debit
78
+
79
+ # The base currency credit amount for the account.
80
+ # @type: number
81
+ # @format: double
82
+ field :base_credit
83
+
84
+ # The base currency in which the entry is recorded, especially useful for multi-currency environments.
85
+ # @type: string
86
+ field :base_currency
87
+
88
+ # The ERP’s identifier for the user who recorded the journal entry line.
89
+ # @type: string
90
+ field :source_created_user
91
+
92
+ # A memo related to this line.
93
+ # @type: string
94
+ field :memo
95
+
96
+ # The date that the journal entry line was created.
97
+ # @type: string
98
+ # @format: date-time
99
+ field :created, Types::Params::DateTime
100
+
101
+ # The ID of the user who created the journal entry line.
102
+ # @type: string
103
+ # @format: uuid
104
+ field :created_user_id
105
+
106
+ # The date that the journal entry line was last modified.
107
+ # @type: string
108
+ # @format: date-time
109
+ field :modified, Types::Params::DateTime
110
+
111
+ # The ID of the user who last modified the journal entry line.
112
+ # @type: string
113
+ # @format: uuid
114
+ field :modified_user_id
115
+
116
+ belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
117
+ belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
118
+
119
+
120
+ end
@@ -81,6 +81,14 @@ end
81
81
  # To retrieve this item, specify `User` in the "Include" parameter for your query.
82
82
  field :user
83
83
 
84
+ # The number of visits to this Magic Link
85
+ # @type: integer
86
+ # @format: int32
87
+ field :visits
88
+
89
+ # Possible statuses for a Magic Link.
90
+ field :status
91
+
84
92
  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
85
93
  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
86
94
  belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
@@ -0,0 +1,30 @@
1
+ class Schema::MagicLinkSummary < Lockstep::ApiRecord
2
+
3
+ # ApiRecord will crash unless `id_ref` is defined
4
+ def self.id_ref
5
+ nil
6
+ end
7
+
8
+ # Group that the summary is for
9
+ # @type: string
10
+ # @format: uuid
11
+ field :group_key
12
+
13
+ # Total number of magic links sent
14
+ # @type: integer
15
+ # @format: int32
16
+ field :total_count
17
+
18
+ # Total number of magic links that failed to send
19
+ # @type: integer
20
+ # @format: int32
21
+ field :total_bounced
22
+
23
+ # Total number of visits across all magic links
24
+ # @type: integer
25
+ # @format: int32
26
+ field :total_visited
27
+
28
+
29
+
30
+ end