Sha256: cf12af91c480e16a4a3682fd996846bc009995b536b361de42dd14c625cf3894

Contents?: true

Size: 748 Bytes

Versions: 10

Compression:

Stored size: 748 Bytes

Contents

# frozen_string_literal: true

require "beyond_api/utils"

module BeyondApi
  class Scopes < Base
    include BeyondApi::Utils

    #
    # A +GET+ request will list all scopes in the system.
    #
    #   $ curl 'https://api-shop.beyondshop.cloud/api/scopes' -i -X GET \
    #       -H 'Authorization: Bearer <Access token>'
    #
    # @beyond_api.scopes +scop:r+
    #
    # @option params [Integer] :size the page size
    # @option params [Integer] :page the page number

    # @return [OpenStruct]
    #
    # @example
    #   @scopes = session.scopes.all(size: 20, page: 0)
    #
    def all(params = {})
      response, status = BeyondApi::Request.get(@session, "/scopes", params)

      handle_response(response, status)
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
beyond_api-0.7.1.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.7.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.6.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.5.1.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.5.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.4.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.3.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.2.1.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.2.0.pre lib/beyond_api/resources/scopes.rb
beyond_api-0.1.0.pre lib/beyond_api/resources/scopes.rb