wefunder 1.0.1 → 1.1.0

data/lib/wefunder_generated/api/partner_invites_sessions_api.rb

@@ -0,0 +1,374 @@
+=begin
+#Wefunder API v2
+
+#OAuth 2.0 API for accessing Wefunder data programmatically.  ## Authentication  This API uses OAuth 2.0 for authentication. To get started:  1. Create an OAuth application at `/oauth/applications` 2. Get your Client ID and Client Secret 3. Implement the OAuth 2.0 Authorization Code flow 4. Use the access token to make API requests  ## Versioning  The API is versioned by the dated `Wefunder-Version` request header (`YYYY-MM-DD`), never by the URL. Resolution is header → your application's pinned version → latest; every response carries `Wefunder-Version` (the version that handled it) and `Wefunder-Version-Latest`. An unknown value returns `400 invalid_request` naming the valid versions. Current: `2026-10-01`.  ## Rate Limits  - Standard API: 1,000 requests/hour per token - Admin API: 10,000 requests/hour per token  ## Base URL  All API requests should be made to: `https://api.wefunder.com` (no version in the path). 
+
+The version of the OpenAPI document: 2.0
+Contact: api@wefunder.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module WefunderGenerated
+  class PartnerInvitesSessionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Cancel an investment session
+    # Alias of `/partner/investment_sessions` (#23636).  Cancels a session so its link stops working. Valid while the session is `pending`, `in_progress`, or `abandoned`; repeating the call on an already-canceled session returns the same 200. A `completed` or `expired` session cannot be canceled (422 `session_not_cancelable`). 
+    # @param id [String] The investment session ID (prefixed, e.g. `is_abc123`)
+    # @param [Hash] opts the optional parameters
+    # @return [InvestmentSessionEnvelope]
+    def cancel_investment_session(id, opts = {})
+      data, _status_code, _headers = cancel_investment_session_with_http_info(id, opts)
+      data
+    end
+
+    # Cancel an investment session
+    # Alias of `/partner/investment_sessions` (#23636).  Cancels a session so its link stops working. Valid while the session is `pending`, `in_progress`, or `abandoned`; repeating the call on an already-canceled session returns the same 200. A `completed` or `expired` session cannot be canceled (422 `session_not_cancelable`). 
+    # @param id [String] The investment session ID (prefixed, e.g. `is_abc123`)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvestmentSessionEnvelope, Integer, Hash)>] InvestmentSessionEnvelope data, response status code and response headers
+    def cancel_investment_session_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PartnerInvitesSessionsApi.cancel_investment_session ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PartnerInvitesSessionsApi.cancel_investment_session"
+      end
+      # resource path
+      local_var_path = '/investment_sessions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvestmentSessionEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PartnerInvitesSessionsApi.cancel_investment_session",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PartnerInvitesSessionsApi#cancel_investment_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an investment session
+    # Canonical path: the offering comes from the URL, so `spv_id` may be omitted from the body (if sent it must match, else 422 `offering_mismatch`). Authorized for any offering the caller may act on (an install on its syndicate or company, a role on it, or created by your app).  Creates a single-use, recipient-specific hosted investment session (analogous to a Stripe Checkout Session) on the SPV named by `spv_id` in the body. The session walks one investor through accreditation, document signing, and payment, and produces a durable `Investment` on success. Returns a `url` the recipient opens to begin. If the recipient already has an active session on the SPV, that session is returned instead of creating a duplicate; if another app holds that recipient's active session there, the create is refused with 409 `session_conflict` (a recipient has one active session per offering). 
+    # @param id [String] The SPV ID (prefixed, e.g. &#x60;spv_abc123&#x60;)
+    # @param create_offering_investment_session_request [CreateOfferingInvestmentSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key A unique client-generated key that makes a write request safe to retry. If a request is retried within 24 hours with the same key and body, the original result is returned instead of performing the operation again. Strongly recommended on all &#x60;POST&#x60; requests that create resources. 
+    # @return [InvestmentSessionEnvelope]
+    def create_offering_investment_session(id, create_offering_investment_session_request, opts = {})
+      data, _status_code, _headers = create_offering_investment_session_with_http_info(id, create_offering_investment_session_request, opts)
+      data
+    end
+
+    # Create an investment session
+    # Canonical path: the offering comes from the URL, so &#x60;spv_id&#x60; may be omitted from the body (if sent it must match, else 422 &#x60;offering_mismatch&#x60;). Authorized for any offering the caller may act on (an install on its syndicate or company, a role on it, or created by your app).  Creates a single-use, recipient-specific hosted investment session (analogous to a Stripe Checkout Session) on the SPV named by &#x60;spv_id&#x60; in the body. The session walks one investor through accreditation, document signing, and payment, and produces a durable &#x60;Investment&#x60; on success. Returns a &#x60;url&#x60; the recipient opens to begin. If the recipient already has an active session on the SPV, that session is returned instead of creating a duplicate; if another app holds that recipient&#39;s active session there, the create is refused with 409 &#x60;session_conflict&#x60; (a recipient has one active session per offering). 
+    # @param id [String] The SPV ID (prefixed, e.g. &#x60;spv_abc123&#x60;)
+    # @param create_offering_investment_session_request [CreateOfferingInvestmentSessionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key A unique client-generated key that makes a write request safe to retry. If a request is retried within 24 hours with the same key and body, the original result is returned instead of performing the operation again. Strongly recommended on all &#x60;POST&#x60; requests that create resources. 
+    # @return [Array<(InvestmentSessionEnvelope, Integer, Hash)>] InvestmentSessionEnvelope data, response status code and response headers
+    def create_offering_investment_session_with_http_info(id, create_offering_investment_session_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PartnerInvitesSessionsApi.create_offering_investment_session ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PartnerInvitesSessionsApi.create_offering_investment_session"
+      end
+      # verify the required parameter 'create_offering_investment_session_request' is set
+      if @api_client.config.client_side_validation && create_offering_investment_session_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_offering_investment_session_request' when calling PartnerInvitesSessionsApi.create_offering_investment_session"
+      end
+      # resource path
+      local_var_path = '/offerings/{id}/investment_sessions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_offering_investment_session_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvestmentSessionEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PartnerInvitesSessionsApi.create_offering_investment_session",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PartnerInvitesSessionsApi#create_offering_investment_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an investment session
+    # Alias of `/partner/investment_sessions` (#23636).  Returns the full session including an `events` timeline of durable platform events recorded about it. 
+    # @param id [String] The investment session ID (prefixed, e.g. &#x60;is_abc123&#x60;)
+    # @param [Hash] opts the optional parameters
+    # @return [InvestmentSessionEnvelope]
+    def get_investment_session(id, opts = {})
+      data, _status_code, _headers = get_investment_session_with_http_info(id, opts)
+      data
+    end
+
+    # Get an investment session
+    # Alias of &#x60;/partner/investment_sessions&#x60; (#23636).  Returns the full session including an &#x60;events&#x60; timeline of durable platform events recorded about it. 
+    # @param id [String] The investment session ID (prefixed, e.g. &#x60;is_abc123&#x60;)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvestmentSessionEnvelope, Integer, Hash)>] InvestmentSessionEnvelope data, response status code and response headers
+    def get_investment_session_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PartnerInvitesSessionsApi.get_investment_session ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PartnerInvitesSessionsApi.get_investment_session"
+      end
+      # resource path
+      local_var_path = '/investment_sessions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvestmentSessionEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PartnerInvitesSessionsApi.get_investment_session",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PartnerInvitesSessionsApi#get_investment_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List investment sessions
+    # Alias of `/partner/investment_sessions` (#23636).  Lists the investment sessions your app created, newest first. A session belongs to the application that created it: no other app sees it, even one of your organization. A syndicate- or company-owned token sees only its own syndicate's or company's sessions. Creating a session needs authority on the offering; reading or canceling one you created does not. Filter by `spv_id` and/or `status`. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :spv_id Only sessions on this SPV
+    # @option opts [String] :status Only sessions in this state
+    # @option opts [Integer] :per_page Page size (default 25, max 100)
+    # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
+    # @return [InvestmentSessionListEnvelope]
+    def list_investment_sessions(opts = {})
+      data, _status_code, _headers = list_investment_sessions_with_http_info(opts)
+      data
+    end
+
+    # List investment sessions
+    # Alias of &#x60;/partner/investment_sessions&#x60; (#23636).  Lists the investment sessions your app created, newest first. A session belongs to the application that created it: no other app sees it, even one of your organization. A syndicate- or company-owned token sees only its own syndicate&#39;s or company&#39;s sessions. Creating a session needs authority on the offering; reading or canceling one you created does not. Filter by &#x60;spv_id&#x60; and/or &#x60;status&#x60;. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :spv_id Only sessions on this SPV
+    # @option opts [String] :status Only sessions in this state
+    # @option opts [Integer] :per_page Page size (default 25, max 100)
+    # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
+    # @return [Array<(InvestmentSessionListEnvelope, Integer, Hash)>] InvestmentSessionListEnvelope data, response status code and response headers
+    def list_investment_sessions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PartnerInvitesSessionsApi.list_investment_sessions ...'
+      end
+      allowable_values = ["pending", "in_progress", "completed", "abandoned", "expired", "canceled"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/investment_sessions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'spv_id'] = opts[:'spv_id'] if !opts[:'spv_id'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvestmentSessionListEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PartnerInvitesSessionsApi.list_investment_sessions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PartnerInvitesSessionsApi#list_investment_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List investment sessions
+    # Lists the investment sessions your app created on this offering, newest first; filter by `status`. A session belongs to the application that created it: no other app sees it, even one of your organization. A syndicate- or company-owned token sees only its own syndicate's or company's sessions. An offering with none of your app's sessions lists nothing, so the id reveals nothing about the offering. 
+    # @param id [String] The SPV ID (prefixed, e.g. &#x60;spv_abc123&#x60;)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Only sessions in this state
+    # @option opts [Integer] :per_page Page size (default 25, max 100)
+    # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
+    # @return [InvestmentSessionListEnvelope]
+    def list_offering_investment_sessions(id, opts = {})
+      data, _status_code, _headers = list_offering_investment_sessions_with_http_info(id, opts)
+      data
+    end
+
+    # List investment sessions
+    # Lists the investment sessions your app created on this offering, newest first; filter by &#x60;status&#x60;. A session belongs to the application that created it: no other app sees it, even one of your organization. A syndicate- or company-owned token sees only its own syndicate&#39;s or company&#39;s sessions. An offering with none of your app&#39;s sessions lists nothing, so the id reveals nothing about the offering. 
+    # @param id [String] The SPV ID (prefixed, e.g. &#x60;spv_abc123&#x60;)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Only sessions in this state
+    # @option opts [Integer] :per_page Page size (default 25, max 100)
+    # @option opts [Integer] :cursor Cursor-based pagination token. Use the &#x60;next_cursor&#x60; value from the previous response&#39;s &#x60;meta&#x60; object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
+    # @return [Array<(InvestmentSessionListEnvelope, Integer, Hash)>] InvestmentSessionListEnvelope data, response status code and response headers
+    def list_offering_investment_sessions_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PartnerInvitesSessionsApi.list_offering_investment_sessions ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PartnerInvitesSessionsApi.list_offering_investment_sessions"
+      end
+      allowable_values = ["pending", "in_progress", "completed", "abandoned", "expired", "canceled"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/offerings/{id}/investment_sessions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvestmentSessionListEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PartnerInvitesSessionsApi.list_offering_investment_sessions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PartnerInvitesSessionsApi#list_offering_investment_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/wefunder_generated/api/portfolio_api.rb

@@ -87,7 +87,7 @@ module WefunderGenerated
     end
 
     # List portfolio positions
-    # Returns the authenticated investor's positions, one per offering (fundraise), newest first. Position totals cover everything the investor holds in that offering; `securities` breaks the total down by security offering and legal owner, so early bird tiers and personally-held vs entity-held stakes each appear separately. Fund and SPV positions identify the companies the vehicle invested in under `holdings`.  To compute an average cost per share, divide `cost_basis_cents` by `shares_held`.  Requires a user-authorized token, like `GET /portfolio`. 
+    # Returns the authenticated investor's positions, one per offering (fundraise), newest first. Position totals cover everything the investor holds in that offering; `securities` breaks the total down by security offering and legal owner, so early bird tiers and personally-held vs entity-held stakes each appear separately. Fund and SPV positions identify the companies the vehicle invested in under `holdings`.  Mind the units when deriving an average cost per share: `cost_basis_cents` is integer cents, while `shares_held`, `current_share_price` and `terms.share_price` are decimal strings in major units of the position's `currency`. Use decimal arithmetic and divide the cents by 100 first: `cost_basis_cents / 100 / shares_held`. For example, `215000` cents over `\"200.0\"` shares is 1075 cents per share, or 10.75 USD per share, which is what to compare with a `current_share_price` of `\"14.4632\"`. Dividing `cost_basis_cents` by `shares_held` without the `/ 100` yields cents per share, 100 times the prices shown. When `shares_held` is `null` or zero (a non-share security, or a valuation that is not per-share) there is no average cost per share: report it as unavailable instead of treating the missing share count as a number.  Requires a user-authorized token, like `GET /portfolio`. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :cursor Cursor-based pagination token. Use the `next_cursor` value from the previous response's `meta` object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
     # @option opts [Integer] :per_page Page size, 1-100. Defaults to 25. (default to 25)
@@ -100,7 +100,7 @@ module WefunderGenerated
     end
 
     # List portfolio positions
-    # Returns the authenticated investor's positions, one per offering (fundraise), newest first. Position totals cover everything the investor holds in that offering; `securities` breaks the total down by security offering and legal owner, so early bird tiers and personally-held vs entity-held stakes each appear separately. Fund and SPV positions identify the companies the vehicle invested in under `holdings`.  To compute an average cost per share, divide `cost_basis_cents` by `shares_held`.  Requires a user-authorized token, like `GET /portfolio`. 
+    # Returns the authenticated investor's positions, one per offering (fundraise), newest first. Position totals cover everything the investor holds in that offering; `securities` breaks the total down by security offering and legal owner, so early bird tiers and personally-held vs entity-held stakes each appear separately. Fund and SPV positions identify the companies the vehicle invested in under `holdings`.  Mind the units when deriving an average cost per share: `cost_basis_cents` is integer cents, while `shares_held`, `current_share_price` and `terms.share_price` are decimal strings in major units of the position's `currency`. Use decimal arithmetic and divide the cents by 100 first: `cost_basis_cents / 100 / shares_held`. For example, `215000` cents over `\"200.0\"` shares is 1075 cents per share, or 10.75 USD per share, which is what to compare with a `current_share_price` of `\"14.4632\"`. Dividing `cost_basis_cents` by `shares_held` without the `/ 100` yields cents per share, 100 times the prices shown. When `shares_held` is `null` or zero (a non-share security, or a valuation that is not per-share) there is no average cost per share: report it as unavailable instead of treating the missing share count as a number.  Requires a user-authorized token, like `GET /portfolio`. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :cursor Cursor-based pagination token. Use the `next_cursor` value from the previous response's `meta` object to retrieve the next page of results. Omit this parameter to retrieve the first page. 
     # @option opts [Integer] :per_page Page size, 1-100. Defaults to 25. (default to 25)