api-sdk-rb 1.11.66

data/lib/api-sdk-rb/api/credits_api.rb

@@ -0,0 +1,169 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ApiSdkRb
+  class CreditsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get an account's credit balance
+    # Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner's API key, that is the account of the person who administers the partner. Widgetic administrators can read any account's. An account that has never held credits reads a balance of 0. `getPartnerCreditBalance` reads this same balance by partner id. 
+    # @param user_id [String] The account whose balance to read
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCreditBalanceResponse]
+    def get_user_credit_balance_0(user_id, opts = {})
+      data, _status_code, _headers = get_user_credit_balance_0_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get an account's credit balance
+    # Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner's API key, that is the account of the person who administers the partner. Widgetic administrators can read any account's. An account that has never held credits reads a balance of 0. `getPartnerCreditBalance` reads this same balance by partner id. 
+    # @param user_id [String] The account whose balance to read
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCreditBalanceResponse, Integer, Hash)>] AccountCreditBalanceResponse data, response status code and response headers
+    def get_user_credit_balance_0_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreditsApi.get_user_credit_balance_0 ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling CreditsApi.get_user_credit_balance_0"
+      end
+      # resource path
+      local_var_path = '/credits/user/{userId}/balance'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'AccountCreditBalanceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CreditsApi.get_user_credit_balance_0",
+        :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: CreditsApi#get_user_credit_balance_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List an account's credit ledger
+    # Lists the entries of an account's credit ledger, newest first. This is also how an account's usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner's API key, that is the account of the person who administers the partner. Widgetic administrators can read any account's. `getPartnerCreditTransactions` reads this same ledger by partner id.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0. 
+    # @param user_id [String] The account whose ledger to read
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :transaction_type Only entries of this type, for instance &#x60;debit&#x60; for the credits spent. The types are listed on &#x60;AccountCreditTransaction&#x60;. 
+    # @option opts [Integer] :limit Maximum number of entries to return (default to 100)
+    # @option opts [Integer] :offset Number of entries to skip (default to 0)
+    # @return [GetPartnerCreditTransactions200Response]
+    def get_user_credit_transactions_0(user_id, opts = {})
+      data, _status_code, _headers = get_user_credit_transactions_0_with_http_info(user_id, opts)
+      data
+    end
+
+    # List an account&#39;s credit ledger
+    # Lists the entries of an account&#39;s credit ledger, newest first. This is also how an account&#39;s usage is read: every operation that spends credits is a &#x60;debit&#x60; entry, so summing the &#x60;debit&#x60; entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner&#39;s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account&#39;s. &#x60;getPartnerCreditTransactions&#x60; reads this same ledger by partner id.  The page is always bounded: &#x60;limit&#x60; defaults to 100 and is capped at 500, &#x60;offset&#x60; defaults to 0. 
+    # @param user_id [String] The account whose ledger to read
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :transaction_type Only entries of this type, for instance &#x60;debit&#x60; for the credits spent. The types are listed on &#x60;AccountCreditTransaction&#x60;. 
+    # @option opts [Integer] :limit Maximum number of entries to return (default to 100)
+    # @option opts [Integer] :offset Number of entries to skip (default to 0)
+    # @return [Array<(GetPartnerCreditTransactions200Response, Integer, Hash)>] GetPartnerCreditTransactions200Response data, response status code and response headers
+    def get_user_credit_transactions_0_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreditsApi.get_user_credit_transactions_0 ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling CreditsApi.get_user_credit_transactions_0"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CreditsApi.get_user_credit_transactions_0, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CreditsApi.get_user_credit_transactions_0, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CreditsApi.get_user_credit_transactions_0, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/credits/user/{userId}/transactions'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'transactionType'] = opts[:'transaction_type'] if !opts[:'transaction_type'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'GetPartnerCreditTransactions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CreditsApi.get_user_credit_transactions_0",
+        :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: CreditsApi#get_user_credit_transactions_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/api-sdk-rb/api/entitlements_api.rb

@@ -0,0 +1,166 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ApiSdkRb
+  class EntitlementsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get managed user entitlements
+    # Retrieves all entitlements for a managed user (admin or partner access).
+    # @param managed_user_id [String] Managed user ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_expired Include expired entitlements in results
+    # @option opts [String] :feature Filter by specific feature
+    # @option opts [String] :source Filter by entitlement source
+    # @return [GetManagedUserEntitlementsResponse]
+    def get_managed_user_entitlements_0(managed_user_id, opts = {})
+      data, _status_code, _headers = get_managed_user_entitlements_0_with_http_info(managed_user_id, opts)
+      data
+    end
+
+    # Get managed user entitlements
+    # Retrieves all entitlements for a managed user (admin or partner access).
+    # @param managed_user_id [String] Managed user ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_expired Include expired entitlements in results
+    # @option opts [String] :feature Filter by specific feature
+    # @option opts [String] :source Filter by entitlement source
+    # @return [Array<(GetManagedUserEntitlementsResponse, Integer, Hash)>] GetManagedUserEntitlementsResponse data, response status code and response headers
+    def get_managed_user_entitlements_0_with_http_info(managed_user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntitlementsApi.get_managed_user_entitlements_0 ...'
+      end
+      # verify the required parameter 'managed_user_id' is set
+      if @api_client.config.client_side_validation && managed_user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'managed_user_id' when calling EntitlementsApi.get_managed_user_entitlements_0"
+      end
+      # resource path
+      local_var_path = '/entitlements/managed-users/{managedUserId}'.sub('{' + 'managedUserId' + '}', CGI.escape(managed_user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'includeExpired'] = opts[:'include_expired'] if !opts[:'include_expired'].nil?
+      query_params[:'feature'] = opts[:'feature'] if !opts[:'feature'].nil?
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].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] || 'GetManagedUserEntitlementsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EntitlementsApi.get_managed_user_entitlements_0",
+        :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: EntitlementsApi#get_managed_user_entitlements_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get partner entitlements
+    # Retrieves all entitlements for a partner (admin or partner access).
+    # @param partner_id [String] Partner ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_expired Include expired entitlements in results
+    # @option opts [String] :feature Filter by specific feature
+    # @option opts [String] :source Filter by entitlement source
+    # @return [GetPartnerEntitlementsResponse]
+    def get_partner_entitlements_0(partner_id, opts = {})
+      data, _status_code, _headers = get_partner_entitlements_0_with_http_info(partner_id, opts)
+      data
+    end
+
+    # Get partner entitlements
+    # Retrieves all entitlements for a partner (admin or partner access).
+    # @param partner_id [String] Partner ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_expired Include expired entitlements in results
+    # @option opts [String] :feature Filter by specific feature
+    # @option opts [String] :source Filter by entitlement source
+    # @return [Array<(GetPartnerEntitlementsResponse, Integer, Hash)>] GetPartnerEntitlementsResponse data, response status code and response headers
+    def get_partner_entitlements_0_with_http_info(partner_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntitlementsApi.get_partner_entitlements_0 ...'
+      end
+      # verify the required parameter 'partner_id' is set
+      if @api_client.config.client_side_validation && partner_id.nil?
+        fail ArgumentError, "Missing the required parameter 'partner_id' when calling EntitlementsApi.get_partner_entitlements_0"
+      end
+      # resource path
+      local_var_path = '/entitlements/partners/{partnerId}'.sub('{' + 'partnerId' + '}', CGI.escape(partner_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'includeExpired'] = opts[:'include_expired'] if !opts[:'include_expired'].nil?
+      query_params[:'feature'] = opts[:'feature'] if !opts[:'feature'].nil?
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].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] || 'GetPartnerEntitlementsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EntitlementsApi.get_partner_entitlements_0",
+        :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: EntitlementsApi#get_partner_entitlements_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/api-sdk-rb/api/invoices_api.rb

@@ -0,0 +1,110 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ApiSdkRb
+  class InvoicesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List a partner's invoices
+    # Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`).  A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner's and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner.  The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0. 
+    # @param partner_id [String] The partner whose invoices to list
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Only invoices with this status
+    # @option opts [Integer] :limit Maximum number of invoices to return (default to 50)
+    # @option opts [Integer] :offset Number of invoices to skip (default to 0)
+    # @return [GetInvoicesByPartnerId200Response]
+    def get_invoices_by_partner_id_0(partner_id, opts = {})
+      data, _status_code, _headers = get_invoices_by_partner_id_0_with_http_info(partner_id, opts)
+      data
+    end
+
+    # List a partner's invoices
+    # Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`).  A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner's and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner.  The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0. 
+    # @param partner_id [String] The partner whose invoices to list
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Only invoices with this status
+    # @option opts [Integer] :limit Maximum number of invoices to return (default to 50)
+    # @option opts [Integer] :offset Number of invoices to skip (default to 0)
+    # @return [Array<(GetInvoicesByPartnerId200Response, Integer, Hash)>] GetInvoicesByPartnerId200Response data, response status code and response headers
+    def get_invoices_by_partner_id_0_with_http_info(partner_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvoicesApi.get_invoices_by_partner_id_0 ...'
+      end
+      # verify the required parameter 'partner_id' is set
+      if @api_client.config.client_side_validation && partner_id.nil?
+        fail ArgumentError, "Missing the required parameter 'partner_id' when calling InvoicesApi.get_invoices_by_partner_id_0"
+      end
+      allowable_values = ["draft", "open", "pending", "paid", "failed", "void", "uncollectible", "refunded", "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
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoicesApi.get_invoices_by_partner_id_0, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvoicesApi.get_invoices_by_partner_id_0, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InvoicesApi.get_invoices_by_partner_id_0, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/invoices/partner/{partnerId}'.sub('{' + 'partnerId' + '}', CGI.escape(partner_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'GetInvoicesByPartnerId200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InvoicesApi.get_invoices_by_partner_id_0",
+        :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: InvoicesApi#get_invoices_by_partner_id_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end