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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +3 -3
- data/lib/payabli/applications/client.rb +735 -0
- data/lib/payabli/applications/types/create_application_request.rb +27 -0
- data/lib/payabli/applications/types/list_applications_applications_request.rb +13 -0
- data/lib/payabli/applications/types/submit_application_request.rb +13 -0
- data/lib/payabli/applications/types/update_application_request.rb +25 -0
- data/lib/payabli/applications/types/upload_application_document_request.rb +11 -0
- data/lib/payabli/applications/types/withdraw_application_request.rb +13 -0
- data/lib/payabli/boarding/client.rb +90 -0
- data/lib/payabli/boarding_templates/client.rb +196 -0
- data/lib/payabli/boarding_templates/types/list_templates_boarding_templates_request.rb +25 -0
- data/lib/payabli/businesses/client.rb +796 -0
- data/lib/payabli/businesses/types/create_business_address_request.rb +31 -0
- data/lib/payabli/businesses/types/deactivate_business_request.rb +13 -0
- data/lib/payabli/businesses/types/link_business_person_request.rb +35 -0
- data/lib/payabli/businesses/types/list_businesses_businesses_request.rb +25 -0
- data/lib/payabli/businesses/types/update_business_address_request.rb +33 -0
- data/lib/payabli/businesses/types/update_business_person_request.rb +35 -0
- data/lib/payabli/businesses/types/update_business_request.rb +63 -0
- data/lib/payabli/businesses/types/update_business_request_legal_structure.rb +21 -0
- data/lib/payabli/businesses/types/update_business_request_operating_seasons_item.rb +16 -0
- data/lib/payabli/client.rb +36 -1
- data/lib/payabli/export/client.rb +2 -3
- data/lib/payabli/organization/client.rb +5 -5
- data/lib/payabli/organizations/client.rb +214 -0
- data/lib/payabli/organizations/types/create_organization_organizations_request.rb +17 -0
- data/lib/payabli/organizations/types/list_organizations_organizations_request.rb +19 -0
- data/lib/payabli/organizations/types/update_organization_request.rb +27 -0
- data/lib/payabli/payment_methods/client.rb +254 -0
- data/lib/payabli/payment_methods/types/create_payment_methods_request.rb +11 -0
- data/lib/payabli/payment_methods/types/list_payment_methods_payment_methods_request.rb +25 -0
- data/lib/payabli/payment_methods/types/update_payment_method_request.rb +23 -0
- data/lib/payabli/paypoints/client.rb +204 -0
- data/lib/payabli/paypoints/types/create_paypoint_paypoints_request.rb +17 -0
- data/lib/payabli/paypoints/types/list_paypoints_paypoints_request.rb +19 -0
- data/lib/payabli/paypoints/types/update_paypoint_request.rb +29 -0
- data/lib/payabli/people/client.rb +428 -0
- data/lib/payabli/people/types/create_person_request.rb +47 -0
- data/lib/payabli/people/types/list_people_people_request.rb +23 -0
- data/lib/payabli/people/types/search_people_request.rb +15 -0
- data/lib/payabli/people/types/search_people_unmasked_request.rb +15 -0
- data/lib/payabli/people/types/update_person_request.rb +41 -0
- data/lib/payabli/templates/client.rb +25 -0
- data/lib/payabli/types/address_type.rb +16 -0
- data/lib/payabli/types/application.rb +46 -0
- data/lib/payabli/types/application_common.rb +42 -0
- data/lib/payabli/types/application_document.rb +26 -0
- data/lib/payabli/types/application_document_envelope.rb +16 -0
- data/lib/payabli/types/application_document_error.rb +16 -0
- data/lib/payabli/types/application_document_list_envelope.rb +16 -0
- data/lib/payabli/types/application_envelope.rb +16 -0
- data/lib/payabli/types/application_links.rb +12 -0
- data/lib/payabli/types/application_list_item.rb +52 -0
- data/lib/payabli/types/bank_account_services.rb +2 -2
- data/lib/payabli/types/boarding_warning.rb +12 -0
- data/lib/payabli/types/business_address.rb +28 -0
- data/lib/payabli/types/business_address_create.rb +28 -0
- data/lib/payabli/types/business_address_deleted_envelope.rb +16 -0
- data/lib/payabli/types/business_address_deleted_response.rb +16 -0
- data/lib/payabli/types/business_address_envelope.rb +16 -0
- data/lib/payabli/types/business_address_links.rb +12 -0
- data/lib/payabli/types/business_address_list_envelope.rb +16 -0
- data/lib/payabli/types/business_address_location.rb +15 -0
- data/lib/payabli/types/business_address_response.rb +32 -0
- data/lib/payabli/types/business_created_envelope.rb +18 -0
- data/lib/payabli/types/business_created_response.rb +16 -0
- data/lib/payabli/types/business_deactivated_envelope.rb +18 -0
- data/lib/payabli/types/business_deactivated_response.rb +18 -0
- data/lib/payabli/types/business_detail_envelope.rb +18 -0
- data/lib/payabli/types/business_detail_response.rb +76 -0
- data/lib/payabli/types/business_detail_response_legal_structure.rb +17 -0
- data/lib/payabli/types/business_detail_response_operating_seasons_item.rb +14 -0
- data/lib/payabli/types/business_links.rb +10 -0
- data/lib/payabli/types/business_payment_method.rb +36 -0
- data/lib/payabli/types/business_person_envelope.rb +16 -0
- data/lib/payabli/types/business_person_link.rb +42 -0
- data/lib/payabli/types/business_person_links.rb +14 -0
- data/lib/payabli/types/business_person_list_envelope.rb +16 -0
- data/lib/payabli/types/business_relationship_request.rb +35 -0
- data/lib/payabli/types/business_relationship_response.rb +36 -0
- data/lib/payabli/types/business_summary_response.rb +22 -0
- data/lib/payabli/types/business_updated_envelope.rb +18 -0
- data/lib/payabli/types/business_updated_response.rb +14 -0
- data/lib/payabli/types/case_management_money_in_service.rb +17 -0
- data/lib/payabli/types/case_management_money_out_service.rb +17 -0
- data/lib/payabli/types/certification_detail.rb +18 -0
- data/lib/payabli/types/create_business_request.rb +64 -0
- data/lib/payabli/types/create_business_request_legal_structure.rb +19 -0
- data/lib/payabli/types/create_business_request_operating_seasons_item.rb +14 -0
- data/lib/payabli/types/create_organization_all_fields.rb +30 -0
- data/lib/payabli/types/create_organization_with_business_reference.rb +29 -0
- data/lib/payabli/types/create_organization_with_inline_business.rb +29 -0
- data/lib/payabli/types/create_payment_method_request.rb +28 -0
- data/lib/payabli/types/create_payment_method_request_type.rb +11 -0
- data/lib/payabli/types/create_paypoint_all_fields.rb +32 -0
- data/lib/payabli/types/create_paypoint_with_business_reference.rb +31 -0
- data/lib/payabli/types/create_paypoint_with_inline_business.rb +31 -0
- data/lib/payabli/types/document_requirement.rb +31 -0
- data/lib/payabli/types/document_requirement_list_envelope.rb +16 -0
- data/lib/payabli/types/document_requirement_source.rb +12 -0
- data/lib/payabli/types/document_subject_type.rb +13 -0
- data/lib/payabli/types/enablement_envelope.rb +16 -0
- data/lib/payabli/types/enablement_result.rb +24 -0
- data/lib/payabli/types/enablement_service.rb +18 -0
- data/lib/payabli/types/get_basic_organization_response.rb +15 -0
- data/lib/payabli/types/identification_document_request.rb +18 -0
- data/lib/payabli/types/identification_document_response.rb +18 -0
- data/lib/payabli/types/instrument_response.rb +22 -0
- data/lib/payabli/types/list_applications_envelope.rb +16 -0
- data/lib/payabli/types/list_applications_response.rb +16 -0
- data/lib/payabli/types/list_businesses_envelope.rb +18 -0
- data/lib/payabli/types/list_businesses_response.rb +12 -0
- data/lib/payabli/types/list_payment_methods_envelope.rb +16 -0
- data/lib/payabli/types/list_payment_methods_response.rb +12 -0
- data/lib/payabli/types/list_paypoints_envelope.rb +16 -0
- data/lib/payabli/types/list_paypoints_response.rb +16 -0
- data/lib/payabli/types/list_people_envelope.rb +16 -0
- data/lib/payabli/types/list_people_response.rb +12 -0
- data/lib/payabli/types/list_templates_response.rb +12 -0
- data/lib/payabli/types/methods_list_out.rb +4 -0
- data/lib/payabli/types/organization_query_record.rb +23 -21
- data/lib/payabli/types/organization_writable_fields.rb +28 -0
- data/lib/payabli/types/pagination.rb +20 -0
- data/lib/payabli/types/payabli_credentials_pascal.rb +2 -2
- data/lib/payabli/types/payment_method_deactivated_envelope.rb +16 -0
- data/lib/payabli/types/payment_method_detail.rb +38 -0
- data/lib/payabli/types/payment_method_detail_envelope.rb +16 -0
- data/lib/payabli/types/payment_method_links.rb +12 -0
- data/lib/payabli/types/payment_method_owner_type.rb +12 -0
- data/lib/payabli/types/payment_method_result.rb +40 -0
- data/lib/payabli/types/payment_method_updated_envelope.rb +16 -0
- data/lib/payabli/types/payment_method_usage.rb +16 -0
- data/lib/payabli/types/payment_methods_created_envelope.rb +16 -0
- data/lib/payabli/types/payout_metrics.rb +16 -0
- data/lib/payabli/types/paypoint_created_envelope.rb +16 -0
- data/lib/payabli/types/paypoint_created_response.rb +22 -0
- data/lib/payabli/types/paypoint_detail_envelope.rb +16 -0
- data/lib/payabli/types/paypoint_detail_response.rb +40 -0
- data/lib/payabli/types/paypoint_links.rb +12 -0
- data/lib/payabli/types/paypoint_summary_response.rb +40 -0
- data/lib/payabli/types/paypoint_updated_envelope.rb +16 -0
- data/lib/payabli/types/paypoint_updated_response.rb +14 -0
- data/lib/payabli/types/paypoint_writable_fields.rb +28 -0
- data/lib/payabli/types/people_search_envelope.rb +16 -0
- data/lib/payabli/types/people_search_request.rb +12 -0
- data/lib/payabli/types/people_search_result_response.rb +38 -0
- data/lib/payabli/types/people_search_results_response.rb +14 -0
- data/lib/payabli/types/person_address_request.rb +22 -0
- data/lib/payabli/types/person_address_response.rb +22 -0
- data/lib/payabli/types/person_address_type.rb +17 -0
- data/lib/payabli/types/person_detail_envelope.rb +18 -0
- data/lib/payabli/types/person_detail_response.rb +56 -0
- data/lib/payabli/types/person_links.rb +12 -0
- data/lib/payabli/types/person_summary_response.rb +24 -0
- data/lib/payabli/types/person_type.rb +16 -0
- data/lib/payabli/types/person_updated_envelope.rb +16 -0
- data/lib/payabli/types/person_updated_response.rb +14 -0
- data/lib/payabli/types/processing_metrics.rb +30 -0
- data/lib/payabli/types/representative_input.rb +20 -0
- data/lib/payabli/types/representative_response.rb +20 -0
- data/lib/payabli/types/requested_services.rb +13 -0
- data/lib/payabli/types/signature_type.rb +13 -0
- data/lib/payabli/types/status_history_entry.rb +22 -0
- data/lib/payabli/types/status_history_envelope.rb +16 -0
- data/lib/payabli/types/status_history_result.rb +12 -0
- data/lib/payabli/types/submit_application_error.rb +16 -0
- data/lib/payabli/types/submit_signer.rb +32 -0
- data/lib/payabli/types/template.rb +38 -0
- data/lib/payabli/types/template_status.rb +12 -0
- data/lib/payabli/types/template_version.rb +79 -0
- data/lib/payabli/types/templates_summary.rb +14 -0
- data/lib/payabli/types/transition_result.rb +14 -0
- data/lib/payabli/types/transition_result_envelope.rb +16 -0
- data/lib/payabli/types/underwriting_mode.rb +13 -0
- data/lib/payabli/types/validation_missing_field.rb +14 -0
- data/lib/payabli/types/validation_result.rb +14 -0
- data/lib/payabli/types/validation_result_envelope.rb +16 -0
- data/lib/payabli/types/validation_section.rb +12 -0
- data/lib/payabli/types/validation_sections.rb +16 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +173 -4
- data/reference.md +5643 -221
- data/wiremock/wiremock-mappings.json +1727 -8
- metadata +171 -2
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Create a paypoint under an existing business. Provide `businessReference` plus `doingBusinessAs`; all other fields
|
|
6
|
+
# are optional.
|
|
7
|
+
class CreatePaypointWithBusinessReference < Internal::Types::Model
|
|
8
|
+
field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
|
|
9
|
+
|
|
10
|
+
field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
|
|
11
|
+
|
|
12
|
+
field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
|
|
13
|
+
|
|
14
|
+
field :description, -> { String }, optional: true, nullable: false
|
|
15
|
+
|
|
16
|
+
field :website, -> { String }, optional: true, nullable: false
|
|
17
|
+
|
|
18
|
+
field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
|
|
19
|
+
|
|
20
|
+
field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
|
|
21
|
+
|
|
22
|
+
field :timezone, -> { String }, optional: true, nullable: false
|
|
23
|
+
|
|
24
|
+
field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
|
|
25
|
+
|
|
26
|
+
field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
|
|
27
|
+
|
|
28
|
+
field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Create a paypoint and its backing business together. Provide `business` plus `doingBusinessAs`; all other fields
|
|
6
|
+
# are optional.
|
|
7
|
+
class CreatePaypointWithInlineBusiness < Internal::Types::Model
|
|
8
|
+
field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
|
|
9
|
+
|
|
10
|
+
field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
|
|
11
|
+
|
|
12
|
+
field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
|
|
13
|
+
|
|
14
|
+
field :description, -> { String }, optional: true, nullable: false
|
|
15
|
+
|
|
16
|
+
field :website, -> { String }, optional: true, nullable: false
|
|
17
|
+
|
|
18
|
+
field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
|
|
19
|
+
|
|
20
|
+
field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
|
|
21
|
+
|
|
22
|
+
field :timezone, -> { String }, optional: true, nullable: false
|
|
23
|
+
|
|
24
|
+
field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
|
|
25
|
+
|
|
26
|
+
field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
|
|
27
|
+
|
|
28
|
+
field :business, -> { Payabli::Types::CreateBusinessRequest }, optional: false, nullable: false
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# A document the application asks for. A requirement comes from the application's template or from a Payabli
|
|
6
|
+
# business rule. For example, a business with an annual revenue of $1,000,000 or more needs bank statements.
|
|
7
|
+
#
|
|
8
|
+
# A person requirement appears once for each owner of the business, with that owner's `personReference`.
|
|
9
|
+
class DocumentRequirement < Internal::Types::Model
|
|
10
|
+
field :field_path, -> { String }, optional: false, nullable: false, api_name: "fieldPath"
|
|
11
|
+
|
|
12
|
+
field :label, -> { String }, optional: false, nullable: false
|
|
13
|
+
|
|
14
|
+
field :hint, -> { String }, optional: true, nullable: false
|
|
15
|
+
|
|
16
|
+
field :source, -> { Payabli::Types::DocumentRequirementSource }, optional: false, nullable: false
|
|
17
|
+
|
|
18
|
+
field :subject_types, -> { Internal::Types::Array[Payabli::Types::DocumentSubjectType] }, optional: false, nullable: false, api_name: "subjectTypes"
|
|
19
|
+
|
|
20
|
+
field :person_reference, -> { String }, optional: true, nullable: false, api_name: "personReference"
|
|
21
|
+
|
|
22
|
+
field :required, -> { Internal::Types::Boolean }, optional: false, nullable: false
|
|
23
|
+
|
|
24
|
+
field :max_uploads, -> { Integer }, optional: false, nullable: false, api_name: "maxUploads"
|
|
25
|
+
|
|
26
|
+
field :allowed_formats, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedFormats"
|
|
27
|
+
|
|
28
|
+
field :uploaded_count, -> { Integer }, optional: false, nullable: false, api_name: "uploadedCount"
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
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 document requirements.
|
|
6
|
+
class DocumentRequirementListEnvelope < 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::DocumentRequirement] }, 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's enablement progress.
|
|
6
|
+
class EnablementEnvelope < 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::EnablementResult }, optional: false, nullable: true
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# The progress of setting up an approved application's services with their processors.
|
|
6
|
+
class EnablementResult < Internal::Types::Model
|
|
7
|
+
field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
|
|
8
|
+
|
|
9
|
+
field :state, -> { String }, optional: false, nullable: true
|
|
10
|
+
|
|
11
|
+
field :services, -> { Internal::Types::Array[Payabli::Types::EnablementService] }, optional: false, nullable: false
|
|
12
|
+
|
|
13
|
+
field :blocked_on, -> { String }, optional: false, nullable: true, api_name: "blockedOn"
|
|
14
|
+
|
|
15
|
+
field :message, -> { String }, optional: false, nullable: true
|
|
16
|
+
|
|
17
|
+
field :attempts, -> { Integer }, optional: false, nullable: true
|
|
18
|
+
|
|
19
|
+
field :first_attempt_at, -> { String }, optional: false, nullable: true, api_name: "firstAttemptAt"
|
|
20
|
+
|
|
21
|
+
field :last_attempt_at, -> { String }, optional: false, nullable: true, api_name: "lastAttemptAt"
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# The enablement progress of one service the application requested.
|
|
6
|
+
class EnablementService < Internal::Types::Model
|
|
7
|
+
field :service, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
9
|
+
field :rail, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
11
|
+
field :state, -> { String }, optional: false, nullable: false
|
|
12
|
+
|
|
13
|
+
field :message, -> { String }, optional: false, nullable: true
|
|
14
|
+
|
|
15
|
+
field :missing_fields, -> { Internal::Types::Array[String] }, optional: false, nullable: true, api_name: "missingFields"
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
class GetBasicOrganizationResponse < Internal::Types::Model
|
|
6
|
+
field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
|
|
7
|
+
|
|
8
|
+
field :pageidentifier, -> { String }, optional: true, nullable: false
|
|
9
|
+
|
|
10
|
+
field :response_data, -> { Payabli::Types::OrganizationQueryRecord }, optional: true, nullable: false, api_name: "responseData"
|
|
11
|
+
|
|
12
|
+
field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# A government-issued identification document included in a person request.
|
|
6
|
+
class IdentificationDocumentRequest < Internal::Types::Model
|
|
7
|
+
field :type, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
9
|
+
field :number, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
11
|
+
field :issuing_state, -> { String }, optional: true, nullable: false, api_name: "issuingState"
|
|
12
|
+
|
|
13
|
+
field :issuing_country, -> { String }, optional: true, nullable: false, api_name: "issuingCountry"
|
|
14
|
+
|
|
15
|
+
field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# A government-issued identification document in a person response.
|
|
6
|
+
class IdentificationDocumentResponse < Internal::Types::Model
|
|
7
|
+
field :type, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
9
|
+
field :number, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
11
|
+
field :issuing_state, -> { String }, optional: true, nullable: false, api_name: "issuingState"
|
|
12
|
+
|
|
13
|
+
field :issuing_country, -> { String }, optional: true, nullable: false, api_name: "issuingCountry"
|
|
14
|
+
|
|
15
|
+
field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# The organization's billing information. Fields that aren't set return `null`.
|
|
6
|
+
class InstrumentResponse < Internal::Types::Model
|
|
7
|
+
field :ach_account, -> { String }, optional: false, nullable: true, api_name: "achAccount"
|
|
8
|
+
|
|
9
|
+
field :ach_routing, -> { String }, optional: false, nullable: true, api_name: "achRouting"
|
|
10
|
+
|
|
11
|
+
field :billing_address, -> { String }, optional: false, nullable: true, api_name: "billingAddress"
|
|
12
|
+
|
|
13
|
+
field :billing_city, -> { String }, optional: false, nullable: true, api_name: "billingCity"
|
|
14
|
+
|
|
15
|
+
field :billing_country, -> { String }, optional: false, nullable: true, api_name: "billingCountry"
|
|
16
|
+
|
|
17
|
+
field :billing_state, -> { String }, optional: false, nullable: true, api_name: "billingState"
|
|
18
|
+
|
|
19
|
+
field :billing_zip, -> { String }, optional: false, nullable: true, api_name: "billingZip"
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Standard boarding response envelope wrapping a page of applications.
|
|
6
|
+
class ListApplicationsEnvelope < 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::ListApplicationsResponse }, 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
|
+
# A page of applications.
|
|
6
|
+
class ListApplicationsResponse < Internal::Types::Model
|
|
7
|
+
field :data, -> { Internal::Types::Array[Payabli::Types::ApplicationListItem] }, optional: false, nullable: true
|
|
8
|
+
|
|
9
|
+
field :total, -> { Integer }, optional: false, nullable: false
|
|
10
|
+
|
|
11
|
+
field :page, -> { Integer }, optional: false, nullable: false
|
|
12
|
+
|
|
13
|
+
field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
|
|
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 page of businesses.
|
|
6
|
+
class ListBusinessesEnvelope < 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::ListBusinessesResponse }, 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,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# A page of businesses.
|
|
6
|
+
class ListBusinessesResponse < Internal::Types::Model
|
|
7
|
+
field :data, -> { Internal::Types::Array[Payabli::Types::BusinessSummaryResponse] }, optional: false, nullable: true
|
|
8
|
+
|
|
9
|
+
field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
|
|
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 page of payment methods.
|
|
6
|
+
class ListPaymentMethodsEnvelope < 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::ListPaymentMethodsResponse }, 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
|
+
# A page of payment methods.
|
|
6
|
+
class ListPaymentMethodsResponse < Internal::Types::Model
|
|
7
|
+
field :data, -> { Internal::Types::Array[Payabli::Types::PaymentMethodDetail] }, optional: false, nullable: true
|
|
8
|
+
|
|
9
|
+
field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
|
|
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 page of paypoints.
|
|
6
|
+
class ListPaypointsEnvelope < 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::ListPaypointsResponse }, 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
|
+
# A page of paypoints.
|
|
6
|
+
class ListPaypointsResponse < Internal::Types::Model
|
|
7
|
+
field :items, -> { Internal::Types::Array[Payabli::Types::PaypointSummaryResponse] }, optional: false, nullable: true
|
|
8
|
+
|
|
9
|
+
field :total, -> { Integer }, optional: false, nullable: false
|
|
10
|
+
|
|
11
|
+
field :page, -> { Integer }, optional: false, nullable: false
|
|
12
|
+
|
|
13
|
+
field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
|
|
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 page of people.
|
|
6
|
+
class ListPeopleEnvelope < 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::ListPeopleResponse }, 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
|
+
# A page of people.
|
|
6
|
+
class ListPeopleResponse < Internal::Types::Model
|
|
7
|
+
field :data, -> { Internal::Types::Array[Payabli::Types::PersonSummaryResponse] }, optional: false, nullable: true
|
|
8
|
+
|
|
9
|
+
field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# A page of boarding templates.
|
|
6
|
+
class ListTemplatesResponse < Internal::Types::Model
|
|
7
|
+
field :summary, -> { Payabli::Types::TemplatesSummary }, optional: false, nullable: false, api_name: "Summary"
|
|
8
|
+
|
|
9
|
+
field :records, -> { Internal::Types::Array[Payabli::Types::Template] }, optional: false, nullable: false, api_name: "Records"
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -8,7 +8,11 @@ module Payabli
|
|
|
8
8
|
|
|
9
9
|
field :check, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
10
10
|
|
|
11
|
+
field :rtp, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
12
|
+
|
|
11
13
|
field :vcard, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
14
|
+
|
|
15
|
+
field :wire, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
12
16
|
end
|
|
13
17
|
end
|
|
14
18
|
end
|
|
@@ -3,56 +3,58 @@
|
|
|
3
3
|
module Payabli
|
|
4
4
|
module Types
|
|
5
5
|
class OrganizationQueryRecord < Internal::Types::Model
|
|
6
|
-
field :
|
|
6
|
+
field :billing_info, -> { Payabli::Types::InstrumentResponse }, optional: true, nullable: false, api_name: "BillingInfo"
|
|
7
7
|
|
|
8
|
-
field :
|
|
9
|
-
|
|
10
|
-
field :contacts, -> { Internal::Types::Array[Payabli::Types::Contacts] }, optional: true, nullable: false
|
|
8
|
+
field :contacts, -> { Internal::Types::Array[Payabli::Types::ContactsResponse] }, optional: true, nullable: false, api_name: "Contacts"
|
|
11
9
|
|
|
12
10
|
field :created_at, -> { String }, optional: true, nullable: false, api_name: "createdAt"
|
|
13
11
|
|
|
14
|
-
field :has_billing, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "
|
|
12
|
+
field :has_billing, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "HasBilling"
|
|
15
13
|
|
|
16
|
-
field :has_residual, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "
|
|
14
|
+
field :has_residual, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "HasResidual"
|
|
17
15
|
|
|
18
16
|
field :id_org, -> { Integer }, optional: true, nullable: false, api_name: "idOrg"
|
|
19
17
|
|
|
20
18
|
field :is_root, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isRoot"
|
|
21
19
|
|
|
22
|
-
field :org_address, -> { String }, optional: true, nullable: false, api_name: "
|
|
20
|
+
field :org_address, -> { String }, optional: true, nullable: false, api_name: "OrgAddress"
|
|
21
|
+
|
|
22
|
+
field :org_city, -> { String }, optional: true, nullable: false, api_name: "OrgCity"
|
|
23
23
|
|
|
24
|
-
field :
|
|
24
|
+
field :org_country, -> { String }, optional: true, nullable: false, api_name: "OrgCountry"
|
|
25
25
|
|
|
26
|
-
field :
|
|
26
|
+
field :org_entry_name, -> { String }, optional: true, nullable: false, api_name: "OrgEntryName"
|
|
27
27
|
|
|
28
|
-
field :
|
|
28
|
+
field :org_favicon, -> { String }, optional: true, nullable: false, api_name: "OrgFavicon"
|
|
29
29
|
|
|
30
|
-
field :org_id, -> { String }, optional: true, nullable: false, api_name: "
|
|
30
|
+
field :org_id, -> { String }, optional: true, nullable: false, api_name: "OrgId"
|
|
31
31
|
|
|
32
|
-
field :org_logo, -> {
|
|
32
|
+
field :org_logo, -> { String }, optional: true, nullable: false, api_name: "OrgLogo"
|
|
33
33
|
|
|
34
|
-
field :org_name, -> { String }, optional: true, nullable: false, api_name: "
|
|
34
|
+
field :org_name, -> { String }, optional: true, nullable: false, api_name: "OrgName"
|
|
35
35
|
|
|
36
|
-
field :org_parent_id, -> { Integer }, optional: true, nullable: false, api_name: "
|
|
36
|
+
field :org_parent_id, -> { Integer }, optional: true, nullable: false, api_name: "OrgParentId"
|
|
37
37
|
|
|
38
|
-
field :org_parent_name, -> { String }, optional: true, nullable: false, api_name: "
|
|
38
|
+
field :org_parent_name, -> { String }, optional: true, nullable: false, api_name: "OrgParentName"
|
|
39
39
|
|
|
40
|
-
field :org_state, -> { String }, optional: true, nullable: false, api_name: "
|
|
40
|
+
field :org_state, -> { String }, optional: true, nullable: false, api_name: "OrgState"
|
|
41
41
|
|
|
42
|
-
field :org_timezone, -> { Integer }, optional: true, nullable: false, api_name: "
|
|
42
|
+
field :org_timezone, -> { Integer }, optional: true, nullable: false, api_name: "OrgTimezone"
|
|
43
43
|
|
|
44
|
-
field :org_type, -> { Integer }, optional: true, nullable: false, api_name: "
|
|
44
|
+
field :org_type, -> { Integer }, optional: true, nullable: false, api_name: "OrgType"
|
|
45
45
|
|
|
46
|
-
field :org_website, -> { String }, optional: true, nullable: false, api_name: "
|
|
46
|
+
field :org_website, -> { String }, optional: true, nullable: false, api_name: "OrgWebsite"
|
|
47
47
|
|
|
48
|
-
field :org_zip, -> { String }, optional: true, nullable: false, api_name: "
|
|
48
|
+
field :org_zip, -> { String }, optional: true, nullable: false, api_name: "OrgZip"
|
|
49
49
|
|
|
50
50
|
field :recipient_email_notification, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "recipientEmailNotification"
|
|
51
51
|
|
|
52
|
-
field :reply_to_email, -> { String }, optional: true, nullable: false, api_name: "
|
|
52
|
+
field :reply_to_email, -> { String }, optional: true, nullable: false, api_name: "ReplyToEmail"
|
|
53
53
|
|
|
54
54
|
field :resumable, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
55
55
|
|
|
56
|
+
field :services, -> { Internal::Types::Array[Payabli::Types::OrganizationQueryRecordServicesItem] }, optional: true, nullable: false, api_name: "Services"
|
|
57
|
+
|
|
56
58
|
field :summary, -> { Payabli::Types::SummaryOrg }, optional: true, nullable: false
|
|
57
59
|
|
|
58
60
|
field :users, -> { Internal::Types::Array[Payabli::Types::UserQueryRecord] }, optional: true, nullable: false
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Fields you can set when you create an organization. Payabli sets the organization type, so the request has no
|
|
6
|
+
# `paypointType`. Of these shared fields, only `doingBusinessAs` is required. Set `description`, `website`,
|
|
7
|
+
# `customerServicePhone`, `customerServiceEmail`, and `timezone` when you have them.
|
|
8
|
+
class OrganizationWritableFields < Internal::Types::Model
|
|
9
|
+
field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
|
|
10
|
+
|
|
11
|
+
field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
|
|
12
|
+
|
|
13
|
+
field :description, -> { String }, optional: true, nullable: false
|
|
14
|
+
|
|
15
|
+
field :website, -> { String }, optional: true, nullable: false
|
|
16
|
+
|
|
17
|
+
field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
|
|
18
|
+
|
|
19
|
+
field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
|
|
20
|
+
|
|
21
|
+
field :timezone, -> { String }, optional: true, nullable: false
|
|
22
|
+
|
|
23
|
+
field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
|
|
24
|
+
|
|
25
|
+
field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Pagination metadata for a list response.
|
|
6
|
+
class Pagination < Internal::Types::Model
|
|
7
|
+
field :page, -> { Integer }, optional: true, nullable: false
|
|
8
|
+
|
|
9
|
+
field :total_pages, -> { Integer }, optional: true, nullable: false, api_name: "totalPages"
|
|
10
|
+
|
|
11
|
+
field :total_records, -> { Integer }, optional: true, nullable: false, api_name: "totalRecords"
|
|
12
|
+
|
|
13
|
+
field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
|
|
14
|
+
|
|
15
|
+
field :has_next, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "hasNext"
|
|
16
|
+
|
|
17
|
+
field :has_previous, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "hasPrevious"
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -7,9 +7,9 @@ module Payabli
|
|
|
7
7
|
|
|
8
8
|
field :mode, -> { Integer }, optional: true, nullable: false, api_name: "Mode"
|
|
9
9
|
|
|
10
|
-
field :
|
|
10
|
+
field :minticket, -> { Integer }, optional: true, nullable: false, api_name: "Minticket"
|
|
11
11
|
|
|
12
|
-
field :
|
|
12
|
+
field :maxticket, -> { Integer }, optional: true, nullable: false, api_name: "Maxticket"
|
|
13
13
|
|
|
14
14
|
field :cfee_fix, -> { Integer }, optional: true, nullable: false, api_name: "CfeeFix"
|
|
15
15
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Standard boarding response envelope wrapping a deactivated payment method.
|
|
6
|
+
class PaymentMethodDeactivatedEnvelope < 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::PaymentMethodResult }, optional: false, nullable: true
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|