paystack_sdk 0.3.0 → 0.4.0

data/lib/paystack_sdk/resources/products.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Product`. Hand-written extras go in lib/paystack_sdk/resources/extensions/products.rb.
+# scaffold-digest: 40ad36eb6641d3f3dc5f272c7c372ae279002d7bb64a3ac51b2ae5d8b4af3c5e
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Product operations.
+    class Products < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Products.
+      #
+      # List all previously created products
+      #
+      # @param per_page [Integer] Number of records to fetch per page
+      # @param page [Integer] The section to retrieve
+      # @param active [Boolean] The state of the product
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/product/#list
+      def list(per_page: nil, page: nil, active: nil, from: nil, to: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+
+        wire_query = to_wire(
+          {
+            per_page:,
+            page:,
+            active:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/product", wire_query))
+      end
+
+      # Create Product.
+      #
+      # Create a new product on your integration
+      #
+      # @param name [String] Name of product
+      # @param price [Integer] Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
+      # @param currency [String] Currency in which price is set.
+      # @param description [String] The description of the product.
+      # @param unlimited [Boolean] Set to true if the product has unlimited stock.
+      # @param quantity [Integer] Number of products in stock.
+      # @param split_code [String] The split code if sharing the transaction with partners
+      # @param metadata [Hash] A set of key/value pairs that you can attach to the product.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/product/#create
+      def create(
+        name:,
+        price:,
+        currency:,
+        description: nil,
+        unlimited: nil,
+        quantity: nil,
+        split_code: nil,
+        metadata: nil
+      )
+        validate_presence!(value: name, name: "name")
+        validate_presence!(value: price, name: "price")
+        validate_presence!(value: currency, name: "currency")
+
+        wire_body = to_wire(
+          {
+            name:,
+            price:,
+            currency:,
+            description:,
+            unlimited:,
+            quantity:,
+            split_code:,
+            metadata:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/product", wire_body))
+      end
+
+      # Fetch Product.
+      #
+      # Fetch a previously created product
+      #
+      # @param id [Integer] The unique identifier of the product
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/product/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/product/#{escape_path(id, name: "id")}"))
+      end
+
+      # Update product.
+      #
+      # Update a previously created product
+      #
+      # @param id [Integer] The unique identifier of the product
+      # @param name [String] Name of product
+      # @param description [String] The description of the product
+      # @param price [Integer] Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
+      # @param currency [String] Currency in which price is set.
+      # @param unlimited [Boolean] Set to true if the product has unlimited stock.
+      # @param quantity [Integer] Number of products in stock.
+      # @param split_code [String] The split code if sharing the transaction with partners
+      # @param metadata [Hash] JSON object of custom data
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/product/#update
+      def update(
+        id:,
+        name: nil,
+        description: nil,
+        price: nil,
+        currency: nil,
+        unlimited: nil,
+        quantity: nil,
+        split_code: nil,
+        metadata: nil
+      )
+        validate_presence!(value: id, name: "id")
+
+        wire_body = to_wire(
+          {
+            name:,
+            description:,
+            price:,
+            currency:,
+            unlimited:,
+            quantity:,
+            split_code:,
+            metadata:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.put("/product/#{escape_path(id, name: "id")}", wire_body))
+      end
+
+      # Delete Product.
+      #
+      # Delete a previously created product
+      #
+      # @param id [Integer] The unique identifier of the product
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/product/#delete-product
+      def delete(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.delete("/product/#{escape_path(id, name: "id")}"))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/storefronts.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Storefront`. Hand-written extras go in lib/paystack_sdk/resources/extensions/storefronts.rb.
+# scaffold-digest: c569580b4ac53036d82e0b7d2d9dd17323e11da35951df7ba4d192c5fdf48cb1
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Storefront operations.
+    class Storefronts < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Storefronts.
+      #
+      # List the storefronts you previously created
+      #
+      # @param per_page [Integer] Number of records to fetch per request
+      # @param page [Integer] The offset to retrieve data from
+      # @param status [String] One of: active, inactive.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#list
+      def list(per_page: nil, page: nil, status: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+        validate_allowed_values!(value: status, allowed_values: %w[active inactive], name: "status")
+
+        wire_query = to_wire({per_page:, page:, status:}, WIRE_NAMES)
+
+        handle_response(@connection.get("/storefront", wire_query))
+      end
+
+      # Create Storefront.
+      #
+      # Create a digital shop to manage and display your products
+      #
+      # @param name [String] Name of the storefront
+      # @param slug [String] A unique identifier to access your store.
+      # @param currency [String] Currency for prices of products in your storefront. One of: GHS, KES, NGN, USD, ZAR.
+      # @param description [String] The description of the storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#create
+      def create(name:, slug:, currency:, description: nil)
+        validate_presence!(value: name, name: "name")
+        validate_presence!(value: slug, name: "slug")
+        validate_presence!(value: currency, name: "currency")
+        validate_allowed_values!(
+          value: currency,
+          allowed_values: %w[GHS KES NGN USD ZAR],
+          name: "currency"
+        )
+
+        wire_body = to_wire({name:, slug:, currency:, description:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/storefront", wire_body))
+      end
+
+      # Fetch Storefront.
+      #
+      # Get the details of a previously created Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/storefront/#{escape_path(id, name: "id")}"))
+      end
+
+      # Update Storefront.
+      #
+      # Update the details of a previously created Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @param name [String] Name of the storefront
+      # @param slug [String] A unique identifier to access your store.
+      # @param description [String] The description of the storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#update
+      def update(id:, name: nil, slug: nil, description: nil)
+        validate_presence!(value: id, name: "id")
+
+        wire_body = to_wire({name:, slug:, description:}, WIRE_NAMES)
+
+        handle_response(@connection.put("/storefront/#{escape_path(id, name: "id")}", wire_body))
+      end
+
+      # Delete Storefront.
+      #
+      # Delete a previously created Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#delete
+      def delete(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.delete("/storefront/#{escape_path(id, name: "id")}"))
+      end
+
+      # Verify Storefront Slug.
+      #
+      # Verify the availability of a slug before using it for your Storefront
+      #
+      # @param slug [String] The custom slug to check
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#verify-slug
+      def verify_slug(slug:)
+        validate_presence!(value: slug, name: "slug")
+
+        handle_response(@connection.get("/storefront/verify/#{escape_path(slug, name: "slug")}"))
+      end
+
+      # Fetch Storefront Orders.
+      #
+      # Fetch all orders in your Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#fetch-orders
+      def fetch_orders(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/storefront/#{escape_path(id, name: "id")}/order"))
+      end
+
+      # List Storefront Products.
+      #
+      # List the products in a Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#list-products
+      def list_products(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/storefront/#{escape_path(id, name: "id")}/product"))
+      end
+
+      # Add Products to Storefront.
+      #
+      # Add previously created products to a Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @param products [Array] An array of product IDs
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#add-products
+      def add_products(id:, products:)
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: products, name: "products")
+
+        wire_body = to_wire({products:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.post("/storefront/#{escape_path(id, name: "id")}/product", wire_body)
+        )
+      end
+
+      # Publish Storefront.
+      #
+      # Make your Storefront publicly available
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @note Publishing copies the storefront and its products into LIVE mode, even when you call
+      #   it with a test key (sk_test_). The live copy is active, can be found by its slug, and
+      #   cannot be read or deleted with a test key. Do not call this to try the API out; use
+      #   `duplicate` instead.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#publish
+      def publish(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.post("/storefront/#{escape_path(id, name: "id")}/publish"))
+      end
+
+      # Duplicate Storefront.
+      #
+      # Duplicate a previously created Storefront
+      #
+      # @param id [Integer] The unique identifier of the Storefront
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/storefront/#duplicate
+      def duplicate(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.post("/storefront/#{escape_path(id, name: "id")}/duplicate"))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/terminals.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Terminal`. Hand-written extras go in lib/paystack_sdk/resources/extensions/terminals.rb.
+# scaffold-digest: 0b01c27e31f3e144d9463553ec97a1eee95f91d173c35ca5b7cb500cd3872127
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Terminal operations.
+    class Terminals < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {next_cursor: "next"}.freeze
+
+      # Send Event.
+      #
+      # Send an event from your application to the Paystack Terminal
+      #
+      # @param terminal_id [String] The ID of the Terminal the event should be sent to.
+      # @param type [String] The type of event to push One of: invoice, transaction.
+      # @param action [String] The action the Terminal needs to perform. One of: process, view, print.
+      # @param data [Hash] The parameters needed to perform the specified action
+      # @note This pushes the event to a physical Paystack Terminal. Not verified against the
+      #   Paystack API: the test account used to build this SDK has no Terminal access.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#send-event
+      def send_event(terminal_id:, type: nil, action: nil, data: nil)
+        validate_presence!(value: terminal_id, name: "terminal_id")
+        validate_allowed_values!(value: type, allowed_values: %w[invoice transaction], name: "type")
+        validate_allowed_values!(
+          value: action,
+          allowed_values: %w[process view print],
+          name: "action"
+        )
+
+        wire_body = to_wire({type:, action:, data:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.post("/terminal/#{escape_path(terminal_id, name: "terminal_id")}/event", wire_body)
+        )
+      end
+
+      # Fetch Event Status.
+      #
+      # Check the status of an event sent to the Terminal
+      #
+      # @param terminal_id [String] The ID of the Terminal the event should be sent to.
+      # @param event_id [String] The ID of the event that was sent to the Terminal
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#fetch-event-status
+      def fetch_event_status(terminal_id:, event_id:)
+        validate_presence!(value: terminal_id, name: "terminal_id")
+        validate_presence!(value: event_id, name: "event_id")
+
+        handle_response(
+          @connection.get("/terminal/#{escape_path(terminal_id, name: "terminal_id")}/event/#{escape_path(event_id, name: "event_id")}")
+        )
+      end
+
+      # Fetch Terminal Status.
+      #
+      # Check the availiability of a Terminal before sending an event to it
+      #
+      # @param terminal_id [String] The ID of the Terminal the event should be sent to.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#fetch-terminal-status
+      def fetch_status(terminal_id:)
+        validate_presence!(value: terminal_id, name: "terminal_id")
+
+        handle_response(
+          @connection.get("/terminal/#{escape_path(terminal_id, name: "terminal_id")}/presence")
+        )
+      end
+
+      # List Terminals.
+      #
+      # List the Terminals available on your integration
+      #
+      # @param next_cursor [String] A cursor that indicates your place in the list.
+      # @param previous [String] A cursor that indicates your place in the list.
+      # @param per_page [Integer] Specify how many records you want to retrieve per page
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#list
+      def list(next_cursor: nil, previous: nil, per_page: nil)
+        validate_positive_integer!(value: per_page, name: "per_page")
+
+        wire_query = to_wire({next_cursor:, previous:, per_page:}, WIRE_NAMES)
+
+        handle_response(@connection.get("/terminal", wire_query))
+      end
+
+      # Fetch Terminal.
+      #
+      # Get the details of a Terminal
+      #
+      # @param terminal_id [String] The ID of the Terminal the event should be sent to.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#fetch
+      def fetch(terminal_id:)
+        validate_presence!(value: terminal_id, name: "terminal_id")
+
+        handle_response(
+          @connection.get("/terminal/#{escape_path(terminal_id, name: "terminal_id")}")
+        )
+      end
+
+      # Update Terminal.
+      #
+      # Update the details of a Terminal
+      #
+      # @param terminal_id [String] The ID of the Terminal the event should be sent to.
+      # @param name [String] The new name for the Terminal
+      # @param address [String] The new address for the Terminal
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#update
+      def update(terminal_id:, name: nil, address: nil)
+        validate_presence!(value: terminal_id, name: "terminal_id")
+
+        wire_body = to_wire({name:, address:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.put("/terminal/#{escape_path(terminal_id, name: "terminal_id")}", wire_body)
+        )
+      end
+
+      # Commission Terminal.
+      #
+      # Activate your debug device by linking it to your integration
+      #
+      # @param serial_number [String] Device Serial Number
+      # @note This links a physical device to your integration. Not verified against the Paystack
+      #   API: the test account used to build this SDK has no Terminal access.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#commission
+      def commission(serial_number:)
+        validate_presence!(value: serial_number, name: "serial_number")
+
+        wire_body = to_wire({serial_number:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/terminal/commission_device", wire_body))
+      end
+
+      # Decommission Terminal.
+      #
+      # Unlink your debug device from your integration
+      #
+      # @param serial_number [String] Device Serial Number
+      # @note This unlinks a physical device from your integration. Not verified against the
+      #   Paystack API: the test account used to build this SDK has no Terminal access.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/terminal/#decommission
+      def decommission(serial_number:)
+        validate_presence!(value: serial_number, name: "serial_number")
+
+        wire_body = to_wire({serial_number:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/terminal/decommission_device", wire_body))
+      end
+    end
+  end
+end