Skip to content

Latest commit

 

History

History
303 lines (215 loc) · 9.58 KB

FeesApi.md

File metadata and controls

303 lines (215 loc) · 9.58 KB

RebillySdk::FeesApi

All URIs are relative to https://api-sandbox.rebilly.com/organizations/{organizationId}

Method HTTP request Description
get_fee GET /fees/{id} Retrieve a fee entry
get_fee_collection GET /fees Retrieve a list of Fees entries
patch_fee PATCH /fees/{id} Patch a fee entry
post_fee POST /fees Create a fee entry
put_fee PUT /fees/{id} Upsert a fee entry

get_fee

Fee get_fee(id, opts)

Retrieve a fee entry

Retrieve a fee entry. This operation is experimental and not guaranteed to be backward compatible.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::FeesApi.new
id = 'id_example' # String | The resource identifier string.
opts = { 
  organization_id: RebillySdk::ResourceId.new # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
}

begin
  #Retrieve a fee entry
  result = api_instance.get_fee(id, opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling FeesApi->get_fee: #{e}"
end

Parameters

Name Type Description Notes
id String The resource identifier string.
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]

Return type

Fee

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_fee_collection

Array<Fee> get_fee_collection(opts)

Retrieve a list of Fees entries

Retrieve a list of Fees entries. This operation is experimental and not guaranteed to be backward compatible.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::FeesApi.new
opts = { 
  organization_id: RebillySdk::ResourceId.new, # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
  limit: 56, # Integer | The collection items limit.
  offset: 56 # Integer | The collection items offset.
}

begin
  #Retrieve a list of Fees entries
  result = api_instance.get_fee_collection(opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling FeesApi->get_fee_collection: #{e}"
end

Parameters

Name Type Description Notes
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]
limit Integer The collection items limit. [optional]
offset Integer The collection items offset. [optional]

Return type

Array<Fee>

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patch_fee

Fee patch_fee(bodyid, opts)

Patch a fee entry

Patch a fee entry. This operation is experimental and not guaranteed to be backward compatible.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::FeesApi.new
body = RebillySdk::FeePatch.new # FeePatch | 
id = 'id_example' # String | The resource identifier string.
opts = { 
  organization_id: RebillySdk::ResourceId.new # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
}

begin
  #Patch a fee entry
  result = api_instance.patch_fee(bodyid, opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling FeesApi->patch_fee: #{e}"
end

Parameters

Name Type Description Notes
body FeePatch
id String The resource identifier string.
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]

Return type

Fee

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_fee

Fee post_fee(body, opts)

Create a fee entry

Create a fee entry. This operation is experimental and not guaranteed to be backward compatible.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::FeesApi.new
body = RebillySdk::Fee.new # Fee | 
opts = { 
  organization_id: RebillySdk::ResourceId.new # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
}

begin
  #Create a fee entry
  result = api_instance.post_fee(body, opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling FeesApi->post_fee: #{e}"
end

Parameters

Name Type Description Notes
body Fee
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]

Return type

Fee

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

put_fee

Fee put_fee(bodyid, opts)

Upsert a fee entry

Upsert a fee entry. This operation is experimental and not guaranteed to be backward compatible.

Example

# load the gem
require 'rebilly_sdk'
# setup authorization
RebillySdk.configure do |config|

  # Configure API key authorization: SecretApiKey
  config.api_key['REB-APIKEY'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['REB-APIKEY'] = 'Bearer'
end

api_instance = RebillySdk::FeesApi.new
body = RebillySdk::Fee.new # Fee | 
id = 'id_example' # String | The resource identifier string.
opts = { 
  organization_id: RebillySdk::ResourceId.new # ResourceId | Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).  It is deprecated. Use servers with `/organizations/{organizationId}` base path instead.
}

begin
  #Upsert a fee entry
  result = api_instance.put_fee(bodyid, opts)
  p result
rescue RebillySdk::ApiError => e
  puts "Exception when calling FeesApi->put_fee: #{e}"
end

Parameters

Name Type Description Notes
body Fee
id String The resource identifier string.
organization_id ResourceId Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). It is deprecated. Use servers with `/organizations/{organizationId}` base path instead. [optional]

Return type

Fee

Authorization

JWT, SecretApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json