Class: Merge::Ticketing::AsyncCollectionsClient

Inherits:

Object

• Object
• Merge::Ticketing::AsyncCollectionsClient

Defined in:

lib/merge_ruby_client/ticketing/collections/client.rb

Instance Attribute Summary

• #request_client ⇒ Merge::AsyncRequestClient readonly

Instance Method Summary

• #initialize(request_client:) ⇒ Merge::Ticketing::AsyncCollectionsClient constructor
• #list(collection_type: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, parent_collection_id: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedCollectionList

  Returns a list of ‘Collection` objects.

• #retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Ticketing::Collection

  Returns a ‘Collection` object with the given `id`.

• #viewers_list(collection_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, page_size: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedViewerList

  Returns a list of ‘Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id.

Constructor Details

#initialize(request_client:) ⇒ Merge::Ticketing::AsyncCollectionsClient

Parameters:

• request_client (Merge::AsyncRequestClient)

# File 'lib/merge_ruby_client/ticketing/collections/client.rb', line 206

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:

• (Merge::AsyncRequestClient)

# File 'lib/merge_ruby_client/ticketing/collections/client.rb', line 202

def request_client
  @request_client
end

Instance Method Details

#list(collection_type: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, parent_collection_id: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedCollectionList

Returns a list of ‘Collection` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ticketing.collections.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

• collection_type (String) (defaults to: nil) —

  If provided, will only return collections of the given type.

• created_after (DateTime) (defaults to: nil) —

  If provided, will only return objects created after this datetime.

• created_before (DateTime) (defaults to: nil) —

  If provided, will only return objects created before this datetime.

• cursor (String) (defaults to: nil) —

  The pagination cursor value.

• expand (String) (defaults to: nil) —

  Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

• include_deleted_data (Boolean) (defaults to: nil) —

  Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

• include_remote_data (Boolean) (defaults to: nil) —

  Whether to include the original data Merge fetched from the third-party to produce these models.

• include_shell_data (Boolean) (defaults to: nil) —

  Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

• modified_after (DateTime) (defaults to: nil) —

  If provided, only objects synced by Merge after this date time will be returned.

• modified_before (DateTime) (defaults to: nil) —

  If provided, only objects synced by Merge before this date time will be returned.

• page_size (Integer) (defaults to: nil) —

  Number of results to return per page.

• parent_collection_id (String) (defaults to: nil) —

  If provided, will only return collections whose parent collection matches the given id.

• remote_fields (String) (defaults to: nil) —

  Deprecated. Use show_enum_origins.

• remote_id (String) (defaults to: nil) —

  The API provider’s ID for the given object.

• show_enum_origins (String) (defaults to: nil) —

  A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

• request_options (Merge::RequestOptions) (defaults to: nil)

Returns:

• (Merge::Ticketing::PaginatedCollectionList)

# File 'lib/merge_ruby_client/ticketing/collections/client.rb', line 246

def list(collection_type: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
         include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, parent_collection_id: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
  Async do
    response = @request_client.conn.get 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.account_token unless request_options&.account_token.nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "collection_type": collection_type,
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "expand": expand,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "parent_collection_id": parent_collection_id,
        "remote_fields": remote_fields,
        "remote_id": remote_id,
        "show_enum_origins": show_enum_origins
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/collections"
    end
    Merge::Ticketing::PaginatedCollectionList.from_json(json_object: response.body)
  end
end

#retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Ticketing::Collection

Returns a ‘Collection` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ticketing.collections.retrieve(id: "id")

Parameters:

• id (String)
• expand (String) (defaults to: nil) —

  Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

• include_remote_data (Boolean) (defaults to: nil) —

  Whether to include the original data Merge fetched from the third-party to produce these models.

• include_shell_data (Boolean) (defaults to: nil) —

  Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

• remote_fields (String) (defaults to: nil) —

  Deprecated. Use show_enum_origins.

• show_enum_origins (String) (defaults to: nil) —

  A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

• request_options (Merge::RequestOptions) (defaults to: nil)

Returns:

• (Merge::Ticketing::Collection)

# File 'lib/merge_ruby_client/ticketing/collections/client.rb', line 363

def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil,
             show_enum_origins: nil, request_options: nil)
  Async do
    response = @request_client.conn.get 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.account_token unless request_options&.account_token.nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "expand": expand,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "remote_fields": remote_fields,
        "show_enum_origins": show_enum_origins
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/collections/#{id}"
    end
    Merge::Ticketing::Collection.from_json(json_object: response.body)
  end
end

#viewers_list(collection_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, page_size: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedViewerList

Returns a list of ‘Viewer` objects that point to a User id or Team id that is

either an assignee or viewer on a `Collection` with the given id. [Learn
(https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ticketing.collections.viewers_list(collection_id: "collection_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

• collection_id (String)
• cursor (String) (defaults to: nil) —

  The pagination cursor value.

• expand (Merge::Ticketing::Collections::CollectionsViewersListRequestExpand) (defaults to: nil) —

  Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

• include_deleted_data (Boolean) (defaults to: nil) —

  Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

• include_remote_data (Boolean) (defaults to: nil) —

  Whether to include the original data Merge fetched from the third-party to produce these models.

• include_shell_data (Boolean) (defaults to: nil) —

  Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

• page_size (Integer) (defaults to: nil) —

  Number of results to return per page.

• request_options (Merge::RequestOptions) (defaults to: nil)

Returns:

• (Merge::Ticketing::PaginatedViewerList)

# File 'lib/merge_ruby_client/ticketing/collections/client.rb', line 311

def viewers_list(collection_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil,
                 include_shell_data: nil, page_size: nil, request_options: nil)
  Async do
    response = @request_client.conn.get 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.account_token unless request_options&.account_token.nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "cursor": cursor,
        "expand": expand,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "page_size": page_size
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/collections/#{collection_id}/viewers"
    end
    Merge::Ticketing::PaginatedViewerList.from_json(json_object: response.body)
  end
end