Class: Merge::Crm::AsyncLinkTokenClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/link_token/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Crm::AsyncLinkTokenClient 



115
116
117
 
# File 'lib/merge_ruby_client/crm/link_token/client.rb', line 115

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly) 



111
112
113
 
# File 'lib/merge_ruby_client/crm/link_token/client.rb', line 111

def request_client
  @request_client
end

Instance Method Details

#create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:, integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: nil, integration_specific_config: nil, request_options: nil) ⇒ Merge::Crm::LinkToken

Creates a link token to be used when linking a new end user.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.crm.link_token.create(
  end_user_email_address: "[email protected]",
  end_user_organization_name: "Test Organization",
  end_user_origin_id: "12345",
  categories: [HRIS, ATS]
)



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/merge_ruby_client/crm/link_token/client.rb', line 170

def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
           integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: nil, integration_specific_config: nil, request_options: nil)
  Async do
    response = @request_client.conn.post do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      req.body = {
        **(request_options&.additional_body_parameters || {}),
        end_user_email_address: end_user_email_address,
        end_user_organization_name: end_user_organization_name,
        end_user_origin_id: end_user_origin_id,
        categories: categories,
        integration: integration,
        link_expiry_mins: link_expiry_mins,
        should_create_magic_link_url: should_create_magic_link_url,
        hide_admin_magic_link: hide_admin_magic_link,
        common_models: common_models,
        category_common_model_scopes: category_common_model_scopes,
        language: language,
        are_syncs_disabled: are_syncs_disabled,
        integration_specific_config: integration_specific_config
      }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/link-token"
    end
    Merge::Crm::LinkToken.from_json(json_object: response.body)
  end
end