Class: NewStoreApi::CreateOidcIdentityProviderConfig

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/create_oidc_identity_provider_config.rb

Overview

CreateOidcIdentityProviderConfig Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(client_id = nil, client_secret = nil, directory_id = nil) ⇒ CreateOidcIdentityProviderConfig

Returns a new instance of CreateOidcIdentityProviderConfig.



43
44
45
46
47
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 43

def initialize(client_id = nil, client_secret = nil, directory_id = nil)
  @client_id = client_id
  @client_secret = client_secret
  @directory_id = directory_id
end

Instance Attribute Details

#client_id ⇒ String

Client ID of an OIDC client

Returns:

  • (String) 


14
15
16
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 14

def client_id
  @client_id
end

#client_secret ⇒ String

Client secret of an OIDC client

Returns:

  • (String) 


18
19
20
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 18

def client_secret
  @client_secret
end

#directory_id ⇒ String

Directory ID for Microsoft OIDC client and Okta domain for OKTA OIDC

Returns:

  • (String) 


22
23
24
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 22

def directory_id
  @directory_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 50

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client_id = hash.key?('client_id') ? hash['client_id'] : nil
  client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
  directory_id = hash.key?('directory_id') ? hash['directory_id'] : nil

  # Create object from extracted values.
  CreateOidcIdentityProviderConfig.new(client_id,
                                       client_secret,
                                       directory_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['client_secret'] = 'client_secret'
  @_hash['directory_id'] = 'directory_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 34

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 66

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.client_id,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.client_secret,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.directory_id,
                              ->(val) { val.instance_of? String })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['client_id'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['client_secret'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['directory_id'],
                            ->(val) { val.instance_of? String })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
102
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 98

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, client_secret: #{@client_secret.inspect},"\
  " directory_id: #{@directory_id.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



91
92
93
94
95
 
# File 'lib/new_store_api/models/create_oidc_identity_provider_config.rb', line 91

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, client_secret: #{@client_secret}, directory_id:"\
  " #{@directory_id}>"
end