Class: AlisSdkRuby::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/alis-sdk-ruby/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

    a customizable set of options



100
101
102
# File 'lib/alis-sdk-ruby/client.rb', line 100

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

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.



856
857
858
# File 'lib/alis-sdk-ruby/client.rb', line 856

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

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.



859
860
861
# File 'lib/alis-sdk-ruby/client.rb', line 859

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

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.

Parameters:

  • params ({}) (defaults to: {})


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
# File 'lib/alis-sdk-ruby/client.rb', line 826

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  authorizer = nil
  if config.api.operation(operation_name).authorizer
    authorizer_name = config.api.operation(operation_name).authorizer
    config.api.authorizers.each do |_, auth|
      authorizer = auth if auth.name == authorizer_name
    end
  end
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    authorizer: authorizer,
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'alis-sdk-ruby'
  context[:gem_version] = '0.13.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_articles_article_id(params = {}) ⇒ Types::GetArticlesArticle_idResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_articles_article_id({
  article_id: "__string", # required
})

Response structure


resp.article_content.article_id #=> String
resp.article_content.body #=> String
resp.article_content.created_at #=> Integer
resp.article_content.eye_catch_url #=> String
resp.article_content.overview #=> String
resp.article_content.title #=> String
resp.article_content.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



130
131
132
133
# File 'lib/alis-sdk-ruby/client.rb', line 130

def get_articles_article_id(params = {}, options = {})
  req = build_request(:get_articles_article_id, params)
  req.send_request(options)
end

#get_articles_article_id_alistoken(params = {}) ⇒ Types::GetArticlesArticle_idAlistokenResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_articles_article_id_alistoken({
  article_id: "__string", # required
})

Response structure


resp.model69304a.alistoken #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



153
154
155
156
# File 'lib/alis-sdk-ruby/client.rb', line 153

def get_articles_article_id_alistoken(params = {}, options = {})
  req = build_request(:get_articles_article_id_alistoken, params)
  req.send_request(options)
end

#get_articles_article_id_likes(params = {}) ⇒ Types::GetArticlesArticle_idLikesResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_articles_article_id_likes({
  article_id: "__string", # required
})

Response structure


resp.mode_ld_25993.count #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



176
177
178
179
# File 'lib/alis-sdk-ruby/client.rb', line 176

def get_articles_article_id_likes(params = {}, options = {})
  req = build_request(:get_articles_article_id_likes, params)
  req.send_request(options)
end

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_articles_popular({
  article_id: "__string",
  limit: "__string",
  score: "__string",
})

Response structure


resp. #=> Array
resp.[0].article_id #=> String
resp.[0].created_at #=> Integer
resp.[0].eye_catch_url #=> String
resp.[0].overview #=> String
resp.[0].title #=> String
resp.[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (String)
  • :limit (String)
  • :score (String)

Returns:



211
212
213
214
# File 'lib/alis-sdk-ruby/client.rb', line 211

def get_articles_popular(params = {}, options = {})
  req = build_request(:get_articles_popular, params)
  req.send_request(options)
end

#get_articles_recent(params = {}) ⇒ Types::GetArticlesRecentResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_articles_recent({
  article_id: "__string",
  limit: "__string",
  sort_key: "__string",
})

Response structure


resp. #=> Array
resp.[0].article_id #=> String
resp.[0].created_at #=> Integer
resp.[0].eye_catch_url #=> String
resp.[0].overview #=> String
resp.[0].title #=> String
resp.[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (String)
  • :limit (String)
  • :sort_key (String)

Returns:



246
247
248
249
# File 'lib/alis-sdk-ruby/client.rb', line 246

def get_articles_recent(params = {}, options = {})
  req = build_request(:get_articles_recent, params)
  req.send_request(options)
end

#get_me_articles_article_id_drafts(params = {}) ⇒ Types::GetMeArticlesArticle_idDraftsResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_article_id_drafts({
  article_id: "__string", # required
})

Response structure


resp.article_content.article_id #=> String
resp.article_content.body #=> String
resp.article_content.created_at #=> Integer
resp.article_content.eye_catch_url #=> String
resp.article_content.overview #=> String
resp.article_content.title #=> String
resp.article_content.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



275
276
277
278
# File 'lib/alis-sdk-ruby/client.rb', line 275

def get_me_articles_article_id_drafts(params = {}, options = {})
  req = build_request(:get_me_articles_article_id_drafts, params)
  req.send_request(options)
end

#get_me_articles_article_id_like(params = {}) ⇒ Types::GetMeArticlesArticle_idLikeResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_article_id_like({
  article_id: "__string", # required
})

Response structure


resp.model84cbde.liked #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



298
299
300
301
# File 'lib/alis-sdk-ruby/client.rb', line 298

def get_me_articles_article_id_like(params = {}, options = {})
  req = build_request(:get_me_articles_article_id_like, params)
  req.send_request(options)
end

#get_me_articles_article_id_public(params = {}) ⇒ Types::GetMeArticlesArticle_idPublicResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_article_id_public({
  article_id: "__string", # required
})

Response structure


resp.article_content.article_id #=> String
resp.article_content.body #=> String
resp.article_content.created_at #=> Integer
resp.article_content.eye_catch_url #=> String
resp.article_content.overview #=> String
resp.article_content.title #=> String
resp.article_content.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



327
328
329
330
# File 'lib/alis-sdk-ruby/client.rb', line 327

def get_me_articles_article_id_public(params = {}, options = {})
  req = build_request(:get_me_articles_article_id_public, params)
  req.send_request(options)
end

#get_me_articles_article_id_public_edit(params = {}) ⇒ Types::GetMeArticlesArticle_idPublicEditResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_article_id_public_edit({
  article_id: "__string", # required
})

Response structure


resp.article_content.article_id #=> String
resp.article_content.body #=> String
resp.article_content.created_at #=> Integer
resp.article_content.eye_catch_url #=> String
resp.article_content.overview #=> String
resp.article_content.title #=> String
resp.article_content.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:



356
357
358
359
# File 'lib/alis-sdk-ruby/client.rb', line 356

def get_me_articles_article_id_public_edit(params = {}, options = {})
  req = build_request(:get_me_articles_article_id_public_edit, params)
  req.send_request(options)
end

#get_me_articles_drafts(params = {}) ⇒ Types::GetMeArticlesDraftsResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_drafts({
  article_id: "__string",
  limit: "__string",
  sort_key: "__string",
})

Response structure


resp. #=> Array
resp.[0].article_id #=> String
resp.[0].created_at #=> Integer
resp.[0].eye_catch_url #=> String
resp.[0].overview #=> String
resp.[0].title #=> String
resp.[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (String)
  • :limit (String)
  • :sort_key (String)

Returns:



391
392
393
394
# File 'lib/alis-sdk-ruby/client.rb', line 391

def get_me_articles_drafts(params = {}, options = {})
  req = build_request(:get_me_articles_drafts, params)
  req.send_request(options)
end

#get_me_articles_public(params = {}) ⇒ Types::GetMeArticlesPublicResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_me_articles_public({
  article_id: "__string",
  limit: "__string",
  sort_key: "__string",
})

Response structure


resp. #=> Array
resp.[0].article_id #=> String
resp.[0].created_at #=> Integer
resp.[0].eye_catch_url #=> String
resp.[0].overview #=> String
resp.[0].title #=> String
resp.[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (String)
  • :limit (String)
  • :sort_key (String)

Returns:



426
427
428
429
# File 'lib/alis-sdk-ruby/client.rb', line 426

def get_me_articles_public(params = {}, options = {})
  req = build_request(:get_me_articles_public, params)
  req.send_request(options)
end

#get_me_info(params = {}) ⇒ Types::GetMeInfoResponse

Returns a response object which responds to the following methods:

Examples:

Response structure


resp..icon_image_url #=> String
resp..self_introduction #=> String
resp..user_display_name #=> String
resp..user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:



444
445
446
447
# File 'lib/alis-sdk-ruby/client.rb', line 444

def get_me_info(params = {}, options = {})
  req = build_request(:get_me_info, params)
  req.send_request(options)
end

#get_me_notifications(params = {}) ⇒ Types::GetMeNotificationsResponse

Returns a response object which responds to the following methods:

Examples:

Response structure


resp.array_of_notification #=> Array
resp.array_of_notification[0].acted_user_id #=> String
resp.array_of_notification[0].created_at #=> Integer
resp.array_of_notification[0].sort_key #=> Integer
resp.array_of_notification[0].type #=> String
resp.array_of_notification[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:



464
465
466
467
# File 'lib/alis-sdk-ruby/client.rb', line 464

def get_me_notifications(params = {}, options = {})
  req = build_request(:get_me_notifications, params)
  req.send_request(options)
end

#get_me_unread_notification_managers(params = {}) ⇒ Types::GetMeUnread_notification_managersResponse

Returns a response object which responds to the following methods:

Examples:

Response structure


resp.mode_lc_40ebe.unread #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:



479
480
481
482
# File 'lib/alis-sdk-ruby/client.rb', line 479

def get_me_unread_notification_managers(params = {}, options = {})
  req = build_request(:get_me_unread_notification_managers, params)
  req.send_request(options)
end

#get_me_wallet_balance(params = {}) ⇒ Types::GetMeWalletBalanceResponse

Returns a response object which responds to the following methods:

Examples:

Response structure


resp.me_wallet_balance.private_eth_address #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:



494
495
496
497
# File 'lib/alis-sdk-ruby/client.rb', line 494

def get_me_wallet_balance(params = {}, options = {})
  req = build_request(:get_me_wallet_balance, params)
  req.send_request(options)
end

#get_users_user_id_articles_public(params = {}) ⇒ Types::GetUsersUser_idArticlesPublicResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_users_user_id_articles_public({
  article_id: "__string",
  limit: "__string",
  sort_key: "__string",
  user_id: "__string", # required
})

Response structure


resp. #=> Array
resp.[0].article_id #=> String
resp.[0].created_at #=> Integer
resp.[0].eye_catch_url #=> String
resp.[0].overview #=> String
resp.[0].title #=> String
resp.[0].user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (String)
  • :limit (String)
  • :sort_key (String)
  • :user_id (required, String)

Returns:



532
533
534
535
# File 'lib/alis-sdk-ruby/client.rb', line 532

def get_users_user_id_articles_public(params = {}, options = {})
  req = build_request(:get_users_user_id_articles_public, params)
  req.send_request(options)
end

#get_users_user_id_info(params = {}) ⇒ Types::GetUsersUser_idInfoResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_users_user_id_info({
  user_id: "__string", # required
})

Response structure


resp..icon_image_url #=> String
resp..self_introduction #=> String
resp..user_display_name #=> String
resp..user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_id (required, String)

Returns:



558
559
560
561
# File 'lib/alis-sdk-ruby/client.rb', line 558

def get_users_user_id_info(params = {}, options = {})
  req = build_request(:get_users_user_id_info, params)
  req.send_request(options)
end

#post_me_articles_article_id_fraud(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.post_me_articles_article_id_fraud({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



575
576
577
578
# File 'lib/alis-sdk-ruby/client.rb', line 575

def post_me_articles_article_id_fraud(params = {}, options = {})
  req = build_request(:post_me_articles_article_id_fraud, params)
  req.send_request(options)
end

#post_me_articles_article_id_images(params = {}) ⇒ Types::PostMeArticlesArticle_idImagesResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.post_me_articles_article_id_images({
  article_id: "__string", # required
  article_image: { # required
    article_image: "__string",
  },
})

Response structure


resp.mode_ld_06bfe.image_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:



603
604
605
606
# File 'lib/alis-sdk-ruby/client.rb', line 603

def post_me_articles_article_id_images(params = {}, options = {})
  req = build_request(:post_me_articles_article_id_images, params)
  req.send_request(options)
end

#post_me_articles_article_id_like(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.post_me_articles_article_id_like({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



620
621
622
623
# File 'lib/alis-sdk-ruby/client.rb', line 620

def post_me_articles_article_id_like(params = {}, options = {})
  req = build_request(:post_me_articles_article_id_like, params)
  req.send_request(options)
end

#post_me_articles_article_id_pv(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.post_me_articles_article_id_pv({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



637
638
639
640
# File 'lib/alis-sdk-ruby/client.rb', line 637

def post_me_articles_article_id_pv(params = {}, options = {})
  req = build_request(:post_me_articles_article_id_pv, params)
  req.send_request(options)
end

#post_me_articles_drafts(params = {}) ⇒ Types::PostMeArticlesDraftsResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.post_me_articles_drafts({
  me_articles_drafts_create: { # required
    body: "__string",
    eye_catch_url: "__string",
    overview: "__string",
    title: "__string",
  },
})

Response structure


resp.mode_lcde_73d.article_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:



665
666
667
668
# File 'lib/alis-sdk-ruby/client.rb', line 665

def post_me_articles_drafts(params = {}, options = {})
  req = build_request(:post_me_articles_drafts, params)
  req.send_request(options)
end

#post_me_info_icon(params = {}) ⇒ Types::PostMeInfoIconResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.post_me_info_icon({
  me_info_icon: { # required
    icon_image: "__string",
  },
})

Response structure


resp.mode_la_08eaf.image_url #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:



690
691
692
693
# File 'lib/alis-sdk-ruby/client.rb', line 690

def post_me_info_icon(params = {}, options = {})
  req = build_request(:post_me_info_icon, params)
  req.send_request(options)
end

#put_me_articles_article_id_drafts(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_articles_article_id_drafts({
  me_articles_drafts_create: { # required
    body: "__string",
    eye_catch_url: "__string",
    overview: "__string",
    title: "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.



712
713
714
715
# File 'lib/alis-sdk-ruby/client.rb', line 712

def put_me_articles_article_id_drafts(params = {}, options = {})
  req = build_request(:put_me_articles_article_id_drafts, params)
  req.send_request(options)
end

#put_me_articles_article_id_drafts_publish(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_articles_article_id_drafts_publish({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



729
730
731
732
# File 'lib/alis-sdk-ruby/client.rb', line 729

def put_me_articles_article_id_drafts_publish(params = {}, options = {})
  req = build_request(:put_me_articles_article_id_drafts_publish, params)
  req.send_request(options)
end

#put_me_articles_article_id_public(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_articles_article_id_public({
  article_id: "__string", # required
  update_article: { # required
    body: "__string",
    eye_catch_url: "__string",
    overview: "__string",
    title: "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.



754
755
756
757
# File 'lib/alis-sdk-ruby/client.rb', line 754

def put_me_articles_article_id_public(params = {}, options = {})
  req = build_request(:put_me_articles_article_id_public, params)
  req.send_request(options)
end

#put_me_articles_article_id_public_republish(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_articles_article_id_public_republish({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



771
772
773
774
# File 'lib/alis-sdk-ruby/client.rb', line 771

def put_me_articles_article_id_public_republish(params = {}, options = {})
  req = build_request(:put_me_articles_article_id_public_republish, params)
  req.send_request(options)
end

#put_me_articles_article_id_public_unpublish(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_articles_article_id_public_unpublish({
  article_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :article_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.



788
789
790
791
# File 'lib/alis-sdk-ruby/client.rb', line 788

def put_me_articles_article_id_public_unpublish(params = {}, options = {})
  req = build_request(:put_me_articles_article_id_public_unpublish, params)
  req.send_request(options)
end

#put_me_info(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_me_info({
  me_info_update: { # required
    self_introduction: "__string",
    user_display_name: "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.



808
809
810
811
# File 'lib/alis-sdk-ruby/client.rb', line 808

def put_me_info(params = {}, options = {})
  req = build_request(:put_me_info, params)
  req.send_request(options)
end

#put_me_unread_notification_managers(params = {}) ⇒ Struct

Returns an empty response.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.



817
818
819
820
# File 'lib/alis-sdk-ruby/client.rb', line 817

def put_me_unread_notification_managers(params = {}, options = {})
  req = build_request(:put_me_unread_notification_managers, params)
  req.send_request(options)
end

#waiter_namesObject

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.

Deprecated.


849
850
851
# File 'lib/alis-sdk-ruby/client.rb', line 849

def waiter_names
  []
end