wefunder 1.0.1 → 1.1.0

data/lib/wefunder_generated/api/member_links_api.rb

@@ -0,0 +1,287 @@
+=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 MemberLinksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Cancel a member link
+    # Retracts the invitation. Idempotent. The link grants nothing new afterwards: a checkout started after the cancel, including the same member's next investment, is priced at standard terms. Investments already made through the link keep the terms they were made at. A link nobody invested through is also released from the account you pre-bound it to. Revoking your install cancels every member link it minted that no investment went through (same release); links an investment went through stand. 
+    # @param id [String] The member link ID (prefixed, e.g. `il_abc123`). Opaque; do not parse it.
+    # @param [Hash] opts the optional parameters
+    # @return [MemberLinkEnvelope]
+    def cancel_member_link(id, opts = {})
+      data, _status_code, _headers = cancel_member_link_with_http_info(id, opts)
+      data
+    end
+
+    # Cancel a member link
+    # Retracts the invitation. Idempotent. The link grants nothing new afterwards: a checkout started after the cancel, including the same member's next investment, is priced at standard terms. Investments already made through the link keep the terms they were made at. A link nobody invested through is also released from the account you pre-bound it to. Revoking your install cancels every member link it minted that no investment went through (same release); links an investment went through stand. 
+    # @param id [String] The member link ID (prefixed, e.g. `il_abc123`). Opaque; do not parse it.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MemberLinkEnvelope, Integer, Hash)>] MemberLinkEnvelope data, response status code and response headers
+    def cancel_member_link_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MemberLinksApi.cancel_member_link ...'
+      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 MemberLinksApi.cancel_member_link"
+      end
+      # resource path
+      local_var_path = '/member_links/{id}/cancel'.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] || 'MemberLinkEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MemberLinksApi.cancel_member_link",
+        :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: MemberLinksApi#cancel_member_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a member link
+    # Mints a link that sends one of your members to this offering's deal page. It carries no email: it binds to the first Wefunder account that invests through it, whatever address that account uses, or up front when you pass the `wefunder_user_id` of a member whose account you already know. A bound link answers only to its account: anyone else (logged out, or another account) gets no private access and no invited pricing, and is asked to sign in with the invited account.  The member gets what an invitation from the offering's manager or founder gets: access to a private round and invited pricing.  Pass `reference` (your member id) to make the create idempotent per offering: repeating it returns the live link with 200. The same reference on another offering mints that offering's own link, since a member gets one link per deal. Requires a syndicate- or company-owned token of an app installed on the offering's syndicate or company; user tokens get 404. 
+    # @param id [String] The offering ID (prefixed, e.g. &#x60;ofr_abc123&#x60;), on the syndicate or company your app is installed on.
+    # @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. 
+    # @option opts [CreateOfferingMemberLinkRequest] :create_offering_member_link_request 
+    # @return [MemberLinkEnvelope]
+    def create_offering_member_link(id, opts = {})
+      data, _status_code, _headers = create_offering_member_link_with_http_info(id, opts)
+      data
+    end
+
+    # Create a member link
+    # Mints a link that sends one of your members to this offering&#39;s deal page. It carries no email: it binds to the first Wefunder account that invests through it, whatever address that account uses, or up front when you pass the &#x60;wefunder_user_id&#x60; of a member whose account you already know. A bound link answers only to its account: anyone else (logged out, or another account) gets no private access and no invited pricing, and is asked to sign in with the invited account.  The member gets what an invitation from the offering&#39;s manager or founder gets: access to a private round and invited pricing.  Pass &#x60;reference&#x60; (your member id) to make the create idempotent per offering: repeating it returns the live link with 200. The same reference on another offering mints that offering&#39;s own link, since a member gets one link per deal. Requires a syndicate- or company-owned token of an app installed on the offering&#39;s syndicate or company; user tokens get 404. 
+    # @param id [String] The offering ID (prefixed, e.g. &#x60;ofr_abc123&#x60;), on the syndicate or company your app is installed on.
+    # @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. 
+    # @option opts [CreateOfferingMemberLinkRequest] :create_offering_member_link_request 
+    # @return [Array<(MemberLinkEnvelope, Integer, Hash)>] MemberLinkEnvelope data, response status code and response headers
+    def create_offering_member_link_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MemberLinksApi.create_offering_member_link ...'
+      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 MemberLinksApi.create_offering_member_link"
+      end
+      # resource path
+      local_var_path = '/offerings/{id}/member_links'.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(opts[:'create_offering_member_link_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MemberLinkEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MemberLinksApi.create_offering_member_link",
+        :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: MemberLinksApi#create_offering_member_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a member link
+    # A member link your install minted, with its live `state`. Links minted by another app answer 404. 
+    # @param id [String] The member link ID (prefixed, e.g. &#x60;il_abc123&#x60;). Opaque; do not parse it.
+    # @param [Hash] opts the optional parameters
+    # @return [MemberLinkEnvelope]
+    def get_member_link(id, opts = {})
+      data, _status_code, _headers = get_member_link_with_http_info(id, opts)
+      data
+    end
+
+    # Get a member link
+    # A member link your install minted, with its live &#x60;state&#x60;. Links minted by another app answer 404. 
+    # @param id [String] The member link ID (prefixed, e.g. &#x60;il_abc123&#x60;). Opaque; do not parse it.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MemberLinkEnvelope, Integer, Hash)>] MemberLinkEnvelope data, response status code and response headers
+    def get_member_link_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MemberLinksApi.get_member_link ...'
+      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 MemberLinksApi.get_member_link"
+      end
+      # resource path
+      local_var_path = '/member_links/{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] || 'MemberLinkEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MemberLinksApi.get_member_link",
+        :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: MemberLinksApi#get_member_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List member links
+    # The member links **your install** minted on this offering, newest first. Another app installed on the same offering never sees them, and they never appear in `/invite_links`. Requires a syndicate- or company-owned token of an app installed on the offering's syndicate or company. 
+    # @param id [String] The offering ID (prefixed, e.g. &#x60;ofr_abc123&#x60;), on the syndicate or company your app is installed on.
+    # @param [Hash] opts the optional parameters
+    # @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 [MemberLinkListEnvelope]
+    def list_offering_member_links(id, opts = {})
+      data, _status_code, _headers = list_offering_member_links_with_http_info(id, opts)
+      data
+    end
+
+    # List member links
+    # The member links **your install** minted on this offering, newest first. Another app installed on the same offering never sees them, and they never appear in &#x60;/invite_links&#x60;. Requires a syndicate- or company-owned token of an app installed on the offering&#39;s syndicate or company. 
+    # @param id [String] The offering ID (prefixed, e.g. &#x60;ofr_abc123&#x60;), on the syndicate or company your app is installed on.
+    # @param [Hash] opts the optional parameters
+    # @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<(MemberLinkListEnvelope, Integer, Hash)>] MemberLinkListEnvelope data, response status code and response headers
+    def list_offering_member_links_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MemberLinksApi.list_offering_member_links ...'
+      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 MemberLinksApi.list_offering_member_links"
+      end
+      # resource path
+      local_var_path = '/offerings/{id}/member_links'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      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] || 'MemberLinkListEnvelope'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MemberLinksApi.list_offering_member_links",
+        :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: MemberLinksApi#list_offering_member_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end