pago-sdk 1.0.0

data/lib/pago/v2026_04/services/meters.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Meters < ::Pago::Service
+        # List meters.
+        #
+        # **Scopes**: `meters:read` `meters:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param query [String, nil] Filter by name.
+        # @param is_archived [Boolean, nil] Filter on archived meters.
+        # @param page [Integer] Page number, defaults to 1.
+        # @param limit [Integer] Size of a page, defaults to 10. Maximum is 100.
+        # @param sorting [Array<String>, nil] Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
+        # @param metadata [Object] Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceMeter]
+        def list(organization_id: nil, query: nil, is_archived: nil, page: 1, limit: 10, sorting: ["name"], metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/meters/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "query" => query, "is_archived" => is_archived, "page" => page, "limit" => limit, "sorting" => sorting, "metadata" => metadata },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceMeter.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Meter]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, query: nil, is_archived: nil, limit: 10, sorting: ["name"], metadata: nil, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, query: query, is_archived: is_archived, page: page_number, limit: limit, sorting: sorting, metadata: metadata)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a meter.
+        #
+        # **Scopes**: `meters:write`
+        #
+        # @param body [Hash, Models::MeterCreate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Meter]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/meters/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::Meter.from_json(data)
+        end
+
+        # Get a meter by ID.
+        #
+        # **Scopes**: `meters:read` `meters:write`
+        #
+        # @param id [String] The meter ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Meter]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/meters/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Meter.from_json(data)
+        end
+
+        # Update a meter.
+        #
+        # **Scopes**: `meters:write`
+        #
+        # @param id [String] The meter ID.
+        # @param body [Hash, Models::MeterUpdate] the request body.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Meter]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/meters/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Meter.from_json(data)
+        end
+
+        # Get quantities of a meter over a time period.
+        #
+        # **Scopes**: `meters:read` `meters:write`
+        #
+        # @param id [String] The meter ID.
+        # @param start_timestamp [String] Start timestamp.
+        # @param end_timestamp [String] End timestamp.
+        # @param interval [String] Interval between two timestamps.
+        # @param timezone [String] Timezone to use for the timestamps. Default is UTC.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param external_customer_id [String, Array<String>, nil] Filter by external customer ID.
+        # @param customer_aggregation_function [String, nil] If set, will first compute the quantities per customer before aggregating them using the given function. If not set, the quantities will be aggregated across all events.
+        # @param metadata [Object] Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MeterQuantities]
+        def quantities(id, start_timestamp:, end_timestamp:, interval:, timezone: "UTC", customer_id: nil, external_customer_id: nil, customer_aggregation_function: nil, metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/meters/{id}/quantities",
+            path_params: { "id" => id },
+            query: { "start_timestamp" => start_timestamp, "end_timestamp" => end_timestamp, "interval" => interval, "timezone" => timezone, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "customer_aggregation_function" => customer_aggregation_function, "metadata" => metadata },
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::MeterQuantities.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/pago/v2026_04/services/metrics.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Metrics < ::Pago::Service
+        # Get metrics about your orders and subscriptions.
+        #
+        # Currency values are output in cents.
+        #
+        # **Scopes**: `metrics:read`
+        #
+        # @param start_date [String] Start date.
+        # @param end_date [String] End date.
+        # @param timezone [String] Timezone to use for the timestamps. Default is UTC.
+        # @param interval [String] Interval between two timestamps.
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product ID.
+        # @param billing_type [String, Array<String>, nil] Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param metrics [Array<String>, nil] List of metric slugs to focus on. When provided, only the queries needed for these metrics will be executed, improving performance. If not provided, all metrics are returned.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MetricsResponse]
+        def get(start_date:, end_date:, timezone: "UTC", interval:, organization_id: nil, product_id: nil, billing_type: nil, customer_id: nil, metrics: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/metrics/",
+            path_params: {},
+            query: { "start_date" => start_date, "end_date" => end_date, "timezone" => timezone, "interval" => interval, "organization_id" => organization_id, "product_id" => product_id, "billing_type" => billing_type, "customer_id" => customer_id, "metrics" => metrics },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::MetricsResponse.from_json(data)
+        end
+
+        # Export metrics as a CSV file.
+        #
+        # **Scopes**: `metrics:read`
+        #
+        # @param start_date [String] Start date.
+        # @param end_date [String] End date.
+        # @param timezone [String] Timezone to use for the timestamps. Default is UTC.
+        # @param interval [String] Interval between two timestamps.
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product ID.
+        # @param billing_type [String, Array<String>, nil] Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param metrics [Array<String>, nil] List of metric slugs to include in the export. If not provided, all metrics are exported.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [String]
+        def export(start_date:, end_date:, timezone: "UTC", interval:, organization_id: nil, product_id: nil, billing_type: nil, customer_id: nil, metrics: nil)
+          client.request(
+            http_method: "GET",
+            path: "/v1/metrics/export",
+            path_params: {},
+            query: { "start_date" => start_date, "end_date" => end_date, "timezone" => timezone, "interval" => interval, "organization_id" => organization_id, "product_id" => product_id, "billing_type" => billing_type, "customer_id" => customer_id, "metrics" => metrics },
+            response_type: :text,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Get the interval limits for the metrics endpoint.
+        #
+        # **Scopes**: `metrics:read`
+        #
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MetricsLimits]
+        def limits()
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/metrics/limits",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          Models::MetricsLimits.from_json(data)
+        end
+
+        # List user-defined metric dashboards.
+        #
+        # **Scopes**: `metrics:read`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Array<Models::MetricDashboardSchema>]
+        def list_dashboards(organization_id: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/metrics/dashboards",
+            path_params: {},
+            query: { "organization_id" => organization_id },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          ::Pago::Serde.array(data) { |item0| Models::MetricDashboardSchema.from_json(item0) }
+        end
+
+        # Create a user-defined metric dashboard.
+        #
+        # **Scopes**: `metrics:write`
+        #
+        # @param body [Hash, Models::MetricDashboardCreate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MetricDashboardSchema]
+        def create_dashboard(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/metrics/dashboards",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::MetricDashboardSchema.from_json(data)
+        end
+
+        # Get a user-defined metric dashboard by ID.
+        #
+        # **Scopes**: `metrics:read`
+        #
+        # @param id [String] The metric dashboard ID.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MetricDashboardSchema]
+        def get_dashboard(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/metrics/dashboards/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::MetricDashboardSchema.from_json(data)
+        end
+
+        # Delete a user-defined metric dashboard.
+        #
+        # **Scopes**: `metrics:write`
+        #
+        # @param id [String] The metric dashboard ID.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [nil]
+        def delete_dashboard(id)
+          client.request(
+            http_method: "DELETE",
+            path: "/v1/metrics/dashboards/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :none,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Update a user-defined metric dashboard.
+        #
+        # **Scopes**: `metrics:write`
+        #
+        # @param id [String] The metric dashboard ID.
+        # @param body [Hash, Models::MetricDashboardUpdate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::MetricDashboardSchema]
+        def update_dashboard(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/metrics/dashboards/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::MetricDashboardSchema.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/pago/v2026_04/services/oauth2.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Oauth2 < ::Pago::Service
+        # @return [Clients]
+        def clients = @clients ||= Clients.new(client)
+
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::AuthorizeResponseUser, Models::AuthorizeResponseOrganization]
+        def authorize()
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/oauth2/authorize",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          ::Pago::Serde.union(data, discriminator: "sub_type", mapping: { "organization" => Models::AuthorizeResponseOrganization, "user" => Models::AuthorizeResponseUser }, variants: [Models::AuthorizeResponseUser, Models::AuthorizeResponseOrganization])
+        end
+
+        # Request an access token using a valid grant.
+        #
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::TokenResponse]
+        def request_token()
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/oauth2/token",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          Models::TokenResponse.from_json(data)
+        end
+
+        # Revoke an access token or a refresh token.
+        #
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::RevokeTokenResponse]
+        def revoke_token()
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/oauth2/revoke",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          Models::RevokeTokenResponse.from_json(data)
+        end
+
+        # Get information about an access token.
+        #
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::IntrospectTokenResponse]
+        def introspect_token()
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/oauth2/introspect",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          Models::IntrospectTokenResponse.from_json(data)
+        end
+
+        # Get information about the authenticated user.
+        #
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::UserInfoUser, Models::UserInfoOrganization]
+        def userinfo()
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/oauth2/userinfo",
+            path_params: {},
+            query: {},
+            response_type: :json,
+            errors: {  }
+          )
+          ::Pago::Serde.union(data, variants: [Models::UserInfoUser, Models::UserInfoOrganization])
+        end
+
+        class Clients < ::Pago::Service
+          # @return [Oauth2]
+          def oauth2 = @oauth2 ||= Oauth2.new(client)
+
+          class Oauth2 < ::Pago::Service
+            # Create an OAuth2 client.
+            #
+            # @param body [Hash, Models::OAuth2ClientConfiguration] the request body.
+            # @raise [Errors::HTTPValidationError] on HTTP 422.
+            # @raise [Pago::NetworkError] when the request never reached the API.
+            # @return [Object]
+            def create_client(body: {})
+              data = client.request(
+                http_method: "POST",
+                path: "/v1/oauth2/register",
+                path_params: {},
+                query: {},
+                body: body,
+                response_type: :json,
+                errors: { 422 => Errors::HTTPValidationError }
+              )
+              data
+            end
+
+            # Get an OAuth2 client by Client ID.
+            #
+            # @param client_id [String]
+            # @raise [Errors::HTTPValidationError] on HTTP 422.
+            # @raise [Pago::NetworkError] when the request never reached the API.
+            # @return [Object]
+            def get_client(client_id)
+              data = client.request(
+                http_method: "GET",
+                path: "/v1/oauth2/register/{client_id}",
+                path_params: { "client_id" => client_id },
+                query: {},
+                response_type: :json,
+                errors: { 422 => Errors::HTTPValidationError }
+              )
+              data
+            end
+
+            # Update an OAuth2 client.
+            #
+            # @param client_id_path [String]
+            # @param body [Hash, Models::OAuth2ClientConfigurationUpdate] the request body.
+            # @raise [Errors::HTTPValidationError] on HTTP 422.
+            # @raise [Pago::NetworkError] when the request never reached the API.
+            # @return [Object]
+            def update_client(client_id_path, body: {})
+              data = client.request(
+                http_method: "PUT",
+                path: "/v1/oauth2/register/{client_id}",
+                path_params: { "client_id" => client_id_path },
+                query: {},
+                body: body,
+                response_type: :json,
+                errors: { 422 => Errors::HTTPValidationError }
+              )
+              data
+            end
+
+            # Delete an OAuth2 client.
+            #
+            # @param client_id [String]
+            # @raise [Errors::HTTPValidationError] on HTTP 422.
+            # @raise [Pago::NetworkError] when the request never reached the API.
+            # @return [nil]
+            def delete_client(client_id)
+              client.request(
+                http_method: "DELETE",
+                path: "/v1/oauth2/register/{client_id}",
+                path_params: { "client_id" => client_id },
+                query: {},
+                response_type: :none,
+                errors: { 422 => Errors::HTTPValidationError }
+              )
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+  end
+end