pago-sdk 1.0.0

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

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Subscriptions < ::Pago::Service
+        # List subscriptions.
+        #
+        # **Scopes**: `subscriptions:read` `subscriptions:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param product_id [String, Array<String>, nil] Filter by product ID.
+        # @param customer_id [String, Array<String>, nil] Filter by customer ID.
+        # @param external_customer_id [String, Array<String>, nil] Filter by customer external ID.
+        # @param discount_id [String, Array<String>, nil] Filter by discount ID.
+        # @param active [Boolean, nil] Filter by active or inactive subscription.
+        # @param status [String, Array<String>, nil] Filter by subscription status.
+        # @param cancel_at_period_end [Boolean, nil] Filter by subscriptions that are set to cancel at period end.
+        # @param customer_cancellation_reason [String, Array<String>, nil] Filter by customer cancellation reason.
+        # @param canceled_at_after [String, nil] Filter by cancellation date (after or equal to).
+        # @param canceled_at_before [String, nil] Filter by cancellation date (before or equal to).
+        # @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::ListResourceSubscription]
+        def list(organization_id: nil, product_id: nil, customer_id: nil, external_customer_id: nil, discount_id: nil, active: nil, status: nil, cancel_at_period_end: nil, customer_cancellation_reason: nil, canceled_at_after: nil, canceled_at_before: nil, page: 1, limit: 10, sorting: ["-started_at"], metadata: nil)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/subscriptions/",
+            path_params: {},
+            query: { "organization_id" => organization_id, "product_id" => product_id, "customer_id" => customer_id, "external_customer_id" => external_customer_id, "discount_id" => discount_id, "active" => active, "status" => status, "cancel_at_period_end" => cancel_at_period_end, "customer_cancellation_reason" => customer_cancellation_reason, "canceled_at_after" => canceled_at_after, "canceled_at_before" => canceled_at_before, "page" => page, "limit" => limit, "sorting" => sorting, "metadata" => metadata },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceSubscription.from_json(data)
+        end
+
+        # Enumerate every item of `list`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::Subscription]
+        # @return [Pago::Paginator] when called without a block.
+        def list_each(organization_id: nil, product_id: nil, customer_id: nil, external_customer_id: nil, discount_id: nil, active: nil, status: nil, cancel_at_period_end: nil, customer_cancellation_reason: nil, canceled_at_after: nil, canceled_at_before: nil, limit: 10, sorting: ["-started_at"], metadata: nil, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list(organization_id: organization_id, product_id: product_id, customer_id: customer_id, external_customer_id: external_customer_id, discount_id: discount_id, active: active, status: status, cancel_at_period_end: cancel_at_period_end, customer_cancellation_reason: customer_cancellation_reason, canceled_at_after: canceled_at_after, canceled_at_before: canceled_at_before, page: page_number, limit: limit, sorting: sorting, metadata: metadata)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a subscription programmatically.
+        #
+        # This endpoint only allows to create subscription on free products.
+        # For paid products, use the checkout flow.
+        #
+        # No initial order will be created and no confirmation email will be sent.
+        #
+        # **Scopes**: `subscriptions:write`
+        #
+        # @param body [Hash, Models::SubscriptionCreateCustomer, Models::SubscriptionCreateExternalCustomer] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Subscription]
+        def create(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/subscriptions/",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::Subscription.from_json(data)
+        end
+
+        # Export subscriptions as a CSV file.
+        #
+        # **Scopes**: `subscriptions:read` `subscriptions:write`
+        #
+        # @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 [String]
+        def export(organization_id: nil)
+          client.request(
+            http_method: "GET",
+            path: "/v1/subscriptions/export",
+            path_params: {},
+            query: { "organization_id" => organization_id },
+            response_type: :text,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Get a subscription by ID.
+        #
+        # **Scopes**: `subscriptions:read` `subscriptions:write`
+        #
+        # @param id [String] The subscription 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::Subscription]
+        def get(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/subscriptions/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::Subscription.from_json(data)
+        end
+
+        # Revoke a subscription, i.e cancel immediately.
+        #
+        # **Scopes**: `subscriptions:write`
+        #
+        # @param id [String] The subscription ID.
+        # @raise [Errors::AlreadyCanceledSubscription] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::SubscriptionLocked] on HTTP 409.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Subscription]
+        def revoke(id)
+          data = client.request(
+            http_method: "DELETE",
+            path: "/v1/subscriptions/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 403 => Errors::AlreadyCanceledSubscription, 404 => Errors::ResourceNotFound, 409 => Errors::SubscriptionLocked, 422 => Errors::HTTPValidationError }
+          )
+          Models::Subscription.from_json(data)
+        end
+
+        # Update a subscription.
+        #
+        # **Scopes**: `subscriptions:write`
+        #
+        # @param id [String] The subscription ID.
+        # @param body [Hash, Object] the request body.
+        # @raise [Errors::PaymentFailed] on HTTP 402.
+        # @raise [Errors::AlreadyCanceledSubscription] on HTTP 403.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::SubscriptionLocked] on HTTP 409.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::Subscription]
+        def update(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/subscriptions/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 402 => Errors::PaymentFailed, 403 => Errors::AlreadyCanceledSubscription, 404 => Errors::ResourceNotFound, 409 => Errors::SubscriptionLocked, 422 => Errors::HTTPValidationError }
+          )
+          Models::Subscription.from_json(data)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Pago
+  module V2026_04
+    module Services
+      class Webhooks < ::Pago::Service
+        # List webhook endpoints.
+        #
+        # **Scopes**: `webhooks:read` `webhooks:write`
+        #
+        # @param organization_id [String, Array<String>, nil] Filter by organization ID.
+        # @param page [Integer] Page number, defaults to 1.
+        # @param limit [Integer] Size of a page, defaults to 10. Maximum is 100.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceWebhookEndpoint]
+        def list_webhook_endpoints(organization_id: nil, page: 1, limit: 10)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/webhooks/endpoints",
+            path_params: {},
+            query: { "organization_id" => organization_id, "page" => page, "limit" => limit },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceWebhookEndpoint.from_json(data)
+        end
+
+        # Enumerate every item of `list_webhook_endpoints`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::WebhookEndpoint]
+        # @return [Pago::Paginator] when called without a block.
+        def list_webhook_endpoints_each(organization_id: nil, limit: 10, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list_webhook_endpoints(organization_id: organization_id, page: page_number, limit: limit)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Create a webhook endpoint.
+        #
+        # **Scopes**: `webhooks:write`
+        #
+        # @param body [Hash, Models::WebhookEndpointCreate] the request body.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::WebhookEndpoint]
+        def create_webhook_endpoint(body: {})
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/webhooks/endpoints",
+            path_params: {},
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::WebhookEndpoint.from_json(data)
+        end
+
+        # Get a webhook endpoint by ID.
+        #
+        # **Scopes**: `webhooks:read` `webhooks:write`
+        #
+        # @param id [String] The webhook endpoint 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::WebhookEndpoint]
+        def get_webhook_endpoint(id)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/webhooks/endpoints/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::WebhookEndpoint.from_json(data)
+        end
+
+        # Delete a webhook endpoint.
+        #
+        # **Scopes**: `webhooks:write`
+        #
+        # @param id [String] The webhook endpoint ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [nil]
+        def delete_webhook_endpoint(id)
+          client.request(
+            http_method: "DELETE",
+            path: "/v1/webhooks/endpoints/{id}",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :none,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+        end
+
+        # Update a webhook endpoint.
+        #
+        # **Scopes**: `webhooks:write`
+        #
+        # @param id [String] The webhook endpoint ID.
+        # @param body [Hash, Models::WebhookEndpointUpdate] 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::WebhookEndpoint]
+        def update_webhook_endpoint(id, body: {})
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/webhooks/endpoints/{id}",
+            path_params: { "id" => id },
+            query: {},
+            body: body,
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::WebhookEndpoint.from_json(data)
+        end
+
+        # Regenerate a webhook endpoint secret.
+        #
+        # **Scopes**: `webhooks:write`
+        #
+        # @param id [String] The webhook endpoint 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::WebhookEndpoint]
+        def reset_webhook_endpoint_secret(id)
+          data = client.request(
+            http_method: "PATCH",
+            path: "/v1/webhooks/endpoints/{id}/secret",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          Models::WebhookEndpoint.from_json(data)
+        end
+
+        # List webhook deliveries.
+        #
+        # Deliveries are all the attempts to deliver a webhook event to an endpoint.
+        #
+        # **Scopes**: `webhooks:read` `webhooks:write`
+        #
+        # @param endpoint_id [String, Array<String>, nil] Filter by webhook endpoint ID.
+        # @param start_timestamp [String, nil] Filter deliveries after this timestamp.
+        # @param end_timestamp [String, nil] Filter deliveries before this timestamp.
+        # @param succeeded [Boolean, nil] Filter by delivery success status.
+        # @param query [String, nil] Query to filter webhook deliveries.
+        # @param http_code_class [String, nil] Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
+        # @param event_type [String, Array<String>, nil] Filter by webhook event type.
+        # @param page [Integer] Page number, defaults to 1.
+        # @param limit [Integer] Size of a page, defaults to 10. Maximum is 100.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Models::ListResourceWebhookDelivery]
+        def list_webhook_deliveries(endpoint_id: nil, start_timestamp: nil, end_timestamp: nil, succeeded: nil, query: nil, http_code_class: nil, event_type: nil, page: 1, limit: 10)
+          data = client.request(
+            http_method: "GET",
+            path: "/v1/webhooks/deliveries",
+            path_params: {},
+            query: { "endpoint_id" => endpoint_id, "start_timestamp" => start_timestamp, "end_timestamp" => end_timestamp, "succeeded" => succeeded, "query" => query, "http_code_class" => http_code_class, "event_type" => event_type, "page" => page, "limit" => limit },
+            response_type: :json,
+            errors: { 422 => Errors::HTTPValidationError }
+          )
+          Models::ListResourceWebhookDelivery.from_json(data)
+        end
+
+        # Enumerate every item of `list_webhook_deliveries`, fetching pages on demand.
+        #
+        # @yieldparam item [Models::WebhookDelivery]
+        # @return [Pago::Paginator] when called without a block.
+        def list_webhook_deliveries_each(endpoint_id: nil, start_timestamp: nil, end_timestamp: nil, succeeded: nil, query: nil, http_code_class: nil, event_type: nil, limit: 10, &block)
+          paginator = ::Pago::Paginator.new do |page_number|
+            list_webhook_deliveries(endpoint_id: endpoint_id, start_timestamp: start_timestamp, end_timestamp: end_timestamp, succeeded: succeeded, query: query, http_code_class: http_code_class, event_type: event_type, page: page_number, limit: limit)
+          end
+          block ? paginator.each(&block) : paginator
+        end
+
+        # Schedule the re-delivery of a webhook event.
+        #
+        # **Scopes**: `webhooks:write`
+        #
+        # @param id [String] The webhook event ID.
+        # @raise [Errors::ResourceNotFound] on HTTP 404.
+        # @raise [Errors::HTTPValidationError] on HTTP 422.
+        # @raise [Pago::NetworkError] when the request never reached the API.
+        # @return [Object]
+        def redeliver_webhook_event(id)
+          data = client.request(
+            http_method: "POST",
+            path: "/v1/webhooks/events/{id}/redeliver",
+            path_params: { "id" => id },
+            query: {},
+            response_type: :json,
+            errors: { 404 => Errors::ResourceNotFound, 422 => Errors::HTTPValidationError }
+          )
+          data
+        end
+
+      end
+
+    end
+  end
+end