payabli 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f2b4c63ae82a49e6adaa1958aba723b23f942f01cda44a42ea46993f4af4118
+  data.tar.gz: 1aec24ebc9537b4cf38190228efbb51e066790c4d41613953988a4c8e0f6fb28
+SHA512:
+  metadata.gz: 2b2a8e7b49383281f497552105af287f18e571f575b5fa186d8033af0223b9adac0046b6be26ddc1946f93aeb397fc2b042b2bcb1b21824d609f21f3ca2b4f62
+  data.tar.gz: 5cbcb228eb8caa25eb9c873531c3599092bcd0f6ee9f34a18a01b3bf4e0d024f7088a6d927e22d06e55d19c3c3c243a98d1a0230f72e7e944b26db47593abd94

data/.fern/metadata.json

@@ -0,0 +1,5 @@
+{
+  "cliVersion": "2.0.3",
+  "generatorName": "fernapi/fern-ruby-sdk",
+  "generatorVersion": "1.0.0-rc39"
+}

data/.fernignore

@@ -0,0 +1,3 @@
+# Specify files that shouldn't be modified by Fern
+test/unit/custom_test.rb
+.github/workflows/ci.yml

data/.rubocop.yml

@@ -0,0 +1,39 @@
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -0,0 +1,108 @@
+# Payabli Ruby Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fpayabli%2Fsdk-ruby)
+
+The Payabli Ruby library provides convenient access to the Payabli APIs from Ruby.
+
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Errors](#errors)
+- [Advanced](#advanced)
+  - [Timeouts](#timeouts)
+- [Contributing](#contributing)
+
+## Documentation
+
+API reference documentation is available [here](https://docs.payabli.com).
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/payabli/sdk-ruby/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```ruby
+require "payabli"
+
+client = Payabli::Client.new(api_key: '<value>');
+
+client.money_in.getpaid();
+```
+
+## Environments
+
+This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
+### Environments
+```ruby
+require "payabli"
+
+payabli = Payabli::Client.new(
+    base_url: Payabli::Environment::Sandbox
+)
+```
+
+### Custom URL
+```ruby
+require "payabli"
+
+client = Payabli::Client.new(
+    base_url: "https://example.com"
+)
+```
+
+## Errors
+
+Failed API calls will raise errors that can be rescued from granularly.
+
+```ruby
+require "payabli"
+
+client = Payabli::Client.new(
+    base_url: "https://example.com"
+)
+
+begin
+    result = client.money_in.getpaid
+rescue Payabli::Errors::TimeoutError
+    puts "API didn't respond before our timeout elapsed"
+rescue Payabli::Errors::ServiceUnavailableError
+    puts "API returned status 503, is probably overloaded, try again later"
+rescue Payabli::Errors::ServerError
+    puts "API returned some other 5xx status, this is probably a bug"
+rescue Payabli::Errors::ResponseError => e
+    puts "API returned an unexpected status other than 5xx: #{e.code} {e.message}"
+rescue Payabli::Errors::ApiError => e
+    puts "Some other error occurred when calling the API: {e.message}"
+end
+```
+
+## Advanced
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeout` option to configure this behavior.
+
+```ruby
+require "payabli"
+
+response = client.money_in.getpaid(
+    ...,
+    timeout: 30  # 30 second timeout
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test]
+
+task lint: %i[rubocop]
+
+# Run only the custom test file
+Minitest::TestTask.create(:customtest) do |t|
+  t.libs << "test"
+  t.test_globs = ["test/custom.test.rb"]
+end

data/custom.gemspec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Custom gemspec configuration file
+# This file is automatically loaded by the main gemspec file. The 'spec' variable is available
+# in this context from the main gemspec file. You can modify this file to add custom metadata,
+# dependencies, or other gemspec configurations. If you do make changes to this file, you will
+# need to add it to the .fernignore file to prevent your changes from being overwritten.
+
+def add_custom_gemspec_data(spec)
+  # Example custom configurations (uncomment and modify as needed)
+
+  # spec.authors = ["Your name"]
+  # spec.email = ["your.email@example.com"]
+  # spec.homepage = "https://github.com/your-org/payabli-ruby"
+  # spec.license = "Your license"
+end

data/lib/payabli/bill/client.rb

@@ -0,0 +1,368 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Bill
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [Payabli::Bill::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Creates a bill in an entrypoint.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Payabli::Bill::Types::BillOutData]
+      #
+      # @return [Payabli::Bill::Types::BillResponse]
+      def add_bill(request_options: {}, **params)
+        _path_param_names = %i[entry]
+        _body = params.except(*_path_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "POST",
+          path: "Bill/single/#{params[:entry]}",
+          body: Payabli::Bill::Types::BillOutData.new(_body).to_h
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::BillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Delete a file attached to a bill.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::BillResponse]
+      def delete_attached_from_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[return_object]
+        _query = {}
+        _query["returnObject"] = params[:return_object] if params.key?(:return_object)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "DELETE",
+          path: "Bill/attachedFileFromBill/#{params[:id_bill]}/#{params[:filename]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::BillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Deletes a bill by ID.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::BillResponse]
+      def delete_bill(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "DELETE",
+          path: "Bill/#{params[:id_bill]}"
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::BillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Updates a bill by ID.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Payabli::Bill::Types::BillOutData]
+      #
+      # @return [Payabli::Bill::Types::EditBillResponse]
+      def edit_bill(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "PUT",
+          path: "Bill/#{params[:id_bill]}",
+          body: Payabli::Bill::Types::BillOutData.new(params).to_h
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::EditBillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieves a file attached to a bill, either as a binary file or as a Base64-encoded string.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Types::FileContent]
+      def get_attached_from_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[return_object]
+        _query = {}
+        _query["returnObject"] = params[:return_object] if params.key?(:return_object)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Bill/attachedFileFromBill/#{params[:id_bill]}/#{params[:filename]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::FileContent.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieves a bill by ID from an entrypoint.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::GetBillResponse]
+      def get_bill(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Bill/#{params[:id_bill]}"
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::GetBillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Types::BillQueryResponse]
+      def list_bills(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[export_format from_record limit_record parameters sort_by]
+        _query = {}
+        _query["exportFormat"] = params[:export_format] if params.key?(:export_format)
+        _query["fromRecord"] = params[:from_record] if params.key?(:from_record)
+        _query["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
+        _query["parameters"] = params[:parameters] if params.key?(:parameters)
+        _query["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Query/bills/#{params[:entry]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::BillQueryResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieve a list of bills for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Types::BillQueryResponse]
+      def list_bills_org(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[export_format from_record limit_record parameters sort_by]
+        _query = {}
+        _query["exportFormat"] = params[:export_format] if params.key?(:export_format)
+        _query["fromRecord"] = params[:from_record] if params.key?(:from_record)
+        _query["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
+        _query["parameters"] = params[:parameters] if params.key?(:parameters)
+        _query["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Query/bills/org/#{params[:org_id]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::BillQueryResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Modify the list of users the bill is sent to for approval.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::ModifyApprovalBillResponse]
+      def modify_approval_bill(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "PUT",
+          path: "Bill/approval/#{params[:id_bill]}",
+          body: params
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::ModifyApprovalBillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Send a bill to a user or list of users to approve.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::BillResponse]
+      def send_to_approval_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[autocreate_user]
+        _query = {}
+        _query["autocreateUser"] = params[:autocreate_user] if params.key?(:autocreate_user)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "POST",
+          path: "Bill/approval/#{params[:id_bill]}",
+          query: _query,
+          body: _body
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::BillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Approve or disapprove a bill by ID.
+      #
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
+      #
+      # @return [Payabli::Bill::Types::SetApprovedBillResponse]
+      def set_approved_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[email]
+        _query = {}
+        _query["email"] = params[:email] if params.key?(:email)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Bill/approval/#{params[:id_bill]}/#{params[:approved]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Bill::Types::SetApprovedBillResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/payabli/bill/types/add_bill_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Bill
+    module Types
+      class AddBillRequest < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+        field :body, -> { Payabli::Bill::Types::BillOutData }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/bill/types/bill_out_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Bill
+    module Types
+      class BillOutData < Internal::Types::Model
+        field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "accountingField1"
+        field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "accountingField2"
+        field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
+        field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
+        field :bill_date, -> { String }, optional: true, nullable: false, api_name: "billDate"
+        field :bill_items, lambda {
+          Internal::Types::Array[Payabli::Types::BillItem]
+        }, optional: true, nullable: false, api_name: "billItems"
+        field :bill_number, -> { String }, optional: true, nullable: false, api_name: "billNumber"
+        field :comments, -> { String }, optional: true, nullable: false
+        field :discount, -> { Integer }, optional: true, nullable: false
+        field :due_date, -> { String }, optional: true, nullable: false, api_name: "dueDate"
+        field :end_date, -> { String }, optional: true, nullable: false, api_name: "endDate"
+        field :frequency, -> { Payabli::Types::Frequency }, optional: true, nullable: false
+        field :lot_number, -> { String }, optional: true, nullable: false, api_name: "lotNumber"
+        field :mode, -> { Integer }, optional: true, nullable: false
+        field :net_amount, -> { Integer }, optional: true, nullable: false, api_name: "netAmount"
+        field :scheduled_options, lambda {
+          Payabli::Bill::Types::BillOutDataScheduledOptions
+        }, optional: true, nullable: false, api_name: "scheduledOptions"
+        field :status, -> { Integer }, optional: true, nullable: false
+        field :terms, -> { String }, optional: true, nullable: false
+        field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "totalAmount"
+        field :vendor, -> { Payabli::Types::VendorData }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/bill/types/bill_out_data_scheduled_options.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Bill
+    module Types
+      class BillOutDataScheduledOptions < Internal::Types::Model
+        field :stored_method_id, -> { String }, optional: true, nullable: false, api_name: "storedMethodId"
+      end
+    end
+  end
+end

data/lib/payabli/bill/types/bill_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Bill
+    module Types
+      class BillResponse < Internal::Types::Model
+        field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
+        field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+        field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+        field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+        field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+        field :response_data, lambda {
+          Payabli::Types::Responsedatanonobject
+        }, optional: true, nullable: false, api_name: "responseData"
+      end
+    end
+  end
+end