Class: Straddle::Resources::Organizations

Inherits:
Object
  • Object
show all
Defined in:
lib/straddle/resources/organizations.rb,
sig/straddle/resources/organizations.rbs

Overview

Organizations group related Straddle accounts.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Organizations

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Organizations.

Parameters:



125
126
127
 
# File 'lib/straddle/resources/organizations.rb', line 125

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {}) ⇒ Straddle::Models::OrganizationResponse

Some parameter documentations has been truncated, see Models::OrganizationCreateParams for more details.

Creates an organization for your platform and returns it. Organizations group related accounts and users.

Parameters:

  • name (String) —

    Body param: Organization name.

  • external_id (String, nil) —

    Body param: Your unique ID for the organization.

  • metadata (Hash{Symbol=>String, nil}, nil) —

    Body param: Up to 20 user-defined key-value pairs.

  • correlation_id (String) —

    Header param: Optional client-generated identifier for tracing a series of relat

  • idempotency_key (String) —

    Header param: Optional client-generated key for an idempotent request.

  • request_id (String) —

    Header param: Optional client-generated identifier for tracing one request.

  • request_options (Straddle::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/straddle/resources/organizations.rb', line 32

def create(params)
  parsed, options = Straddle::OrganizationCreateParams.dump_request(params)
  header_params = {
    correlation_id: "correlation-id",
    idempotency_key: "idempotency-key",
    request_id: "request-id"
  }
  @client.request(
    method: :post,
    path: "v1/organizations",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Straddle::OrganizationResponse,
    options: options
  )
end

#list(external_id: nil, name: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {}) ⇒ Straddle::Models::OrganizationList

Some parameter documentations has been truncated, see Models::OrganizationListParams for more details.

Returns a paginated list of organizations for your platform. Filter the list by name or external ID.

Parameters:

  • external_id (String) —

    Query param: Your external ID for the organization.

  • name (String) —

    Query param: Organization name. Supports partial matches.

  • page_number (Integer) —

    Query param: Page number. Defaults to 1.

  • page_size (Integer) —

    Query param: Number of results per page. Defaults to 100. Maximum 1000.

  • sort_by (String) —

    Query param: Field used to sort results. Defaults to id.

  • sort_order (Symbol, Straddle::Models::OrganizationListParams::SortOrder) —

    Query param: Sort direction. Defaults to asc.

  • correlation_id (String) —

    Header param: Optional client-generated identifier for tracing a series of relat

  • request_id (String) —

    Header param: Optional client-generated identifier for tracing one request.

  • request_options (Straddle::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/straddle/resources/organizations.rb', line 104

def list(params = {})
  query_params = %i[external_id name page_number page_size sort_by sort_order]
  parsed, options = Straddle::OrganizationListParams.dump_request(params)
  query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "v1/organizations",
    query: query,
    headers:
      parsed.except(*query_params).transform_keys(
        correlation_id: "correlation-id",
        request_id: "request-id"
      ),
    model: Straddle::OrganizationList,
    options: options
  )
end

#retrieve(organization_id, correlation_id: nil, request_id: nil, request_options: {}) ⇒ Straddle::Models::OrganizationResponse

Returns the organization with the specified ID.

Parameters:

  • organization_id (String) —

    The ID of the organization.

  • correlation_id (String) —

    Optional client-generated identifier for tracing a series of related requests.

  • request_id (String) —

    Optional client-generated identifier for tracing one request.

  • request_options (Straddle::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/straddle/resources/organizations.rb', line 64

def retrieve(organization_id, params = {})
  parsed, options = Straddle::OrganizationRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/organizations/%1$s", organization_id],
    headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
    model: Straddle::OrganizationResponse,
    options: options
  )
end