Class: Nombaone::Resources::Organization

Inherits:
BaseResource show all
Defined in:
lib/nombaone/resources/organization.rb,
sig/nombaone/resources.rbs

Overview

Organization settings — configuration, not a billing object.

Instance Method Summary collapse

Methods inherited from BaseResource

#encode, #initialize, #request, #request_page

Constructor Details

This class inherits a constructor from Nombaone::Resources::BaseResource

Instance Method Details

#billing ⇒ OrganizationBilling

Billing + dunning policy.

Returns:



60
61
62
 
# File 'lib/nombaone/resources/organization.rb', line 60

def billing
  @billing ||= OrganizationBilling.new(@client)
end

#retrieve(request_options: {}) ⇒ NombaObject

Read org-level settings (limits, settlement mode, branding, statuses).

Parameters:

  • request_options (Hash) (defaults to: {})
  • request_options: (Nombaone::request_options) (defaults to: {})

Returns:



68
69
70
 
# File 'lib/nombaone/resources/organization.rb', line 68

def retrieve(request_options: {})
  request(:get, "/organization", options: request_options)
end

#update(monthly_request_quota: OMIT, settlement_mode: OMIT, branding: OMIT, request_options: {}) ⇒ NombaObject

Update tenant-editable settings. At least one field is required.

Parameters:

  • monthly_request_quota (Integer) (defaults to: OMIT)
  • settlement_mode (String) (defaults to: OMIT) —

    "split_at_collection" or "collect_then_payout".

  • branding (Hash) (defaults to: OMIT) —

    display_name, support_email, logo_url, primary_color_hex.

  • request_options (Hash) (defaults to: {})

Returns:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nombaone/resources/organization.rb', line 79

def update(monthly_request_quota: OMIT, settlement_mode: OMIT, branding: OMIT,
           request_options: {})
  request(:put, "/organization",
          body: {
            monthly_request_quota: monthly_request_quota,
            settlement_mode: settlement_mode,
            branding: branding,
          },
          options: request_options)
end