lockstep_rails 0.3.68 → 0.3.70

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +85 -52
  3. data/app/models/lockstep/company_magic_link_summary.rb +6 -0
  4. data/app/models/lockstep/invoice.rb +8 -3
  5. data/app/models/lockstep/workflow_status.rb +8 -0
  6. data/app/platform_api/schema/application.rb +1 -0
  7. data/app/platform_api/schema/batch_sync.rb +2 -0
  8. data/app/platform_api/schema/company_magic_link_summary.rb +93 -0
  9. data/app/platform_api/schema/company_magic_link_summary_fetch_result.rb +26 -0
  10. data/app/platform_api/schema/company_sync.rb +15 -0
  11. data/app/platform_api/schema/contact_sync.rb +10 -0
  12. data/app/platform_api/schema/directory_company.rb +72 -0
  13. data/app/platform_api/schema/external_connector.rb +30 -0
  14. data/app/platform_api/schema/external_connector_auth.rb +14 -0
  15. data/app/platform_api/schema/external_connector_auth_request.rb +22 -0
  16. data/app/platform_api/schema/external_connector_token.rb +36 -0
  17. data/app/platform_api/schema/invoice_fetch_result.rb +4 -2
  18. data/app/platform_api/schema/invoice_line_sync.rb +10 -0
  19. data/app/platform_api/schema/invoice_sync.rb +15 -0
  20. data/app/platform_api/schema/journal_entry.rb +106 -0
  21. data/app/platform_api/schema/journal_entry_fetch_result.rb +26 -0
  22. data/app/platform_api/schema/journal_entry_line.rb +129 -0
  23. data/app/platform_api/schema/journal_entry_line_fetch_result.rb +26 -0
  24. data/app/platform_api/schema/journal_entry_line_sync.rb +92 -0
  25. data/app/platform_api/schema/journal_entry_sync.rb +66 -0
  26. data/app/platform_api/schema/magic_link.rb +8 -0
  27. data/app/platform_api/schema/magic_link_summary.rb +30 -0
  28. data/app/platform_api/schema/note.rb +28 -27
  29. data/app/platform_api/schema/payment_applied_sync.rb +15 -0
  30. data/app/platform_api/schema/payment_sync.rb +10 -0
  31. data/app/platform_api/schema/transaction.rb +5 -0
  32. data/app/platform_api/schema/workflow_status.rb +65 -0
  33. data/app/platform_api/schema/workflow_status_fetch_result.rb +26 -0
  34. data/app/platform_api/swagger.json +4237 -5291
  35. data/lib/lockstep_rails/version.rb +3 -2
  36. data/lib/tasks/update_api_schema.rake +5 -0
  37. metadata +20 -2
@@ -5,38 +5,38 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The unique ID of this record, automatically assigned by Lockstep when this record is
8
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
9
9
  # added to the Lockstep platform.
10
10
  # @type: string
11
11
  # @format: uuid
12
12
  field :note_id
13
13
 
14
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
- #
14
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
15
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
16
+ #
17
17
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
18
18
  # @type: string
19
19
  # @format: uuid
20
20
  field :group_key
21
21
 
22
- # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
23
- # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
24
- # `Invoice` and an `ObjectKey` value of `12345`.
25
- #
26
- # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
27
- # is connected.
28
- #
22
+ # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
23
+ # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
24
+ # `Invoice` and an `ObjectKey` value of `12345`.
25
+ #
26
+ # The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata
27
+ # is connected.
28
+ #
29
29
  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
30
30
  # @type: string
31
31
  field :table_key
32
32
 
33
- # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
34
- # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
35
- # `Invoice` and an `ObjectKey` value of `12345`.
36
- #
37
- # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
38
- # metadata is connected.
39
- #
33
+ # A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and
34
+ # `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of
35
+ # `Invoice` and an `ObjectKey` value of `12345`.
36
+ #
37
+ # The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this
38
+ # metadata is connected.
39
+ #
40
40
  # For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
41
41
  # @type: string
42
42
  # @format: uuid
@@ -50,10 +50,10 @@ end
50
50
  # @type: string
51
51
  field :note_type
52
52
 
53
- # A flag indicating whether this Note is archived (also known as hidden or deleted). When you call
54
- # [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will
55
- # be set to true.
56
- #
53
+ # A flag indicating whether this Note is archived (also known as hidden or deleted). When you call
54
+ # [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will
55
+ # be set to true.
56
+ #
57
57
  # You should avoid displaying Notes with the IsArchived field set to true in your user interface.
58
58
  # @type: boolean
59
59
  field :is_archived
@@ -63,7 +63,7 @@ end
63
63
  # @format: date-time
64
64
  field :created, Types::Params::DateTime
65
65
 
66
- # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
66
+ # The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user
67
67
  # who created this Note.
68
68
  # @type: string
69
69
  # @format: uuid
@@ -83,9 +83,9 @@ end
83
83
  # @type: string
84
84
  field :created_user_name
85
85
 
86
- # The AppEnrollmentId of the application that imported this record. For accounts
87
- # with more than one financial system connected, this field identifies the originating
88
- # financial system that produced this record. This value is null if this record
86
+ # The AppEnrollmentId of the application that imported this record. For accounts
87
+ # with more than one financial system connected, this field identifies the originating
88
+ # financial system that produced this record. This value is null if this record
89
89
  # was not loaded from an external ERP or financial system.
90
90
  # @type: string
91
91
  # @format: uuid
@@ -98,4 +98,5 @@ end
98
98
  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
99
99
  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
100
100
 
101
- end
101
+
102
+ end
@@ -8,6 +8,11 @@ end
8
8
  # Indicates what action to take when an existing object has been found during the sync process.
9
9
  field :on_match_action
10
10
 
11
+ # The unique identifier of this object in the Sage Network platform.
12
+ # @type: string
13
+ # @format: uuid
14
+ field :network_id
15
+
11
16
  # This is the primary key of the Payment Application record. For this field, you should use whatever this
12
17
  # transaction's unique identifying number is in the originating system. Search for a unique, non-changing
13
18
  # number within the originating financial system for this record.
@@ -30,6 +35,11 @@ end
30
35
  # @type: string
31
36
  field :invoice_erp_key
32
37
 
38
+ # The network id of the related Invoice.
39
+ # @type: string
40
+ # @format: uuid
41
+ field :invoice_network_id
42
+
33
43
  # This field indicates which Payment was used to provide the funds for this payment application. In this
34
44
  # field, identify the original primary key or unique ID of the Payment that was used for this payment
35
45
  # application.
@@ -42,6 +52,11 @@ end
42
52
  # @type: string
43
53
  field :payment_erp_key
44
54
 
55
+ # The network id of the related Payment.
56
+ # @type: string
57
+ # @format: uuid
58
+ field :payment_network_id
59
+
45
60
  # The entry number of this payment application. This is often a journal entry number, confirmation code,
46
61
  # or other identifying field for this payment application.
47
62
  # @type: integer
@@ -8,6 +8,11 @@ end
8
8
  # Indicates what action to take when an existing object has been found during the sync process.
9
9
  field :on_match_action
10
10
 
11
+ # The unique identifier of this object in the Sage Network platform.
12
+ # @type: string
13
+ # @format: uuid
14
+ field :network_id
15
+
11
16
  # This is the primary key of the Payment record. For this field, you should use whatever the payment's unique
12
17
  # identifying number is in the originating system. Search for a unique, non-changing number within the
13
18
  # originating financial system for this record.
@@ -25,6 +30,11 @@ end
25
30
  # @type: string
26
31
  field :company_erp_key
27
32
 
33
+ # The network id of the related Company.
34
+ # @type: string
35
+ # @format: uuid
36
+ field :company_network_id
37
+
28
38
  # The type of payment, AR Payment or AP Payment.
29
39
  #
30
40
  # Recognized PaymentType values are:
@@ -107,6 +107,11 @@ end
107
107
  # @type: boolean
108
108
  field :supports_erp_pdf_retrieval
109
109
 
110
+ # The customer associated with this transaction
111
+ # @type: string
112
+ # @format: uuid
113
+ field :transaction_customer_id
114
+
110
115
 
111
116
 
112
117
  end
@@ -0,0 +1,65 @@
1
+ class Schema::WorkflowStatus < Lockstep::ApiRecord
2
+ # ApiRecord will crash unless `id_ref` is defined
3
+ def self.id_ref
4
+ nil
5
+ end
6
+
7
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
8
+ # added to the Accounting Data Services platform.
9
+ # @type: string
10
+ # @format: uuid
11
+ field :id
12
+
13
+ # The name of the workflow status.
14
+ # @type: string
15
+ field :name
16
+
17
+ # The description explaining the use of the workflow status.
18
+ # @type: string
19
+ field :description
20
+
21
+ # The prior workflow status ID.
22
+ # @type: string
23
+ # @format: uuid
24
+ field :parent_workflow_status_id
25
+
26
+ # The category of the workflow status.
27
+ # @type: string
28
+ field :category
29
+
30
+ # The code of the workflow status.
31
+ # @type: string
32
+ field :code
33
+
34
+ # Indicates whether notes are required or not.
35
+ # @type: boolean
36
+ field :is_notes_required
37
+
38
+ # Indicates whether the status change should be reported to the ERP or not.
39
+ # @type: boolean
40
+ field :promote_to_erp
41
+
42
+ # The date that the workflow status was created.
43
+ # @type: string
44
+ # @format: date-time
45
+ field :created, Types::Params::DateTime
46
+
47
+ # The ID of the user who created the workflow status.
48
+ # @type: string
49
+ # @format: uuid
50
+ field :created_user_id
51
+
52
+ # The date that the workflow status was last modified.
53
+ # @type: string
54
+ # @format: date-time
55
+ field :modified, Types::Params::DateTime
56
+
57
+ # The ID of the user who last modified the workflow status.
58
+ # @type: string
59
+ # @format: uuid
60
+ field :modified_user_id
61
+
62
+ belongs_to :parent_workflow_status, { class_name: 'Lockstep::WorkflowStatus', primary_key: :id, foreign_key: 'parent_workflow_status_id' }
63
+ belongs_to :created_user, { class_name: 'Lockstep::User', primary_key: :user_id, foreign_key: 'created_user_id' }
64
+ belongs_to :modified_user, { class_name: 'Lockstep::User', primary_key: :user_id, foreign_key: 'modified_user_id' }
65
+ end
@@ -0,0 +1,26 @@
1
+ class Schema::WorkflowStatusFetchResult < 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::WorkflowStatus", :included=>true}
25
+
26
+ end