Class: Stigg::Resources::V1::Customers::Integrations

Inherits:
Object
  • Object
show all
Defined in:
lib/stigg/resources/v1/customers/integrations.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Integrations

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 Integrations.

Parameters:



210
211
212
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 210

def initialize(client:)
  @client = client
end

Instance Method Details

Some parameter documentations has been truncated, see Models::V1::Customers::IntegrationLinkParams for more details.

Links a customer to an external integration by specifying the vendor and external entity ID.

Parameters:

  • path_id (String) —

    Path param: The unique identifier of the entity

  • body_id (String) —

    Body param: Integration details

  • synced_entity_id (String) —

    Body param: Synced entity id

  • vendor_identifier (Symbol, Stigg::Models::V1::Customers::IntegrationLinkParams::VendorIdentifier) —

    Body param: The vendor identifier of integration

  • x_account_id (String) —

    Header param: Account ID — optional when authenticating with a user JWT (Bearer

  • x_environment_id (String) —

    Header param: Environment ID — required when authenticating with a user JWT (Bea

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

Returns:

See Also:



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 156

def link(path_id, params)
  parsed, options = Stigg::V1::Customers::IntegrationLinkParams.dump_request(params)
  header_params = {x_account_id: "x-account-id", x_environment_id: "x-environment-id"}
  @client.request(
    method: :post,
    path: ["api/v1/customers/%1$s/integrations", path_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Stigg::V1::CustomerIntegrationResponse,
    options: options
  )
end

#list(id, after: nil, before: nil, limit: nil, vendor_identifier: nil, x_account_id: nil, x_environment_id: nil, request_options: {}) ⇒ Stigg::Internal::MyCursorIDPage<Stigg::Models::V1::Customers::IntegrationListResponse>

Some parameter documentations has been truncated, see Models::V1::Customers::IntegrationListParams for more details.

Retrieves a paginated list of a customer’s external integrations (billing, CRM, etc.).

Parameters:

  • id (String) —

    Path param: The unique identifier of the entity

  • after (String) —

    Query param: Return items that come after this cursor

  • before (String) —

    Query param: Return items that come before this cursor

  • limit (Integer) —

    Query param: Maximum number of items to return

  • vendor_identifier (Array<Symbol, Stigg::Models::V1::Customers::IntegrationListParams::VendorIdentifier>) —

    Query param: Filter by vendor identifier. Supports comma-separated values for mu

  • x_account_id (String) —

    Header param: Account ID — optional when authenticating with a user JWT (Bearer

  • x_environment_id (String) —

    Header param: Environment ID — required when authenticating with a user JWT (Bea

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

Returns:

See Also:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 113

def list(id, params = {})
  query_params = [:after, :before, :limit, :vendor_identifier]
  parsed, options = Stigg::V1::Customers::IntegrationListParams.dump_request(params)
  query = Stigg::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["api/v1/customers/%1$s/integrations", id],
    query: query.transform_keys(vendor_identifier: "vendorIdentifier"),
    headers: parsed.except(*query_params).transform_keys(
      x_account_id: "x-account-id",
      x_environment_id: "x-environment-id"
    ),
    page: Stigg::Internal::MyCursorIDPage,
    model: Stigg::Models::V1::Customers::IntegrationListResponse,
    options: options
  )
end

#retrieve(integration_id, id:, x_account_id: nil, x_environment_id: nil, request_options: {}) ⇒ Stigg::Models::V1::CustomerIntegrationResponse

Some parameter documentations has been truncated, see Models::V1::Customers::IntegrationRetrieveParams for more details.

Retrieves a specific integration for a customer by integration ID.

Parameters:

  • integration_id (String) —

    Path param: Integration details

  • id (String) —

    Path param: Customer slug

  • x_account_id (String) —

    Header param: Account ID — optional when authenticating with a user JWT (Bearer

  • x_environment_id (String) —

    Header param: Environment ID — required when authenticating with a user JWT (Bea

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

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 28

def retrieve(integration_id, params)
  parsed, options = Stigg::V1::Customers::IntegrationRetrieveParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/v1/customers/%1$s/integrations/%2$s", id, integration_id],
    headers: parsed.transform_keys(
      x_account_id: "x-account-id",
      x_environment_id: "x-environment-id"
    ),
    model: Stigg::V1::CustomerIntegrationResponse,
    options: options
  )
end

#unlink(integration_id, id:, x_account_id: nil, x_environment_id: nil, request_options: {}) ⇒ Stigg::Models::V1::CustomerIntegrationResponse

Some parameter documentations has been truncated, see Models::V1::Customers::IntegrationUnlinkParams for more details.

Removes the link between a customer and an external integration.

Parameters:

  • integration_id (String) —

    Path param: Integration details

  • id (String) —

    Path param: Customer slug

  • x_account_id (String) —

    Header param: Account ID — optional when authenticating with a user JWT (Bearer

  • x_environment_id (String) —

    Header param: Environment ID — required when authenticating with a user JWT (Bea

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

Returns:

See Also:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 189

def unlink(integration_id, params)
  parsed, options = Stigg::V1::Customers::IntegrationUnlinkParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/v1/customers/%1$s/integrations/%2$s", id, integration_id],
    headers: parsed.transform_keys(
      x_account_id: "x-account-id",
      x_environment_id: "x-environment-id"
    ),
    model: Stigg::V1::CustomerIntegrationResponse,
    options: options
  )
end

#update(integration_id, id:, synced_entity_id:, x_account_id: nil, x_environment_id: nil, request_options: {}) ⇒ Stigg::Models::V1::CustomerIntegrationResponse

Some parameter documentations has been truncated, see Models::V1::Customers::IntegrationUpdateParams for more details.

Updates a customer’s integration link, such as changing the synced external entity ID.

Parameters:

  • integration_id (String) —

    Path param: Integration details

  • id (String) —

    Path param: Customer slug

  • synced_entity_id (String, nil) —

    Body param: Synced entity id

  • x_account_id (String) —

    Header param: Account ID — optional when authenticating with a user JWT (Bearer

  • x_environment_id (String) —

    Header param: Environment ID — required when authenticating with a user JWT (Bea

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

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/stigg/resources/v1/customers/integrations.rb', line 69

def update(integration_id, params)
  parsed, options = Stigg::V1::Customers::IntegrationUpdateParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  header_params = {x_account_id: "x-account-id", x_environment_id: "x-environment-id"}
  @client.request(
    method: :patch,
    path: ["api/v1/customers/%1$s/integrations/%2$s", id, integration_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Stigg::V1::CustomerIntegrationResponse,
    options: options
  )
end