rixl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70339fb332f04627b2bafcb947354da196f79b105e4cdd230f6766f7631804dd
+  data.tar.gz: fa7b1d4d78ba120fa91386546106c5c7a3d17f4b85c90ba34920468c7eee363d
+SHA512:
+  metadata.gz: 5eab58315ea275d47d8173635176d258c1d522225c13153f26252010560313f09ace7a3d3574123ef9fb0d00f0d3a854c0e5cd2a46e258b85f69ecf55e52ee3f
+  data.tar.gz: f819dedec22025d71a0698e1a589911ca36bc9143e2d79514ca665c2530a5fc05268210c5d5ccff68ce890d873bbdf922836cca1059e99bba2e6a5b051fa33bf

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"rixl" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["support@rixl.com"](mailto:"support@rixl.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Rixl Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Rixl
+
+Ruby client for the [RIXL](https://rixl.com) API.
+
+[![Gem Version](https://img.shields.io/gem/v/rixl.svg)](https://rubygems.org/gems/rixl)
+
+## Install
+
+```bash
+gem install rixl
+```
+
+Or in a `Gemfile`:
+
+```ruby
+gem "rixl"
+```
+
+Requires Ruby 3.0+. The Kiota Ruby runtime (`microsoft_kiota_abstractions`, `microsoft_kiota_faraday`, `microsoft_kiota_serialization_json`) is pulled in transitively.
+
+## Quick start
+
+```ruby
+require "rixl_client"
+require "microsoft_kiota_abstractions"
+require "microsoft_kiota_faraday"
+
+auth = MicrosoftKiotaAbstractions::ApiKeyAuthenticationProvider.new(
+  "X-API-Key",
+  "YOUR_RIXL_API_KEY",
+  MicrosoftKiotaAbstractions::ApiKeyAuthenticationProvider::KeyLocation::HEADER
+)
+adapter = MicrosoftKiotaFaraday::FaradayRequestAdapter.new(auth)
+adapter.base_url = "https://api.rixl.com"
+
+client = RixlSdk::RixlClient.new(adapter)
+image = client.images.by_image_id("PS5IMKoFLm").get
+puts image.id
+```
+
+## Issues
+
+[github.com/rixlhq/rixl-ruby/issues](https://github.com/rixlhq/rixl-ruby/issues)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/feeds/feeds_request_builder.rb

@@ -0,0 +1,34 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../rixl'
+require_relative './feeds'
+require_relative './item/with_feed_item_request_builder'
+
+module Rixl
+    module Feeds
+        ## 
+        # Builds and executes requests for operations under \feeds
+        class FeedsRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+            
+            ## 
+            ## Gets an item from the rixl.feeds.item collection
+            ## @param feed_id Feed ID
+            ## @return a with_feed_item_request_builder
+            ## 
+            def by_feed_id(feed_id)
+                raise StandardError, 'feed_id cannot be null' if feed_id.nil?
+                url_tpl_params = @path_parameters.clone
+                url_tpl_params["feedId"] = feed_id
+                return Rixl::Feeds::Item::WithFeedItemRequestBuilder.new(url_tpl_params, @request_adapter)
+            end
+            ## 
+            ## Instantiates a new FeedsRequestBuilder and sets the default values.
+            ## @param path_parameters Path parameters for the request
+            ## @param request_adapter The request adapter to use to execute the requests.
+            ## @return a void
+            ## 
+            def initialize(path_parameters, request_adapter)
+                super(path_parameters, request_adapter, "{+baseurl}/feeds")
+            end
+        end
+    end
+end

data/lib/feeds/item/creators/creators_request_builder.rb

@@ -0,0 +1,40 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../../../rixl'
+require_relative '../../feeds'
+require_relative '../item'
+require_relative './creators'
+require_relative './item/with_creator_item_request_builder'
+
+module Rixl
+    module Feeds
+        module Item
+            module Creators
+                ## 
+                # Builds and executes requests for operations under \feeds\{feedId}\creators
+                class CreatorsRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+                    
+                    ## 
+                    ## Gets an item from the rixl.feeds.item.creators.item collection
+                    ## @param creator_id Creator ID
+                    ## @return a with_creator_item_request_builder
+                    ## 
+                    def by_creator_id(creator_id)
+                        raise StandardError, 'creator_id cannot be null' if creator_id.nil?
+                        url_tpl_params = @path_parameters.clone
+                        url_tpl_params["creatorId"] = creator_id
+                        return Rixl::Feeds::Item::Creators::Item::WithCreatorItemRequestBuilder.new(url_tpl_params, @request_adapter)
+                    end
+                    ## 
+                    ## Instantiates a new CreatorsRequestBuilder and sets the default values.
+                    ## @param path_parameters Path parameters for the request
+                    ## @param request_adapter The request adapter to use to execute the requests.
+                    ## @return a void
+                    ## 
+                    def initialize(path_parameters, request_adapter)
+                        super(path_parameters, request_adapter, "{+baseurl}/feeds/{feedId}/creators")
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/feeds/item/creators/item/with_creator_item_request_builder.rb

@@ -0,0 +1,86 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../../../../models/github_com_rixlhq_api_internal_errors_error_response'
+require_relative '../../../../models/pagination_paginated_response_post'
+require_relative '../../../../rixl'
+require_relative '../../../feeds'
+require_relative '../../item'
+require_relative '../creators'
+require_relative './item'
+
+module Rixl
+    module Feeds
+        module Item
+            module Creators
+                module Item
+                    ## 
+                    # Builds and executes requests for operations under \feeds\{feedId}\creators\{creatorId}
+                    class WithCreatorItemRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+                        
+                        ## 
+                        ## Instantiates a new WithCreatorItemRequestBuilder and sets the default values.
+                        ## @param path_parameters Path parameters for the request
+                        ## @param request_adapter The request adapter to use to execute the requests.
+                        ## @return a void
+                        ## 
+                        def initialize(path_parameters, request_adapter)
+                            super(path_parameters, request_adapter, "{+baseurl}/feeds/{feedId}/creators/{creatorId}{?limit*,offset*}")
+                        end
+                        ## 
+                        ## Retrieve posts in a feed by a specific creator, with pagination.
+                        ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                        ## @return a Fiber of pagination_paginated_response_post
+                        ## 
+                        def get(request_configuration=nil)
+                            request_info = self.to_get_request_information(
+                                request_configuration
+                            )
+                            error_mapping = Hash.new
+                            error_mapping["400"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                            error_mapping["500"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                            return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::PaginationPaginatedResponsePost.create_from_discriminator_value(pn) }, error_mapping)
+                        end
+                        ## 
+                        ## Retrieve posts in a feed by a specific creator, with pagination.
+                        ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                        ## @return a request_information
+                        ## 
+                        def to_get_request_information(request_configuration=nil)
+                            request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
+                            unless request_configuration.nil?
+                                request_info.add_headers_from_raw_object(request_configuration.headers)
+                                request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
+                                request_info.add_request_options(request_configuration.options)
+                            end
+                            request_info.url_template = @url_template
+                            request_info.path_parameters = @path_parameters
+                            request_info.http_method = :GET
+                            request_info.headers.try_add('Accept', 'application/json')
+                            return request_info
+                        end
+                        ## 
+                        ## Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+                        ## @param raw_url The raw URL to use for the request builder.
+                        ## @return a with_creator_item_request_builder
+                        ## 
+                        def with_url(raw_url)
+                            raise StandardError, 'raw_url cannot be null' if raw_url.nil?
+                            return WithCreatorItemRequestBuilder.new(raw_url, @request_adapter)
+                        end
+
+                        ## 
+                        # Retrieve posts in a feed by a specific creator, with pagination.
+                        class WithCreatorItemRequestBuilderGetQueryParameters
+                            
+                            ## 
+                            # Maximum number of items to return in a single request. <br> **Default:** `25`
+                            attr_accessor :limit
+                            ## 
+                            # Starting point of the result set. <br>To get page 2 with a limit of 25, set `offset` to `25`. <br> **Default:** `0`
+                            attr_accessor :offset
+                        end
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/feeds/item/item/with_post_item_request_builder.rb

@@ -0,0 +1,70 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../../../models/github_com_rixlhq_api_internal_errors_error_response'
+require_relative '../../../models/post'
+require_relative '../../../rixl'
+require_relative '../../feeds'
+require_relative '../item'
+require_relative './item'
+
+module Rixl
+    module Feeds
+        module Item
+            module Item
+                ## 
+                # Builds and executes requests for operations under \feeds\{feedId}\{postId}
+                class WithPostItemRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+                    
+                    ## 
+                    ## Instantiates a new WithPostItemRequestBuilder and sets the default values.
+                    ## @param path_parameters Path parameters for the request
+                    ## @param request_adapter The request adapter to use to execute the requests.
+                    ## @return a void
+                    ## 
+                    def initialize(path_parameters, request_adapter)
+                        super(path_parameters, request_adapter, "{+baseurl}/feeds/{feedId}/{postId}")
+                    end
+                    ## 
+                    ## Retrieve a post from feed by its ID
+                    ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                    ## @return a Fiber of post
+                    ## 
+                    def get(request_configuration=nil)
+                        request_info = self.to_get_request_information(
+                            request_configuration
+                        )
+                        error_mapping = Hash.new
+                        error_mapping["400"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                        error_mapping["404"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                        return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::Post.create_from_discriminator_value(pn) }, error_mapping)
+                    end
+                    ## 
+                    ## Retrieve a post from feed by its ID
+                    ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                    ## @return a request_information
+                    ## 
+                    def to_get_request_information(request_configuration=nil)
+                        request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
+                        unless request_configuration.nil?
+                            request_info.add_headers_from_raw_object(request_configuration.headers)
+                            request_info.add_request_options(request_configuration.options)
+                        end
+                        request_info.url_template = @url_template
+                        request_info.path_parameters = @path_parameters
+                        request_info.http_method = :GET
+                        request_info.headers.try_add('Accept', 'application/json')
+                        return request_info
+                    end
+                    ## 
+                    ## Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+                    ## @param raw_url The raw URL to use for the request builder.
+                    ## @return a with_post_item_request_builder
+                    ## 
+                    def with_url(raw_url)
+                        raise StandardError, 'raw_url cannot be null' if raw_url.nil?
+                        return WithPostItemRequestBuilder.new(raw_url, @request_adapter)
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/feeds/item/with_feed_item_request_builder.rb

@@ -0,0 +1,98 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../../models/github_com_rixlhq_api_internal_errors_error_response'
+require_relative '../../models/pagination_paginated_response_post'
+require_relative '../../rixl'
+require_relative '../feeds'
+require_relative './creators/creators_request_builder'
+require_relative './item'
+require_relative './item/with_post_item_request_builder'
+
+module Rixl
+    module Feeds
+        module Item
+            ## 
+            # Builds and executes requests for operations under \feeds\{feedId}
+            class WithFeedItemRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+                
+                ## 
+                # The creators property
+                def creators()
+                    return Rixl::Feeds::Item::Creators::CreatorsRequestBuilder.new(@path_parameters, @request_adapter)
+                end
+                ## 
+                ## Gets an item from the rixl.feeds.item.item collection
+                ## @param post_id Post ID
+                ## @return a with_post_item_request_builder
+                ## 
+                def by_post_id(post_id)
+                    raise StandardError, 'post_id cannot be null' if post_id.nil?
+                    url_tpl_params = @path_parameters.clone
+                    url_tpl_params["postId"] = post_id
+                    return Rixl::Feeds::Item::Item::WithPostItemRequestBuilder.new(url_tpl_params, @request_adapter)
+                end
+                ## 
+                ## Instantiates a new WithFeedItemRequestBuilder and sets the default values.
+                ## @param path_parameters Path parameters for the request
+                ## @param request_adapter The request adapter to use to execute the requests.
+                ## @return a void
+                ## 
+                def initialize(path_parameters, request_adapter)
+                    super(path_parameters, request_adapter, "{+baseurl}/feeds/{feedId}{?limit*,offset*}")
+                end
+                ## 
+                ## Retrieve posts in a feed, with pagination.
+                ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                ## @return a Fiber of pagination_paginated_response_post
+                ## 
+                def get(request_configuration=nil)
+                    request_info = self.to_get_request_information(
+                        request_configuration
+                    )
+                    error_mapping = Hash.new
+                    error_mapping["400"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                    error_mapping["500"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                    return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::PaginationPaginatedResponsePost.create_from_discriminator_value(pn) }, error_mapping)
+                end
+                ## 
+                ## Retrieve posts in a feed, with pagination.
+                ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+                ## @return a request_information
+                ## 
+                def to_get_request_information(request_configuration=nil)
+                    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
+                    unless request_configuration.nil?
+                        request_info.add_headers_from_raw_object(request_configuration.headers)
+                        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
+                        request_info.add_request_options(request_configuration.options)
+                    end
+                    request_info.url_template = @url_template
+                    request_info.path_parameters = @path_parameters
+                    request_info.http_method = :GET
+                    request_info.headers.try_add('Accept', 'application/json')
+                    return request_info
+                end
+                ## 
+                ## Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+                ## @param raw_url The raw URL to use for the request builder.
+                ## @return a with_feed_item_request_builder
+                ## 
+                def with_url(raw_url)
+                    raise StandardError, 'raw_url cannot be null' if raw_url.nil?
+                    return WithFeedItemRequestBuilder.new(raw_url, @request_adapter)
+                end
+
+                ## 
+                # Retrieve posts in a feed, with pagination.
+                class WithFeedItemRequestBuilderGetQueryParameters
+                    
+                    ## 
+                    # Maximum number of items to return in a single request. <br> **Default:** `25`
+                    attr_accessor :limit
+                    ## 
+                    # Starting point of the result set. <br>To get page 2 with a limit of 25, set `offset` to `25`. <br> **Default:** `0`
+                    attr_accessor :offset
+                end
+            end
+        end
+    end
+end

data/lib/images/images_request_builder.rb

@@ -0,0 +1,103 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../models/github_com_rixlhq_api_internal_errors_error_response'
+require_relative '../models/pagination_paginated_response_image'
+require_relative '../rixl'
+require_relative './images'
+require_relative './item/with_image_item_request_builder'
+require_relative './upload/upload_request_builder'
+
+module Rixl
+    module Images
+        ## 
+        # Builds and executes requests for operations under \images
+        class ImagesRequestBuilder < MicrosoftKiotaAbstractions::BaseRequestBuilder
+            
+            ## 
+            # The upload property
+            def upload()
+                return Rixl::Images::Upload::UploadRequestBuilder.new(@path_parameters, @request_adapter)
+            end
+            ## 
+            ## Gets an item from the rixl.images.item collection
+            ## @param image_id Image ID
+            ## @return a with_image_item_request_builder
+            ## 
+            def by_image_id(image_id)
+                raise StandardError, 'image_id cannot be null' if image_id.nil?
+                url_tpl_params = @path_parameters.clone
+                url_tpl_params["imageId"] = image_id
+                return Rixl::Images::Item::WithImageItemRequestBuilder.new(url_tpl_params, @request_adapter)
+            end
+            ## 
+            ## Instantiates a new ImagesRequestBuilder and sets the default values.
+            ## @param path_parameters Path parameters for the request
+            ## @param request_adapter The request adapter to use to execute the requests.
+            ## @return a void
+            ## 
+            def initialize(path_parameters, request_adapter)
+                super(path_parameters, request_adapter, "{+baseurl}/images{?limit*,offset*,order*,sort*}")
+            end
+            ## 
+            ## Retrieve all images for a specific project, with pagination and sorting.
+            ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+            ## @return a Fiber of pagination_paginated_response_image
+            ## 
+            def get(request_configuration=nil)
+                request_info = self.to_get_request_information(
+                    request_configuration
+                )
+                error_mapping = Hash.new
+                error_mapping["400"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                error_mapping["401"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                error_mapping["403"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                error_mapping["500"] = lambda {|pn| Rixl::Models::Github_com_rixlhq_api_internal_errorsErrorResponse.create_from_discriminator_value(pn) }
+                return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::PaginationPaginatedResponseImage.create_from_discriminator_value(pn) }, error_mapping)
+            end
+            ## 
+            ## Retrieve all images for a specific project, with pagination and sorting.
+            ## @param request_configuration Configuration for the request such as headers, query parameters, and middleware options.
+            ## @return a request_information
+            ## 
+            def to_get_request_information(request_configuration=nil)
+                request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
+                unless request_configuration.nil?
+                    request_info.add_headers_from_raw_object(request_configuration.headers)
+                    request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
+                    request_info.add_request_options(request_configuration.options)
+                end
+                request_info.url_template = @url_template
+                request_info.path_parameters = @path_parameters
+                request_info.http_method = :GET
+                request_info.headers.try_add('Accept', 'application/json')
+                return request_info
+            end
+            ## 
+            ## Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+            ## @param raw_url The raw URL to use for the request builder.
+            ## @return a images_request_builder
+            ## 
+            def with_url(raw_url)
+                raise StandardError, 'raw_url cannot be null' if raw_url.nil?
+                return ImagesRequestBuilder.new(raw_url, @request_adapter)
+            end
+
+            ## 
+            # Retrieve all images for a specific project, with pagination and sorting.
+            class ImagesRequestBuilderGetQueryParameters
+                
+                ## 
+                # Maximum number of items to return in a single request. <br> **Default:** `25`
+                attr_accessor :limit
+                ## 
+                # Starting point of the result set. <br>To get page 2 with a limit of 25, set `offset` to `25`. <br> **Default:** `0`
+                attr_accessor :offset
+                ## 
+                # Sort order (asc, desc)
+                attr_accessor :order
+                ## 
+                # Field to sort by (created_at, name, size, updated_at)
+                attr_accessor :sort
+            end
+        end
+    end
+end