Skip to content

Latest commit

 

History

History
325 lines (209 loc) · 16.2 KB

README.md

File metadata and controls

325 lines (209 loc) · 16.2 KB

Organization

(organization)

Overview

Available Operations

create_repo_organization

Create an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.create_repo_organization(repo_organization=::UnifiedRubySDK::Shared::RepoOrganization.new(), connection_id="<id>", fields_=[
  "<value>",
])

if ! res.repo_organization.nil?
  # handle response
end

Parameters

Parameter Type Required Description
repo_organization ::UnifiedRubySDK::Shared::RepoOrganization ✔️ N/A
connection_id ::String ✔️ ID of the connection
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateRepoOrganizationResponse)

get_accounting_organization

Retrieve an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.get_accounting_organization(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_organization.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Organization
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingOrganizationResponse)

get_repo_organization

Retrieve an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.get_repo_organization(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.repo_organization.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Organization
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetRepoOrganizationResponse)

list_accounting_organizations

List all organizations

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

req = ::UnifiedRubySDK::Operations::ListAccountingOrganizationsRequest.new(
  connection_id: "<id>",
)

res = s.organization.list_accounting_organizations(req)

if ! res.accounting_organizations.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::ListAccountingOrganizationsRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingOrganizationsResponse)

list_repo_organizations

List all organizations

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

req = ::UnifiedRubySDK::Operations::ListRepoOrganizationsRequest.new(
  connection_id: "<id>",
)

res = s.organization.list_repo_organizations(req)

if ! res.repo_organizations.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::ListRepoOrganizationsRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListRepoOrganizationsResponse)

patch_repo_organization

Update an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.patch_repo_organization(repo_organization=::UnifiedRubySDK::Shared::RepoOrganization.new(), connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.repo_organization.nil?
  # handle response
end

Parameters

Parameter Type Required Description
repo_organization ::UnifiedRubySDK::Shared::RepoOrganization ✔️ N/A
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Organization
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchRepoOrganizationResponse)

remove_repo_organization

Remove an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.remove_repo_organization(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Organization

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveRepoOrganizationResponse)

update_repo_organization

Update an organization

Example Usage

require 'unified_ruby_sdk'

s = ::UnifiedRubySDK::UnifiedTo.new(
      security: ::UnifiedRubySDK::Shared::Security.new(
        jwt: "<YOUR_API_KEY_HERE>",
      ),
    )

res = s.organization.update_repo_organization(repo_organization=::UnifiedRubySDK::Shared::RepoOrganization.new(), connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.repo_organization.nil?
  # handle response
end

Parameters

Parameter Type Required Description
repo_organization ::UnifiedRubySDK::Shared::RepoOrganization ✔️ N/A
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Organization
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateRepoOrganizationResponse)