README.md

Companies

(companies)

Overview

Companies API

Available Operations

• create - Create a Company
• list - List all Companies
• update - Update a Company

create

Create a new company in specific organization.

Required authorization scope: enterprise.company

Example Usage

require_relative easyship_ruby_sdk


s = Easyship::Api.new
s.config_security(
  security=Shared::Security.new(
    o_auth2="",
  )
)

   
req = Shared::CompanyCreate.new(
  request=Shared::CompanyCreate.new(
    country_alpha2=Shared::CountryAlpha2::KP,
    name="string",
    organization_id="7ad642c1-fc6f-4e07-a41b-cdd89dc7fa50",
    owner=Shared::CompanyUserCreate.new(
      email="string",
      first_name="Destiny",
      last_name="Turcotte",
    ),
  ),
)
    
res = s.companies.create(req)

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

Parameters

Parameter	Type	Required	Description
request	Shared::CompanyCreate	✔️	The request object to use for the request.

Response

T.nilable(Operations::CreateCompaniesResponse)

list

List all companies which belong to organisation.

Required authorization scope: enterprise.company

Example Usage

require_relative easyship_ruby_sdk


s = Easyship::Api.new
s.config_security(
  security=Shared::Security.new(
    o_auth2="",
  )
)

   
req = Operations::ListCompaniesRequest.new(
  query_params=Operations::ListCompaniesRequest.new(
    company_name="Bradtke, Lockman and Gerhold",
    easyship_company_id="string",
    organization_id="a429302e-aca4-40db-b171-8b882a508055",
    owner_email="string",
    sort_by=Operations::ListCompaniesSortBy::COMPANY_NAME,
    sort_direction=Operations::ListCompaniesSortDirection::ASC,
  ),
)
    
res = s.companies.list(req)

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

Parameters

Parameter	Type	Required	Description
company_name	String	➖	Filter by company name
easyship_company_id	String	➖	Filter by Easyship company ID
organization_id	String	➖	Filter by organization ID
owner_email	String	➖	Filter by company owner's email
sort_by	Operations::ListCompaniesSortBy	➖	Sort records by listed columns. Default: created_at
sort_direction	Operations::ListCompaniesSortDirection	➖	Set the sort direction. Default: DESC

Response

T.nilable(Operations::ListCompaniesResponse)

update

Update a company.

Required authorization scope: enterprise.company

Example Usage

require_relative easyship_ruby_sdk


s = Easyship::Api.new
s.config_security(
  security=Shared::Security.new(
    o_auth2="",
  )
)

   
req = Operations::UpdateCompaniesRequest.new(
  path_params=Operations::UpdateCompaniesRequest.new(
    easyship_company_id="d0905bf4-aa77-4f20-8e77-54c352acfe54",
    company_update=Shared::CompanyUpdate.new(
      name="string",
      owner=Shared::Owner.new(
        email="string",
        first_name="Adolf",
        last_name="Kohler",
      ),
    ),
  ),
  company_update=Shared::CompanyUpdate.new(
    name="string",
    owner=Shared::Owner.new(
      email="string",
      first_name="Ian",
      last_name="Russel",
    ),
  ),
)
    
res = s.companies.update(req)

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

Parameters

Parameter	Type	Required	Description
easyship_company_id	String	✔️	Easyship company ID provided when creating the account
company_update	Shared::CompanyUpdate	➖	N/A

Response

T.nilable(Operations::UpdateCompaniesResponse)