payabli 3.0.5 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b244baca4d457ef5e1e43e54b46c5b7cc24648cdd351b5da31dbbe6211cf27da
-  data.tar.gz: 358b6be5dac8473a4d25b4de4750cbac51ae5a4c1361b8904ff9e57165becba0
+  metadata.gz: c348ce0242faa30e0404200b80d1552188c2a6d953bae3308d44365a45a086e5
+  data.tar.gz: 96fd899b2ac2c8bc2ec9193f9ba244ba3b500fd746bd8354a1537f9155887284
 SHA512:
-  metadata.gz: e193a9655b0961dbb9d4f2532bce484191b0b1e81c389e778b8e6e8c8c6eb44e5e7e21edc7b2cd4b1890379c2266831fa9d7235ca4c6ee7676fafb5455f100cf
-  data.tar.gz: '04587a27b2f6e1b4dfc5c10e2e7c2103036c2c5c1036044b3d4478481a3719f2458386bea6fab67bab38d730286306622aa5b869040d0b4bad83dd05b1e35469'
+  metadata.gz: 8d1832ec5c195aeb5ee8ab8c220a8c02c5dc9886146cfa1c76eca077636e9e83f23c87eb797485734d6b72df6299dec8c93eff9562c645e3098597b731a72081
+  data.tar.gz: 4cefd412ad3e15177f5f376e571179c7cbea0ad91ef33b24712a3659262f920eaee66f71150c34b1bcd33c59943ab37a658a5c58307e83d2b3dccc869344f09f

data/.fern/metadata.json

@@ -1,15 +1,15 @@
 {
   "cliVersion": "5.56.0",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.15.2",
+  "generatorVersion": "1.20.1",
   "generatorConfig": {
     "enableWireTests": true,
     "rubocopVariableNumberStyle": "snake_case"
   },
-  "originGitCommit": "691a950bd6f2451fa2ba6099f1b830b17fac51ec",
+  "originGitCommit": "85dc6dd780991f47e9c2d71ad221647a62bccf93",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.5",
+  "requestedVersion": "3.0.7",
   "ciProvider": "github",
-  "sdkVersion": "3.0.5"
+  "sdkVersion": "3.0.7"
 }

data/README.md

@@ -71,7 +71,10 @@ Instantiate and use the client with the following:
 ```ruby
 require "payabli"
 
-client = Payabli::Client.new(api_key: "<value>")
+client = Payabli::Client.new(
+  client_id: "<clientId>",
+  client_secret: "<clientSecret>"
+)
 
 client.money_in.getpaidv_2(
   customer_data: {

data/lib/payabli/bill/client.rb

@@ -22,6 +22,44 @@ module Payabli
       # @option params [String] :entry
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.bill.add_bill(
+      #     entry: "8cfec329267",
+      #     accounting_field_1: "MyInternalId",
+      #     attachments: [{
+      #       ftype: "pdf",
+      #       filename: "my-doc.pdf",
+      #       furl: "https://mysite.com/my-doc.pdf"
+      #     }],
+      #     bill_date: "2024-07-01",
+      #     bill_items: [{
+      #       item_product_code: "M-DEPOSIT",
+      #       item_product_name: "Materials deposit",
+      #       item_description: "Deposit for materials",
+      #       item_commodity_code: "010",
+      #       item_unit_of_measure: "SqFt",
+      #       item_cost: 5,
+      #       item_qty: 1,
+      #       item_mode: 0,
+      #       item_categories: ["deposits"],
+      #       item_total_amount: 123,
+      #       item_tax_amount: 7,
+      #       item_tax_rate: 0.075
+      #     }],
+      #     bill_number: "ABC-123",
+      #     comments: "Deposit for materials",
+      #     due_date: "2024-07-01",
+      #     end_date: "2024-07-01",
+      #     frequency: "monthly",
+      #     mode: 0,
+      #     net_amount: 3762.87,
+      #     status: 1,
+      #     terms: "NET30",
+      #     vendor: {
+      #       vendor_number: "VEN-123"
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::BillResponse]
       def add_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -31,6 +69,7 @@ module Payabli
         headers = {}
         headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
@@ -64,13 +103,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id_bill
       #
+      # @example
+      #   client.bill.get_bill(id_bill: 285)
+      #
       # @return [Payabli::Types::GetBillResponse]
       def get_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Bill/#{URI.encode_uri_component(params[:id_bill].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -98,13 +142,22 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id_bill
       #
+      # @example
+      #   client.bill.edit_bill(
+      #     id_bill: 285,
+      #     bill_date: "2025-07-01",
+      #     net_amount: 3762.87
+      #   )
+      #
       # @return [Payabli::Types::EditBillResponse]
       def edit_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Bill/#{URI.encode_uri_component(params[:id_bill].to_s)}",
+          headers: headers,
           body: Payabli::Types::BillOutData.new(params).to_h,
           request_options: request_options
         )
@@ -133,13 +186,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id_bill
       #
+      # @example
+      #   client.bill.delete_bill(id_bill: 285)
+      #
       # @return [Payabli::Types::BillResponse]
       def delete_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",
           path: "Bill/#{URI.encode_uri_component(params[:id_bill].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -169,16 +227,25 @@ module Payabli
       # @option params [String] :filename
       # @option params [Boolean, nil] :return_object
       #
+      # @example
+      #   client.bill.get_attached_from_bill(
+      #     id_bill: 285,
+      #     filename: "0_Bill.pdf",
+      #     return_object: true
+      #   )
+      #
       # @return [Payabli::Types::FileContent]
       def get_attached_from_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["returnObject"] = params[:return_object] if params.key?(:return_object)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Bill/attachedFileFromBill/#{URI.encode_uri_component(params[:id_bill].to_s)}/#{URI.encode_uri_component(params[:filename].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -209,16 +276,24 @@ module Payabli
       # @option params [String] :filename
       # @option params [Boolean, nil] :return_object
       #
+      # @example
+      #   client.bill.delete_attached_from_bill(
+      #     id_bill: 285,
+      #     filename: "0_Bill.pdf"
+      #   )
+      #
       # @return [Payabli::Types::BillResponse]
       def delete_attached_from_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["returnObject"] = params[:return_object] if params.key?(:return_object)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",
           path: "Bill/attachedFileFromBill/#{URI.encode_uri_component(params[:id_bill].to_s)}/#{URI.encode_uri_component(params[:filename].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -249,6 +324,13 @@ module Payabli
       # @option params [Boolean, nil] :autocreate_user
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.bill.send_to_approval_bill(
+      #     id_bill: 285,
+      #     idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
+      #     body: ["approver@example.com"]
+      #   )
+      #
       # @return [Payabli::Types::BillResponse]
       def send_to_approval_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -263,6 +345,7 @@ module Payabli
         headers = {}
         headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
@@ -297,13 +380,21 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id_bill
       #
+      # @example
+      #   client.bill.modify_approval_bill(
+      #     id_bill: 285,
+      #     request: %w[approver1@example.com approver2@example.com]
+      #   )
+      #
       # @return [Payabli::Types::ModifyApprovalBillResponse]
       def modify_approval_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Bill/approval/#{URI.encode_uri_component(params[:id_bill].to_s)}",
+          headers: headers,
           body: params,
           request_options: request_options
         )
@@ -334,16 +425,24 @@ module Payabli
       # @option params [String] :approved
       # @option params [String, nil] :email
       #
+      # @example
+      #   client.bill.set_approved_bill(
+      #     id_bill: 285,
+      #     approved: "true"
+      #   )
+      #
       # @return [Payabli::Types::SetApprovedBillResponse]
       def set_approved_bill(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["email"] = params[:email] if params.key?(:email)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Bill/approval/#{URI.encode_uri_component(params[:id_bill].to_s)}/#{URI.encode_uri_component(params[:approved].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -378,6 +477,14 @@ module Payabli
       # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :sort_by
       #
+      # @example
+      #   client.bill.list_bills(
+      #     entry: "8cfec329267",
+      #     from_record: 251,
+      #     limit_record: 0,
+      #     sort_by: "desc(field_name)"
+      #   )
+      #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -388,10 +495,12 @@ module Payabli
         query_params["parameters"] = params[:parameters] if params.key?(:parameters)
         query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Query/bills/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -426,6 +535,14 @@ module Payabli
       # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :sort_by
       #
+      # @example
+      #   client.bill.list_bills_org(
+      #     org_id: 123,
+      #     from_record: 251,
+      #     limit_record: 0,
+      #     sort_by: "desc(field_name)"
+      #   )
+      #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills_org(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -436,10 +553,12 @@ module Payabli
         query_params["parameters"] = params[:parameters] if params.key?(:parameters)
         query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Query/bills/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )