merge_ruby_client 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69be222b0b95f43f60734ff4712887635bb288ff22e4bc24a896cd6f22fa2703
-  data.tar.gz: e43fc6f80427314c76edc2f97cad4ce790000ef28d342ccf8a898e772529f2e7
+  metadata.gz: b5cf8081e1e93127353406c12f2a70b00ef83196811eb50cdf3826f26efeb21c
+  data.tar.gz: 52b3a58930fb9252bcb264d633bdd0af0bc6af13a95f58f0acae9f51d4995fc8
 SHA512:
-  metadata.gz: 8327c3b6138e21bdddb3884b235b272251434aca99676511a89cbbd91b3d258d2058e0edf505d160d8f0de04049022274c469c0deb30cb8134433b965301ae98
-  data.tar.gz: df915f6f75ae6c4b87b529ccb7eaa82c15ba284a6e36b3bd66e97b13e829b5152a5eeb5008a722abd0ea76431ec89d3e0a7469f9c8e8cc7deee0adb2b8fde782
+  metadata.gz: 6b3944cba8d02186c3f7beb1c17a2af79a6564ef5f562a06d819bc71e77eb19898030e71a89c0bd8a30394d6f12527d9598a2088073e3b7407c60546f8254dcc
+  data.tar.gz: 798167e45072051fa4741d31f75d6deae1203d47d9e02229c8713ca4cd4265f7e95d8c15cd01ab4825c1c92b4dfff420bb27085639f83dec01fddb4c623db079

data/lib/merge_ruby_client/accounting/account_details/client.rb

@@ -7,53 +7,69 @@ require "async"
 module Merge
   module Accounting
     class AccountDetailsClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Accounting::AccountDetailsClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Accounting::AccountDetailsClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
       # Get details for a linked account.
       #
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountDetails]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountDetails]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve
       def retrieve(request_options: nil)
-        response = @request_client.conn.get("/api/accounting/v1/account-details") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/account-details"
         end
-        Accounting::AccountDetails.from_json(json_object: response.body)
+        Merge::Accounting::AccountDetails.from_json(json_object: response.body)
       end
     end
 
     class AsyncAccountDetailsClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Accounting::AsyncAccountDetailsClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Accounting::AsyncAccountDetailsClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
       # Get details for a linked account.
       #
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountDetails]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountDetails]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve
       def retrieve(request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/accounting/v1/account-details") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
             req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
             req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/account-details"
           end
-          Accounting::AccountDetails.from_json(json_object: response.body)
+          Merge::Accounting::AccountDetails.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/accounting/account_token/client.rb

@@ -7,55 +7,71 @@ require "async"
 module Merge
   module Accounting
     class AccountTokenClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Accounting::AccountTokenClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Accounting::AccountTokenClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
       # Returns the account token for the end user with the provided public token.
       #
       # @param public_token [String]
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountToken]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountToken]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve(public_token: "public_token")
       def retrieve(public_token:, request_options: nil)
-        response = @request_client.conn.get("/api/accounting/v1/account-token/#{public_token}") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/account-token/#{public_token}"
         end
-        Accounting::AccountToken.from_json(json_object: response.body)
+        Merge::Accounting::AccountToken.from_json(json_object: response.body)
       end
     end
 
     class AsyncAccountTokenClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Accounting::AsyncAccountTokenClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Accounting::AsyncAccountTokenClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
       # Returns the account token for the end user with the provided public token.
       #
       # @param public_token [String]
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountToken]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountToken]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve(public_token: "public_token")
       def retrieve(public_token:, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/accounting/v1/account-token/#{public_token}") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
             req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
             req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/account-token/#{public_token}"
           end
-          Accounting::AccountToken.from_json(json_object: response.body)
+          Merge::Accounting::AccountToken.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/accounting/accounting_periods/client.rb

@@ -8,12 +8,12 @@ require "async"
 module Merge
   module Accounting
     class AccountingPeriodsClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Accounting::AccountingPeriodsClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Accounting::AccountingPeriodsClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
@@ -21,12 +21,20 @@ module Merge
       #
       # @param cursor [String] The pagination cursor value.
       # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
-      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
       # @param page_size [Integer] Number of results to return per page.
-      # @param request_options [RequestOptions]
-      # @return [Accounting::PaginatedAccountingPeriodList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedAccountingPeriodList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.list
       def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, page_size: nil, request_options: nil)
-        response = @request_client.conn.get("/api/accounting/v1/accounting-periods") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -38,18 +46,27 @@ module Merge
             "include_remote_data": include_remote_data,
             "page_size": page_size
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/accounting-periods"
         end
-        Accounting::PaginatedAccountingPeriodList.from_json(json_object: response.body)
+        Merge::Accounting::PaginatedAccountingPeriodList.from_json(json_object: response.body)
       end
 
       # Returns an `AccountingPeriod` object with the given `id`.
       #
       # @param id [String]
-      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountingPeriod]
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountingPeriod]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve(id: "id")
       def retrieve(id:, include_remote_data: nil, request_options: nil)
-        response = @request_client.conn.get("/api/accounting/v1/accounting-periods/#{id}") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -58,18 +75,19 @@ module Merge
             **(request_options&.additional_query_parameters || {}),
             "include_remote_data": include_remote_data
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/accounting-periods/#{id}"
         end
-        Accounting::AccountingPeriod.from_json(json_object: response.body)
+        Merge::Accounting::AccountingPeriod.from_json(json_object: response.body)
       end
     end
 
     class AsyncAccountingPeriodsClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Accounting::AsyncAccountingPeriodsClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Accounting::AsyncAccountingPeriodsClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
@@ -77,13 +95,21 @@ module Merge
       #
       # @param cursor [String] The pagination cursor value.
       # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
-      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
       # @param page_size [Integer] Number of results to return per page.
-      # @param request_options [RequestOptions]
-      # @return [Accounting::PaginatedAccountingPeriodList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedAccountingPeriodList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.list
       def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, page_size: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/accounting/v1/accounting-periods") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
             req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -95,20 +121,29 @@ module Merge
               "include_remote_data": include_remote_data,
               "page_size": page_size
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/accounting-periods"
           end
-          Accounting::PaginatedAccountingPeriodList.from_json(json_object: response.body)
+          Merge::Accounting::PaginatedAccountingPeriodList.from_json(json_object: response.body)
         end
       end
 
       # Returns an `AccountingPeriod` object with the given `id`.
       #
       # @param id [String]
-      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
-      # @param request_options [RequestOptions]
-      # @return [Accounting::AccountingPeriod]
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::AccountingPeriod]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.retrieve(id: "id")
       def retrieve(id:, include_remote_data: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/accounting/v1/accounting-periods/#{id}") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
             req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
@@ -117,8 +152,9 @@ module Merge
               **(request_options&.additional_query_parameters || {}),
               "include_remote_data": include_remote_data
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/accounting-periods/#{id}"
           end
-          Accounting::AccountingPeriod.from_json(json_object: response.body)
+          Merge::Accounting::AccountingPeriod.from_json(json_object: response.body)
         end
       end
     end