payabli 3.0.19 → 3.0.21

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.
Files changed (185) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/lib/payabli/applications/client.rb +735 -0
  4. data/lib/payabli/applications/types/create_application_request.rb +27 -0
  5. data/lib/payabli/applications/types/list_applications_applications_request.rb +13 -0
  6. data/lib/payabli/applications/types/submit_application_request.rb +13 -0
  7. data/lib/payabli/applications/types/update_application_request.rb +25 -0
  8. data/lib/payabli/applications/types/upload_application_document_request.rb +11 -0
  9. data/lib/payabli/applications/types/withdraw_application_request.rb +13 -0
  10. data/lib/payabli/boarding/client.rb +90 -0
  11. data/lib/payabli/boarding_templates/client.rb +196 -0
  12. data/lib/payabli/boarding_templates/types/list_templates_boarding_templates_request.rb +25 -0
  13. data/lib/payabli/businesses/client.rb +796 -0
  14. data/lib/payabli/businesses/types/create_business_address_request.rb +31 -0
  15. data/lib/payabli/businesses/types/deactivate_business_request.rb +13 -0
  16. data/lib/payabli/businesses/types/link_business_person_request.rb +35 -0
  17. data/lib/payabli/businesses/types/list_businesses_businesses_request.rb +25 -0
  18. data/lib/payabli/businesses/types/update_business_address_request.rb +33 -0
  19. data/lib/payabli/businesses/types/update_business_person_request.rb +35 -0
  20. data/lib/payabli/businesses/types/update_business_request.rb +63 -0
  21. data/lib/payabli/businesses/types/update_business_request_legal_structure.rb +21 -0
  22. data/lib/payabli/businesses/types/update_business_request_operating_seasons_item.rb +16 -0
  23. data/lib/payabli/client.rb +36 -1
  24. data/lib/payabli/export/client.rb +2 -3
  25. data/lib/payabli/organization/client.rb +5 -5
  26. data/lib/payabli/organizations/client.rb +214 -0
  27. data/lib/payabli/organizations/types/create_organization_organizations_request.rb +17 -0
  28. data/lib/payabli/organizations/types/list_organizations_organizations_request.rb +19 -0
  29. data/lib/payabli/organizations/types/update_organization_request.rb +27 -0
  30. data/lib/payabli/payment_methods/client.rb +254 -0
  31. data/lib/payabli/payment_methods/types/create_payment_methods_request.rb +11 -0
  32. data/lib/payabli/payment_methods/types/list_payment_methods_payment_methods_request.rb +25 -0
  33. data/lib/payabli/payment_methods/types/update_payment_method_request.rb +23 -0
  34. data/lib/payabli/paypoints/client.rb +204 -0
  35. data/lib/payabli/paypoints/types/create_paypoint_paypoints_request.rb +17 -0
  36. data/lib/payabli/paypoints/types/list_paypoints_paypoints_request.rb +19 -0
  37. data/lib/payabli/paypoints/types/update_paypoint_request.rb +29 -0
  38. data/lib/payabli/people/client.rb +428 -0
  39. data/lib/payabli/people/types/create_person_request.rb +47 -0
  40. data/lib/payabli/people/types/list_people_people_request.rb +23 -0
  41. data/lib/payabli/people/types/search_people_request.rb +15 -0
  42. data/lib/payabli/people/types/search_people_unmasked_request.rb +15 -0
  43. data/lib/payabli/people/types/update_person_request.rb +41 -0
  44. data/lib/payabli/templates/client.rb +25 -0
  45. data/lib/payabli/types/address_type.rb +16 -0
  46. data/lib/payabli/types/application.rb +46 -0
  47. data/lib/payabli/types/application_common.rb +42 -0
  48. data/lib/payabli/types/application_document.rb +26 -0
  49. data/lib/payabli/types/application_document_envelope.rb +16 -0
  50. data/lib/payabli/types/application_document_error.rb +16 -0
  51. data/lib/payabli/types/application_document_list_envelope.rb +16 -0
  52. data/lib/payabli/types/application_envelope.rb +16 -0
  53. data/lib/payabli/types/application_links.rb +12 -0
  54. data/lib/payabli/types/application_list_item.rb +52 -0
  55. data/lib/payabli/types/bank_account_services.rb +2 -2
  56. data/lib/payabli/types/boarding_warning.rb +12 -0
  57. data/lib/payabli/types/business_address.rb +28 -0
  58. data/lib/payabli/types/business_address_create.rb +28 -0
  59. data/lib/payabli/types/business_address_deleted_envelope.rb +16 -0
  60. data/lib/payabli/types/business_address_deleted_response.rb +16 -0
  61. data/lib/payabli/types/business_address_envelope.rb +16 -0
  62. data/lib/payabli/types/business_address_links.rb +12 -0
  63. data/lib/payabli/types/business_address_list_envelope.rb +16 -0
  64. data/lib/payabli/types/business_address_location.rb +15 -0
  65. data/lib/payabli/types/business_address_response.rb +32 -0
  66. data/lib/payabli/types/business_created_envelope.rb +18 -0
  67. data/lib/payabli/types/business_created_response.rb +16 -0
  68. data/lib/payabli/types/business_deactivated_envelope.rb +18 -0
  69. data/lib/payabli/types/business_deactivated_response.rb +18 -0
  70. data/lib/payabli/types/business_detail_envelope.rb +18 -0
  71. data/lib/payabli/types/business_detail_response.rb +76 -0
  72. data/lib/payabli/types/business_detail_response_legal_structure.rb +17 -0
  73. data/lib/payabli/types/business_detail_response_operating_seasons_item.rb +14 -0
  74. data/lib/payabli/types/business_links.rb +10 -0
  75. data/lib/payabli/types/business_payment_method.rb +36 -0
  76. data/lib/payabli/types/business_person_envelope.rb +16 -0
  77. data/lib/payabli/types/business_person_link.rb +42 -0
  78. data/lib/payabli/types/business_person_links.rb +14 -0
  79. data/lib/payabli/types/business_person_list_envelope.rb +16 -0
  80. data/lib/payabli/types/business_relationship_request.rb +35 -0
  81. data/lib/payabli/types/business_relationship_response.rb +36 -0
  82. data/lib/payabli/types/business_summary_response.rb +22 -0
  83. data/lib/payabli/types/business_updated_envelope.rb +18 -0
  84. data/lib/payabli/types/business_updated_response.rb +14 -0
  85. data/lib/payabli/types/case_management_money_in_service.rb +17 -0
  86. data/lib/payabli/types/case_management_money_out_service.rb +17 -0
  87. data/lib/payabli/types/certification_detail.rb +18 -0
  88. data/lib/payabli/types/create_business_request.rb +64 -0
  89. data/lib/payabli/types/create_business_request_legal_structure.rb +19 -0
  90. data/lib/payabli/types/create_business_request_operating_seasons_item.rb +14 -0
  91. data/lib/payabli/types/create_organization_all_fields.rb +30 -0
  92. data/lib/payabli/types/create_organization_with_business_reference.rb +29 -0
  93. data/lib/payabli/types/create_organization_with_inline_business.rb +29 -0
  94. data/lib/payabli/types/create_payment_method_request.rb +28 -0
  95. data/lib/payabli/types/create_payment_method_request_type.rb +11 -0
  96. data/lib/payabli/types/create_paypoint_all_fields.rb +32 -0
  97. data/lib/payabli/types/create_paypoint_with_business_reference.rb +31 -0
  98. data/lib/payabli/types/create_paypoint_with_inline_business.rb +31 -0
  99. data/lib/payabli/types/document_requirement.rb +31 -0
  100. data/lib/payabli/types/document_requirement_list_envelope.rb +16 -0
  101. data/lib/payabli/types/document_requirement_source.rb +12 -0
  102. data/lib/payabli/types/document_subject_type.rb +13 -0
  103. data/lib/payabli/types/enablement_envelope.rb +16 -0
  104. data/lib/payabli/types/enablement_result.rb +24 -0
  105. data/lib/payabli/types/enablement_service.rb +18 -0
  106. data/lib/payabli/types/get_basic_organization_response.rb +15 -0
  107. data/lib/payabli/types/identification_document_request.rb +18 -0
  108. data/lib/payabli/types/identification_document_response.rb +18 -0
  109. data/lib/payabli/types/instrument_response.rb +22 -0
  110. data/lib/payabli/types/list_applications_envelope.rb +16 -0
  111. data/lib/payabli/types/list_applications_response.rb +16 -0
  112. data/lib/payabli/types/list_businesses_envelope.rb +18 -0
  113. data/lib/payabli/types/list_businesses_response.rb +12 -0
  114. data/lib/payabli/types/list_payment_methods_envelope.rb +16 -0
  115. data/lib/payabli/types/list_payment_methods_response.rb +12 -0
  116. data/lib/payabli/types/list_paypoints_envelope.rb +16 -0
  117. data/lib/payabli/types/list_paypoints_response.rb +16 -0
  118. data/lib/payabli/types/list_people_envelope.rb +16 -0
  119. data/lib/payabli/types/list_people_response.rb +12 -0
  120. data/lib/payabli/types/list_templates_response.rb +12 -0
  121. data/lib/payabli/types/methods_list_out.rb +4 -0
  122. data/lib/payabli/types/organization_query_record.rb +23 -21
  123. data/lib/payabli/types/organization_writable_fields.rb +28 -0
  124. data/lib/payabli/types/pagination.rb +20 -0
  125. data/lib/payabli/types/payabli_credentials_pascal.rb +2 -2
  126. data/lib/payabli/types/payment_method_deactivated_envelope.rb +16 -0
  127. data/lib/payabli/types/payment_method_detail.rb +38 -0
  128. data/lib/payabli/types/payment_method_detail_envelope.rb +16 -0
  129. data/lib/payabli/types/payment_method_links.rb +12 -0
  130. data/lib/payabli/types/payment_method_owner_type.rb +12 -0
  131. data/lib/payabli/types/payment_method_result.rb +40 -0
  132. data/lib/payabli/types/payment_method_updated_envelope.rb +16 -0
  133. data/lib/payabli/types/payment_method_usage.rb +16 -0
  134. data/lib/payabli/types/payment_methods_created_envelope.rb +16 -0
  135. data/lib/payabli/types/payout_metrics.rb +16 -0
  136. data/lib/payabli/types/paypoint_created_envelope.rb +16 -0
  137. data/lib/payabli/types/paypoint_created_response.rb +22 -0
  138. data/lib/payabli/types/paypoint_detail_envelope.rb +16 -0
  139. data/lib/payabli/types/paypoint_detail_response.rb +40 -0
  140. data/lib/payabli/types/paypoint_links.rb +12 -0
  141. data/lib/payabli/types/paypoint_summary_response.rb +40 -0
  142. data/lib/payabli/types/paypoint_updated_envelope.rb +16 -0
  143. data/lib/payabli/types/paypoint_updated_response.rb +14 -0
  144. data/lib/payabli/types/paypoint_writable_fields.rb +28 -0
  145. data/lib/payabli/types/people_search_envelope.rb +16 -0
  146. data/lib/payabli/types/people_search_request.rb +12 -0
  147. data/lib/payabli/types/people_search_result_response.rb +38 -0
  148. data/lib/payabli/types/people_search_results_response.rb +14 -0
  149. data/lib/payabli/types/person_address_request.rb +22 -0
  150. data/lib/payabli/types/person_address_response.rb +22 -0
  151. data/lib/payabli/types/person_address_type.rb +17 -0
  152. data/lib/payabli/types/person_detail_envelope.rb +18 -0
  153. data/lib/payabli/types/person_detail_response.rb +56 -0
  154. data/lib/payabli/types/person_links.rb +12 -0
  155. data/lib/payabli/types/person_summary_response.rb +24 -0
  156. data/lib/payabli/types/person_type.rb +16 -0
  157. data/lib/payabli/types/person_updated_envelope.rb +16 -0
  158. data/lib/payabli/types/person_updated_response.rb +14 -0
  159. data/lib/payabli/types/processing_metrics.rb +30 -0
  160. data/lib/payabli/types/representative_input.rb +20 -0
  161. data/lib/payabli/types/representative_response.rb +20 -0
  162. data/lib/payabli/types/requested_services.rb +13 -0
  163. data/lib/payabli/types/signature_type.rb +13 -0
  164. data/lib/payabli/types/status_history_entry.rb +22 -0
  165. data/lib/payabli/types/status_history_envelope.rb +16 -0
  166. data/lib/payabli/types/status_history_result.rb +12 -0
  167. data/lib/payabli/types/submit_application_error.rb +16 -0
  168. data/lib/payabli/types/submit_signer.rb +32 -0
  169. data/lib/payabli/types/template.rb +38 -0
  170. data/lib/payabli/types/template_status.rb +12 -0
  171. data/lib/payabli/types/template_version.rb +79 -0
  172. data/lib/payabli/types/templates_summary.rb +14 -0
  173. data/lib/payabli/types/transition_result.rb +14 -0
  174. data/lib/payabli/types/transition_result_envelope.rb +16 -0
  175. data/lib/payabli/types/underwriting_mode.rb +13 -0
  176. data/lib/payabli/types/validation_missing_field.rb +14 -0
  177. data/lib/payabli/types/validation_result.rb +14 -0
  178. data/lib/payabli/types/validation_result_envelope.rb +16 -0
  179. data/lib/payabli/types/validation_section.rb +12 -0
  180. data/lib/payabli/types/validation_sections.rb +16 -0
  181. data/lib/payabli/version.rb +1 -1
  182. data/lib/payabli.rb +173 -4
  183. data/reference.md +5643 -221
  184. data/wiremock/wiremock-mappings.json +1727 -8
  185. metadata +171 -2
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # A boarding application (request), as returned when you create, get, or update one.
6
+ class Application < Internal::Types::Model
7
+ field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
8
+
9
+ field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
10
+
11
+ field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
12
+
13
+ field :parent, -> { String }, optional: true, nullable: false
14
+
15
+ field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "parentOrgName"
16
+
17
+ field :entity_type, -> { String }, optional: true, nullable: false, api_name: "entityType"
18
+
19
+ field :dba_name, -> { String }, optional: true, nullable: false, api_name: "dbaName"
20
+
21
+ field :application_status, -> { String }, optional: false, nullable: false, api_name: "applicationStatus"
22
+
23
+ field :application_status_code, -> { Integer }, optional: false, nullable: false, api_name: "applicationStatusCode"
24
+
25
+ field :allowed_actions, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedActions"
26
+
27
+ field :request_template, -> { String }, optional: true, nullable: false, api_name: "requestTemplate"
28
+
29
+ field :services, -> { Payabli::Types::RequestedServices }, optional: true, nullable: false
30
+
31
+ field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
32
+
33
+ field :representatives, -> { Internal::Types::Array[Payabli::Types::RepresentativeResponse] }, optional: true, nullable: false
34
+
35
+ field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
36
+
37
+ field :submitted_at, -> { String }, optional: true, nullable: false, api_name: "submittedAt"
38
+
39
+ field :links, -> { Payabli::Types::ApplicationLinks }, optional: false, nullable: false, api_name: "_links"
40
+
41
+ field :paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "paypointReference"
42
+
43
+ field :paypoint_status, -> { String }, optional: false, nullable: false, api_name: "paypointStatus"
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Fields shared by a boarding application in single-record and list responses.
6
+ class ApplicationCommon < Internal::Types::Model
7
+ field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
8
+
9
+ field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
10
+
11
+ field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
12
+
13
+ field :parent, -> { String }, optional: true, nullable: false
14
+
15
+ field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "parentOrgName"
16
+
17
+ field :entity_type, -> { String }, optional: true, nullable: false, api_name: "entityType"
18
+
19
+ field :dba_name, -> { String }, optional: true, nullable: false, api_name: "dbaName"
20
+
21
+ field :application_status, -> { String }, optional: false, nullable: false, api_name: "applicationStatus"
22
+
23
+ field :application_status_code, -> { Integer }, optional: false, nullable: false, api_name: "applicationStatusCode"
24
+
25
+ field :allowed_actions, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedActions"
26
+
27
+ field :request_template, -> { String }, optional: true, nullable: false, api_name: "requestTemplate"
28
+
29
+ field :services, -> { Payabli::Types::RequestedServices }, optional: true, nullable: false
30
+
31
+ field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
32
+
33
+ field :representatives, -> { Internal::Types::Array[Payabli::Types::RepresentativeResponse] }, optional: true, nullable: false
34
+
35
+ field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
36
+
37
+ field :submitted_at, -> { String }, optional: true, nullable: false, api_name: "submittedAt"
38
+
39
+ field :links, -> { Payabli::Types::ApplicationLinks }, optional: false, nullable: false, api_name: "_links"
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # A document uploaded to an application.
6
+ class ApplicationDocument < Internal::Types::Model
7
+ field :document_reference, -> { String }, optional: false, nullable: false, api_name: "documentReference"
8
+
9
+ field :kind, -> { String }, optional: false, nullable: false
10
+
11
+ field :subject_type, -> { Payabli::Types::DocumentSubjectType }, optional: false, nullable: false, api_name: "subjectType"
12
+
13
+ field :person_reference, -> { String }, optional: false, nullable: true, api_name: "personReference"
14
+
15
+ field :field_path, -> { String }, optional: false, nullable: false, api_name: "fieldPath"
16
+
17
+ field :file_name, -> { String }, optional: false, nullable: false, api_name: "fileName"
18
+
19
+ field :mime_type, -> { String }, optional: false, nullable: false, api_name: "mimeType"
20
+
21
+ field :file_size_bytes, -> { Integer }, optional: false, nullable: false, api_name: "fileSizeBytes"
22
+
23
+ field :uploaded_at, -> { String }, optional: false, nullable: false, api_name: "uploadedAt"
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping an uploaded document.
6
+ class ApplicationDocumentEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::ApplicationDocument }, optional: false, nullable: false
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # The error body when a document request fails.
6
+ class ApplicationDocumentError < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :error, -> { String }, optional: false, nullable: false
10
+
11
+ field :message, -> { String }, optional: false, nullable: false
12
+
13
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping an application's documents.
6
+ class ApplicationDocumentListEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Internal::Types::Array[Payabli::Types::ApplicationDocument] }, optional: false, nullable: false
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping an application.
6
+ class ApplicationEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::Application }, optional: false, nullable: true
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Hypermedia links for an application resource.
6
+ class ApplicationLinks < Internal::Types::Model
7
+ field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
8
+
9
+ field :business, -> { String }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # A boarding application (request), as returned in a list of applications.
6
+ class ApplicationListItem < Internal::Types::Model
7
+ field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
8
+
9
+ field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
10
+
11
+ field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
12
+
13
+ field :parent, -> { String }, optional: true, nullable: false
14
+
15
+ field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "parentOrgName"
16
+
17
+ field :entity_type, -> { String }, optional: true, nullable: false, api_name: "entityType"
18
+
19
+ field :dba_name, -> { String }, optional: true, nullable: false, api_name: "dbaName"
20
+
21
+ field :application_status, -> { String }, optional: false, nullable: false, api_name: "applicationStatus"
22
+
23
+ field :application_status_code, -> { Integer }, optional: false, nullable: false, api_name: "applicationStatusCode"
24
+
25
+ field :allowed_actions, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedActions"
26
+
27
+ field :request_template, -> { String }, optional: true, nullable: false, api_name: "requestTemplate"
28
+
29
+ field :services, -> { Payabli::Types::RequestedServices }, optional: true, nullable: false
30
+
31
+ field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
32
+
33
+ field :representatives, -> { Internal::Types::Array[Payabli::Types::RepresentativeResponse] }, optional: true, nullable: false
34
+
35
+ field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
36
+
37
+ field :submitted_at, -> { String }, optional: true, nullable: false, api_name: "submittedAt"
38
+
39
+ field :links, -> { Payabli::Types::ApplicationLinks }, optional: false, nullable: false, api_name: "_links"
40
+
41
+ field :paypoint_name, -> { String }, optional: false, nullable: true, api_name: "paypointName"
42
+
43
+ field :paypoint_legal_name, -> { String }, optional: false, nullable: true, api_name: "paypointLegalName"
44
+
45
+ field :ein, -> { String }, optional: false, nullable: true
46
+
47
+ field :primary_owner_name, -> { String }, optional: false, nullable: true, api_name: "primaryOwnerName"
48
+
49
+ field :primary_owner_reference, -> { String }, optional: false, nullable: true, api_name: "primaryOwnerReference"
50
+ end
51
+ end
52
+ end
@@ -4,9 +4,9 @@ module Payabli
4
4
  module Types
5
5
  # The Pay In and Pay Out services the bank account applies to. Include at least one entry across the two lists.
6
6
  class BankAccountServices < Internal::Types::Model
7
- field :money_in, -> { Internal::Types::Array[Payabli::Types::MoneyInService] }, optional: true, nullable: false, api_name: "moneyIn"
7
+ field :money_in, -> { Internal::Types::Array[Payabli::Types::CaseManagementMoneyInService] }, optional: true, nullable: false, api_name: "moneyIn"
8
8
 
9
- field :money_out, -> { Internal::Types::Array[Payabli::Types::MoneyOutService] }, optional: true, nullable: false, api_name: "moneyOut"
9
+ field :money_out, -> { Internal::Types::Array[Payabli::Types::CaseManagementMoneyOutService] }, optional: true, nullable: false, api_name: "moneyOut"
10
10
  end
11
11
  end
12
12
  end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # A non-blocking warning returned alongside a successful response.
6
+ class BoardingWarning < Internal::Types::Model
7
+ field :code, -> { String }, optional: true, nullable: false
8
+
9
+ field :message, -> { String }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # An address associated with a business.
6
+ class BusinessAddress < Internal::Types::Model
7
+ field :type, -> { Payabli::Types::AddressType }, optional: true, nullable: false
8
+
9
+ field :location, -> { Payabli::Types::BusinessAddressLocation }, optional: true, nullable: false
10
+
11
+ field :address_line_1, -> { String }, optional: true, nullable: false, api_name: "addressLine1"
12
+
13
+ field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
14
+
15
+ field :city_locality, -> { String }, optional: true, nullable: false, api_name: "cityLocality"
16
+
17
+ field :state_province, -> { String }, optional: true, nullable: false, api_name: "stateProvince"
18
+
19
+ field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
20
+
21
+ field :country, -> { String }, optional: true, nullable: false
22
+
23
+ field :floor, -> { String }, optional: true, nullable: false
24
+
25
+ field :suite_apart_number, -> { String }, optional: true, nullable: false, api_name: "suiteApartNumber"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # An address sent when creating a business. `country` is required.
6
+ class BusinessAddressCreate < Internal::Types::Model
7
+ field :type, -> { Payabli::Types::AddressType }, optional: true, nullable: false
8
+
9
+ field :location, -> { Payabli::Types::BusinessAddressLocation }, optional: true, nullable: false
10
+
11
+ field :address_line_1, -> { String }, optional: true, nullable: false, api_name: "addressLine1"
12
+
13
+ field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
14
+
15
+ field :city_locality, -> { String }, optional: true, nullable: false, api_name: "cityLocality"
16
+
17
+ field :state_province, -> { String }, optional: true, nullable: false, api_name: "stateProvince"
18
+
19
+ field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
20
+
21
+ field :country, -> { String }, optional: true, nullable: false
22
+
23
+ field :floor, -> { String }, optional: true, nullable: false
24
+
25
+ field :suite_apart_number, -> { String }, optional: true, nullable: false, api_name: "suiteApartNumber"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a removed business address.
6
+ class BusinessAddressDeletedEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::BusinessAddressDeletedResponse }, optional: false, nullable: true
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # The result of removing a business address.
6
+ class BusinessAddressDeletedResponse < Internal::Types::Model
7
+ field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
8
+
9
+ field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
10
+
11
+ field :business_address_reference, -> { String }, optional: false, nullable: false, api_name: "businessAddressReference"
12
+
13
+ field :deleted_at, -> { String }, optional: false, nullable: false, api_name: "deletedAt"
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a business address.
6
+ class BusinessAddressEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::BusinessAddressResponse }, optional: false, nullable: true
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Hypermedia links for a business address resource.
6
+ class BusinessAddressLinks < Internal::Types::Model
7
+ field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
8
+
9
+ field :business, -> { String }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a business's addresses.
6
+ class BusinessAddressListEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Internal::Types::Array[Payabli::Types::BusinessAddressResponse] }, optional: false, nullable: true
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ module BusinessAddressLocation
6
+ extend Payabli::Internal::Types::Enum
7
+
8
+ OFFICE = "office"
9
+ WAREHOUSE = "warehouse"
10
+ RETAIL = "retail"
11
+ HOME = "home"
12
+ OTHER = "other"
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # A business address, returned by the address endpoints.
6
+ class BusinessAddressResponse < Internal::Types::Model
7
+ field :links, -> { Payabli::Types::BusinessAddressLinks }, optional: false, nullable: false, api_name: "_links"
8
+
9
+ field :business_address_reference, -> { String }, optional: false, nullable: false, api_name: "businessAddressReference"
10
+
11
+ field :type, -> { Payabli::Types::AddressType }, optional: false, nullable: false
12
+
13
+ field :location, -> { Payabli::Types::BusinessAddressLocation }, optional: false, nullable: false
14
+
15
+ field :address_line_1, -> { String }, optional: false, nullable: false, api_name: "addressLine1"
16
+
17
+ field :address_line_2, -> { String }, optional: false, nullable: true, api_name: "addressLine2"
18
+
19
+ field :city_locality, -> { String }, optional: false, nullable: false, api_name: "cityLocality"
20
+
21
+ field :state_province, -> { String }, optional: false, nullable: false, api_name: "stateProvince"
22
+
23
+ field :postal_code, -> { String }, optional: false, nullable: false, api_name: "postalCode"
24
+
25
+ field :country, -> { String }, optional: false, nullable: false
26
+
27
+ field :floor, -> { String }, optional: false, nullable: true
28
+
29
+ field :suite_apart_number, -> { String }, optional: false, nullable: true, api_name: "suiteApartNumber"
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a created business.
6
+ class BusinessCreatedEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::BusinessCreatedResponse }, optional: false, nullable: true
14
+
15
+ field :warnings, -> { Internal::Types::Array[Payabli::Types::BoardingWarning] }, optional: false, nullable: true
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # The reference and initial status of a newly created business.
6
+ class BusinessCreatedResponse < Internal::Types::Model
7
+ field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
8
+
9
+ field :business_status, -> { String }, optional: false, nullable: false, api_name: "businessStatus"
10
+
11
+ field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
12
+
13
+ field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a deactivated business.
6
+ class BusinessDeactivatedEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::BusinessDeactivatedResponse }, optional: false, nullable: true
14
+
15
+ field :warnings, -> { Internal::Types::Array[Payabli::Types::BoardingWarning] }, optional: false, nullable: true
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # The result of deactivating a business.
6
+ class BusinessDeactivatedResponse < Internal::Types::Model
7
+ field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
8
+
9
+ field :business_status, -> { String }, optional: false, nullable: false, api_name: "businessStatus"
10
+
11
+ field :deactivated_at, -> { String }, optional: false, nullable: false, api_name: "deactivatedAt"
12
+
13
+ field :reason, -> { String }, optional: false, nullable: true
14
+
15
+ field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # Standard boarding response envelope wrapping a business detail.
6
+ class BusinessDetailEnvelope < Internal::Types::Model
7
+ field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+
9
+ field :message, -> { String }, optional: false, nullable: true
10
+
11
+ field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
12
+
13
+ field :data, -> { Payabli::Types::BusinessDetailResponse }, optional: false, nullable: true
14
+
15
+ field :warnings, -> { Internal::Types::Array[Payabli::Types::BoardingWarning] }, optional: false, nullable: true
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,76 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Payabli
4
+ module Types
5
+ # The full detail of a business. Sensitive fields are masked unless read from the unmasked endpoint.
6
+ class BusinessDetailResponse < Internal::Types::Model
7
+ field :business_uuid, -> { String }, optional: false, nullable: false, api_name: "businessUuid"
8
+
9
+ field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
10
+
11
+ field :legal_name, -> { String }, optional: false, nullable: true, api_name: "legalName"
12
+
13
+ field :description, -> { String }, optional: true, nullable: false
14
+
15
+ field :legal_structure, -> { Payabli::Types::BusinessDetailResponseLegalStructure }, optional: false, nullable: true, api_name: "legalStructure"
16
+
17
+ field :stock_symbol, -> { String }, optional: true, nullable: false, api_name: "stockSymbol"
18
+
19
+ field :incorporation_state, -> { String }, optional: false, nullable: true, api_name: "incorporationState"
20
+
21
+ field :tax_id_country, -> { String }, optional: false, nullable: true, api_name: "taxIdCountry"
22
+
23
+ field :established_date, -> { String }, optional: true, nullable: false, api_name: "establishedDate"
24
+
25
+ field :number_of_employees, -> { Integer }, optional: true, nullable: false, api_name: "numberOfEmployees"
26
+
27
+ field :annual_revenue, -> { Integer }, optional: true, nullable: false, api_name: "annualRevenue"
28
+
29
+ field :website, -> { String }, optional: true, nullable: false
30
+
31
+ field :merchant_cat_code, -> { String }, optional: true, nullable: false, api_name: "merchantCatCode"
32
+
33
+ field :timezone, -> { String }, optional: true, nullable: false
34
+
35
+ field :phone, -> { Internal::Types::Array[String] }, optional: true, nullable: false
36
+
37
+ field :emails, -> { Internal::Types::Array[String] }, optional: true, nullable: false
38
+
39
+ field :operating_seasons, -> { Internal::Types::Array[Payabli::Types::BusinessDetailResponseOperatingSeasonsItem] }, optional: true, nullable: false, api_name: "operatingSeasons"
40
+
41
+ field :address_details, -> { Internal::Types::Array[Payabli::Types::BusinessAddress] }, optional: true, nullable: false, api_name: "addressDetails"
42
+
43
+ field :payment_methods, -> { Internal::Types::Array[Payabli::Types::BusinessPaymentMethod] }, optional: true, nullable: false, api_name: "paymentMethods"
44
+
45
+ field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
46
+
47
+ field :is_foreign_owned, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isForeignOwned"
48
+
49
+ field :is_tax_exempt, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isTaxExempt"
50
+
51
+ field :tax_exempt_classification, -> { String }, optional: false, nullable: true, api_name: "taxExemptClassification"
52
+
53
+ field :processing_metrics, -> { Payabli::Types::ProcessingMetrics }, optional: true, nullable: false, api_name: "processingMetrics"
54
+
55
+ field :payout_metrics, -> { Payabli::Types::PayoutMetrics }, optional: true, nullable: false, api_name: "payoutMetrics"
56
+
57
+ field :license, -> { String }, optional: false, nullable: true
58
+
59
+ field :license_state, -> { String }, optional: false, nullable: true, api_name: "licenseState"
60
+
61
+ field :tax_reference, -> { String }, optional: false, nullable: true, api_name: "taxReference"
62
+
63
+ field :business_status, -> { String }, optional: false, nullable: false, api_name: "businessStatus"
64
+
65
+ field :parent_reference, -> { String }, optional: false, nullable: true, api_name: "parentReference"
66
+
67
+ field :certification_details, -> { Internal::Types::Array[Payabli::Types::CertificationDetail] }, optional: true, nullable: false, api_name: "certificationDetails"
68
+
69
+ field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
70
+
71
+ field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
72
+
73
+ field :links, -> { Payabli::Types::BusinessLinks }, optional: false, nullable: false, api_name: "_links"
74
+ end
75
+ end
76
+ end