melaya 0.1.2 → 0.2.0

data/lib/melaya/team.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Melaya
+  # Team API — manage project team membership, roles, and invitations.
+  #
+  # Maps to:
+  #   /api/v1/private/projects/:project/members/*
+  #   /api/v1/private/team/*
+  #   /api/v1/private/projects/:project/pipelines/:pipeline/visibility
+  #
+  # @example
+  #   members = melaya.team.list_members("my-project")
+  #   melaya.team.invite("my-project", username: "alice")
+  #   link = melaya.team.create_invite_link("my-project")
+  class TeamAPI
+    def initialize(http)
+      @http = http
+    end
+
+    # GET /api/v1/private/projects/:project/members
+    # List members of a project team.
+    # @param project [String] project name
+    def list_members(project)
+      @http.get("/api/v1/private/projects/#{enc(project)}/members")
+    end
+
+    # POST /api/v1/private/projects/:project/members/invite
+    # Invite a user to a project team by username.
+    # @param project [String]
+    # @param username [String]
+    def invite(project, username:)
+      @http.post("/api/v1/private/projects/#{enc(project)}/members/invite",
+        "username" => username)
+    end
+
+    # POST /api/v1/private/projects/:project/invite-link
+    # Create a shareable invite link for a project.
+    # Returns the URL to send to new team members.
+    # @param project [String]
+    def create_invite_link(project)
+      @http.post("/api/v1/private/projects/#{enc(project)}/invite-link")
+    end
+
+    # POST /api/v1/private/team/invite/accept
+    # Accept a project invite using the token from an invite link.
+    # @param token [String]
+    def accept_invite(token)
+      @http.post("/api/v1/private/team/invite/accept", "token" => token)
+    end
+
+    # PATCH /api/v1/private/projects/:project/members/:userId
+    # Update a team member's role in a project.
+    # @param project [String]
+    # @param user_id [String]
+    # @param role [String] one of "owner", "editor", "viewer"
+    def update_member_role(project, user_id, role:)
+      @http.patch(
+        "/api/v1/private/projects/#{enc(project)}/members/#{enc(user_id)}",
+        "role" => role
+      )
+    end
+
+    # DELETE /api/v1/private/projects/:project/members/:userId
+    # Remove a member from a project team.
+    # @param project [String]
+    # @param user_id [String]
+    def remove_member(project, user_id)
+      @http.delete("/api/v1/private/projects/#{enc(project)}/members/#{enc(user_id)}")
+    end
+
+    # ── Pipeline visibility ────────────────────────────────────────────────────
+
+    # GET /api/v1/private/projects/:project/pipelines/:pipeline/visibility
+    # Get visibility settings for a pipeline within a project.
+    # @param project [String]
+    # @param pipeline [String]
+    def get_pipeline_visibility(project, pipeline)
+      @http.get(
+        "/api/v1/private/projects/#{enc(project)}/pipelines/#{enc(pipeline)}/visibility"
+      )
+    end
+
+    # PUT /api/v1/private/projects/:project/pipelines/:pipeline/visibility
+    # Set pipeline visibility within a project.
+    # @param project [String]
+    # @param pipeline [String]
+    # @param body [Hash]
+    def set_pipeline_visibility(project, pipeline, body = {})
+      @http.put(
+        "/api/v1/private/projects/#{enc(project)}/pipelines/#{enc(pipeline)}/visibility",
+        body
+      )
+    end
+
+    private
+
+    def enc(s)
+      URI.encode_www_form_component(s.to_s)
+    end
+  end
+end
+

data/lib/melaya/templates.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Melaya
+  # Templates API — create, manage, share, and assign pipeline templates.
+  #
+  # Templates bundle a pipeline definition into a reusable, shareable artifact.
+  # Visibility levels: private → team → community → assigned.
+  #
+  # Maps to:
+  #   /api/v1/private/user-templates/*    — CRUD + share + assignments
+  #   /api/v1/private/templates/*         — global/validated lists
+  #
+  # @example
+  #   templates = melaya.templates.list
+  #   t = melaya.templates.save(name: "My report", payload: { steps: [] })
+  #   melaya.templates.share(t["id"], "team")
+  #   melaya.templates.delete(t["id"])
+  class TemplatesAPI
+    def initialize(http)
+      @http = http
+    end
+
+    # GET /api/v1/private/user-templates
+    # List all templates visible to the caller (own + team + community + assigned).
+    def list
+      @http.get("/api/v1/private/user-templates")
+    end
+
+    # GET /api/v1/private/templates/global
+    # List all community-visibility (global) templates.
+    def list_global
+      @http.get("/api/v1/private/templates/global")
+    end
+
+    # GET /api/v1/private/templates/validated
+    # List IDs of all validated (platform-approved) templates.
+    def list_validated
+      @http.get("/api/v1/private/templates/validated")
+    end
+
+    # POST /api/v1/private/user-templates
+    # Create a new private user template.
+    # @param name [String]
+    # @param payload [Hash]
+    # @param description [String, nil]
+    # @param category [String, nil]
+    def save(name:, payload:, description: nil, category: nil)
+      body = compact(
+        "name"        => name,
+        "payload"     => payload,
+        "description" => description,
+        "category"    => category
+      )
+      @http.post("/api/v1/private/user-templates", body)
+    end
+
+    # PATCH /api/v1/private/user-templates/:id
+    # Update name/description/category/payload of a private user template.
+    # @param template_id [String]
+    # @param body [Hash]
+    def update(template_id, body = {})
+      @http.patch("/api/v1/private/user-templates/#{enc(template_id)}", body)
+    end
+
+    # POST /api/v1/private/user-templates/:sourceId/duplicate
+    # Duplicate a readable template into the caller's private library.
+    # @param template_id [String] the source template to copy
+    # @param new_name [String, nil]
+    def duplicate(template_id, new_name: nil)
+      body = new_name ? { "newName" => new_name } : nil
+      @http.post("/api/v1/private/user-templates/#{enc(template_id)}/duplicate", body)
+    end
+
+    # DELETE /api/v1/private/user-templates/:id
+    # Delete (or soft-demote if shared) a template.
+    # @param template_id [String]
+    def delete(template_id)
+      @http.delete("/api/v1/private/user-templates/#{enc(template_id)}")
+    end
+
+    # PUT /api/v1/private/user-templates/:id/visibility
+    # Change the visibility of a template.
+    # @param template_id [String]
+    # @param visibility [String] "private", "team", "community", or "assigned"
+    def share(template_id, visibility)
+      @http.put("/api/v1/private/user-templates/#{enc(template_id)}/visibility",
+        "visibility" => visibility)
+    end
+
+    # GET /api/v1/private/user-templates/share-targets
+    # List projects the caller is a member of (for the share target picker UI).
+    def share_targets
+      @http.get("/api/v1/private/user-templates/share-targets")
+    end
+
+    # ── Assignments ────────────────────────────────────────────────────────────
+
+    # GET /api/v1/private/user-templates/:templateId/assignments
+    # List all assignments (users / projects) for a template.
+    # @param template_id [String]
+    def list_assignments(template_id)
+      @http.get("/api/v1/private/user-templates/#{enc(template_id)}/assignments")
+    end
+
+    # POST /api/v1/private/user-templates/:templateId/assignments
+    # Assign a template to a user or project.
+    # Provide exactly one of +user_id:+ or +project_id:+ (both UUIDs);
+    # the server rejects requests carrying both or neither.
+    # @param template_id [String]
+    # @param user_id [String, nil] target user UUID
+    # @param project_id [String, nil] target project UUID
+    def assign(template_id, user_id: nil, project_id: nil)
+      @http.post("/api/v1/private/user-templates/#{enc(template_id)}/assignments",
+        assignment_target(user_id, project_id))
+    end
+
+    # DELETE /api/v1/private/user-templates/:templateId/assignments
+    # Remove an assignment from a template.
+    # Provide exactly one of +user_id:+ or +project_id:+ (both UUIDs).
+    # The target is sent as query params — the server ignores DELETE
+    # request bodies.
+    # @param template_id [String]
+    # @param user_id [String, nil] target user UUID
+    # @param project_id [String, nil] target project UUID
+    def unassign(template_id, user_id: nil, project_id: nil)
+      @http.delete("/api/v1/private/user-templates/#{enc(template_id)}/assignments",
+        assignment_target(user_id, project_id))
+    end
+
+    private
+
+    # Exactly one of user_id / project_id must be given.
+    def assignment_target(user_id, project_id)
+      if user_id.nil? == project_id.nil?
+        raise ArgumentError, "Melaya: provide exactly one of user_id: or project_id:"
+      end
+      user_id ? { "userId" => user_id } : { "projectId" => project_id }
+    end
+
+    def enc(s)
+      URI.encode_www_form_component(s.to_s)
+    end
+
+    def compact(hash)
+      hash.reject { |_, v| v.nil? }
+    end
+  end
+end

data/lib/melaya/trade.rb

@@ -1,168 +1,168 @@
-# frozen_string_literal: true
-
-module Melaya
-  # Live trading API — credentialed order placement, account state, and
-  # position management on a CONNECTED exchange.
-  #
-  # Every method POSTs to +https://api.melaya.org/api/v1/private/<op>+; the server
-  # resolves your connected exchange credential (referenced by +api_key_id+ — see
-  # AccountAPI#keys) and forwards the call to the venue through Melaya's in-house
-  # Rust engine. Responses share an envelope:
-  # +{ ok, exchange, operation, orderId, clientOrderId, payload, data, ... }+.
-  #
-  # WARNING: these hit the REAL venue with REAL funds. The write methods
-  # (create_order, cancel_order, amend_order, cancel_all_orders, cancel_plan_orders,
-  # close_position, set_leverage, set_margin_mode, set_position_mode) move money or
-  # change account state. For risk-free testing use the sim (paper) broker or a
-  # paper strategy instead.
-  class TradeAPI
-    def initialize(http)
-      @http = http
-    end
-
-    # ── Account state (reads) ──────────────────────────────────────────────────
-
-    # Live account balance on a connected venue.
-    def balance(exchange:, api_key_id: nil, key_id: nil, market_type: nil, params: nil)
-      op("balance", exchange: exchange, apiKeyId: api_key_id, keyId: key_id,
-         marketType: market_type, params: params)
-    end
-
-    # Live open positions.
-    def positions(exchange:, api_key_id: nil, market_type: nil, symbol: nil, params: nil)
-      op("positions", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol, params: params)
-    end
-
-    # Historical positions (venue-dependent).
-    def positions_history(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("positions-history", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Resting (open) orders.
-    def open_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("open-orders", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # All orders (open + recent).
-    def orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("orders", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Closed/filled orders.
-    def closed_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("closed-orders", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Your trade (fill) history.
-    def my_trades(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("my-trades", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Extended trade history (venue-dependent).
-    def my_trades_history(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("my-trades-history", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Resting conditional/plan (trigger) orders.
-    def plan_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
-      op("plan-orders", exchange: exchange, apiKeyId: api_key_id,
-         marketType: market_type, symbol: symbol)
-    end
-
-    # Current leverage for a symbol.
-    def leverage(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
-      op("leverage", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # Leverage tiers / brackets for a symbol.
-    def leverage_tiers(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
-      op("leverage-tiers", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # ── Order placement & management (LIVE writes — real funds) ───────────────
-
-    # Place a live order on the venue. WARNING: real money.
-    # stop_price, take_profit_price, and reduce_only are folded into +params+.
-    def create_order(exchange:, symbol:, side:, amount:,
-                     api_key_id: nil, type: "market", price: nil,
-                     market_type: nil, stop_price: nil, take_profit_price: nil,
-                     reduce_only: nil, leverage: nil, client_order_id: nil, params: nil)
-      p = (params || {}).dup
-      p["stopPrice"]       = stop_price       unless stop_price.nil?
-      p["takeProfitPrice"] = take_profit_price unless take_profit_price.nil?
-      p["reduceOnly"]      = reduce_only       unless reduce_only.nil?
-      op("create-order",
-         exchange: exchange, apiKeyId: api_key_id, symbol: symbol,
-         side: side, amount: amount, type: type, price: price,
-         marketType: market_type, leverage: leverage,
-         clientOrderId: client_order_id, params: p.empty? ? nil : p)
-    end
-
-    # Cancel a live order by id. WARNING.
-    def cancel_order(exchange:, api_key_id: nil, order_id: nil, client_order_id: nil,
-                     symbol: nil, market_type: nil)
-      op("cancel-order", exchange: exchange, apiKeyId: api_key_id,
-         orderId: order_id, clientOrderId: client_order_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # Amend (modify) a live order. WARNING.
-    def amend_order(exchange:, api_key_id: nil, order_id: nil, symbol: nil,
-                    amount: nil, price: nil)
-      op("amend-order", exchange: exchange, apiKeyId: api_key_id,
-         orderId: order_id, symbol: symbol, amount: amount, price: price)
-    end
-
-    # Cancel every open order (optionally scoped to a symbol). WARNING.
-    def cancel_all_orders(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
-      op("cancel-all-orders", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # Cancel resting plan/trigger orders. WARNING.
-    def cancel_plan_orders(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
-      op("cancel-plan-orders", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # Close an open position (market reduce-only). WARNING.
-    def close_position(exchange:, symbol:, api_key_id: nil, market_type: nil)
-      op("close-position", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, marketType: market_type)
-    end
-
-    # Set leverage for a symbol. WARNING.
-    def set_leverage(exchange:, symbol:, leverage:, api_key_id: nil, market_type: nil)
-      op("set-leverage", exchange: exchange, apiKeyId: api_key_id,
-         symbol: symbol, leverage: leverage, marketType: market_type)
-    end
-
-    # Set margin mode (cross/isolated). WARNING.
-    def set_margin_mode(exchange:, margin_mode:, api_key_id: nil, symbol: nil, market_type: nil)
-      op("set-margin-mode", exchange: exchange, apiKeyId: api_key_id,
-         marginMode: margin_mode, symbol: symbol, marketType: market_type)
-    end
-
-    # Set position mode (one-way / hedge). WARNING.
-    def set_position_mode(exchange:, api_key_id: nil, hedged: nil, mode: nil, market_type: nil)
-      op("set-position-mode", exchange: exchange, apiKeyId: api_key_id,
-         hedged: hedged, mode: mode, marketType: market_type)
-    end
-
-    private
-
-    def op(path_op, **kwargs)
-      body = kwargs.reject { |_, v| v.nil? }
-      @http.post("/api/v1/private/#{path_op}", body)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Melaya
+  # Live trading API — credentialed order placement, account state, and
+  # position management on a CONNECTED exchange.
+  #
+  # Every method POSTs to +https://api.melaya.org/api/v1/private/<op>+; the server
+  # resolves your connected exchange credential (referenced by +api_key_id+ — see
+  # AccountAPI#keys) and forwards the call to the venue through Melaya's in-house
+  # Rust engine. Responses share an envelope:
+  # +{ ok, exchange, operation, orderId, clientOrderId, payload, data, ... }+.
+  #
+  # WARNING: these hit the REAL venue with REAL funds. The write methods
+  # (create_order, cancel_order, amend_order, cancel_all_orders, cancel_plan_orders,
+  # close_position, set_leverage, set_margin_mode, set_position_mode) move money or
+  # change account state. For risk-free testing use the sim (paper) broker or a
+  # paper strategy instead.
+  class TradeAPI
+    def initialize(http)
+      @http = http
+    end
+
+    # ── Account state (reads) ──────────────────────────────────────────────────
+
+    # Live account balance on a connected venue.
+    def balance(exchange:, api_key_id: nil, key_id: nil, market_type: nil, params: nil)
+      op("balance", exchange: exchange, apiKeyId: api_key_id, keyId: key_id,
+         marketType: market_type, params: params)
+    end
+
+    # Live open positions.
+    def positions(exchange:, api_key_id: nil, market_type: nil, symbol: nil, params: nil)
+      op("positions", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol, params: params)
+    end
+
+    # Historical positions (venue-dependent).
+    def positions_history(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("positions-history", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Resting (open) orders.
+    def open_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("open-orders", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # All orders (open + recent).
+    def orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("orders", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Closed/filled orders.
+    def closed_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("closed-orders", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Your trade (fill) history.
+    def my_trades(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("my-trades", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Extended trade history (venue-dependent).
+    def my_trades_history(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("my-trades-history", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Resting conditional/plan (trigger) orders.
+    def plan_orders(exchange:, api_key_id: nil, market_type: nil, symbol: nil)
+      op("plan-orders", exchange: exchange, apiKeyId: api_key_id,
+         marketType: market_type, symbol: symbol)
+    end
+
+    # Current leverage for a symbol.
+    def leverage(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
+      op("leverage", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # Leverage tiers / brackets for a symbol.
+    def leverage_tiers(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
+      op("leverage-tiers", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # ── Order placement & management (LIVE writes — real funds) ───────────────
+
+    # Place a live order on the venue. WARNING: real money.
+    # stop_price, take_profit_price, and reduce_only are folded into +params+.
+    def create_order(exchange:, symbol:, side:, amount:,
+                     api_key_id: nil, type: "market", price: nil,
+                     market_type: nil, stop_price: nil, take_profit_price: nil,
+                     reduce_only: nil, leverage: nil, client_order_id: nil, params: nil)
+      p = (params || {}).dup
+      p["stopPrice"]       = stop_price       unless stop_price.nil?
+      p["takeProfitPrice"] = take_profit_price unless take_profit_price.nil?
+      p["reduceOnly"]      = reduce_only       unless reduce_only.nil?
+      op("create-order",
+         exchange: exchange, apiKeyId: api_key_id, symbol: symbol,
+         side: side, amount: amount, type: type, price: price,
+         marketType: market_type, leverage: leverage,
+         clientOrderId: client_order_id, params: p.empty? ? nil : p)
+    end
+
+    # Cancel a live order by id. WARNING.
+    def cancel_order(exchange:, api_key_id: nil, order_id: nil, client_order_id: nil,
+                     symbol: nil, market_type: nil)
+      op("cancel-order", exchange: exchange, apiKeyId: api_key_id,
+         orderId: order_id, clientOrderId: client_order_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # Amend (modify) a live order. WARNING.
+    def amend_order(exchange:, api_key_id: nil, order_id: nil, symbol: nil,
+                    amount: nil, price: nil)
+      op("amend-order", exchange: exchange, apiKeyId: api_key_id,
+         orderId: order_id, symbol: symbol, amount: amount, price: price)
+    end
+
+    # Cancel every open order (optionally scoped to a symbol). WARNING.
+    def cancel_all_orders(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
+      op("cancel-all-orders", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # Cancel resting plan/trigger orders. WARNING.
+    def cancel_plan_orders(exchange:, api_key_id: nil, symbol: nil, market_type: nil)
+      op("cancel-plan-orders", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # Close an open position (market reduce-only). WARNING.
+    def close_position(exchange:, symbol:, api_key_id: nil, market_type: nil)
+      op("close-position", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, marketType: market_type)
+    end
+
+    # Set leverage for a symbol. WARNING.
+    def set_leverage(exchange:, symbol:, leverage:, api_key_id: nil, market_type: nil)
+      op("set-leverage", exchange: exchange, apiKeyId: api_key_id,
+         symbol: symbol, leverage: leverage, marketType: market_type)
+    end
+
+    # Set margin mode (cross/isolated). WARNING.
+    def set_margin_mode(exchange:, margin_mode:, api_key_id: nil, symbol: nil, market_type: nil)
+      op("set-margin-mode", exchange: exchange, apiKeyId: api_key_id,
+         marginMode: margin_mode, symbol: symbol, marketType: market_type)
+    end
+
+    # Set position mode (one-way / hedge). WARNING.
+    def set_position_mode(exchange:, api_key_id: nil, hedged: nil, mode: nil, market_type: nil)
+      op("set-position-mode", exchange: exchange, apiKeyId: api_key_id,
+         hedged: hedged, mode: mode, marketType: market_type)
+    end
+
+    private
+
+    def op(path_op, **kwargs)
+      body = kwargs.reject { |_, v| v.nil? }
+      @http.post("/api/v1/private/#{path_op}", body)
+    end
+  end
+end

data/lib/melaya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Melaya
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end